faker.providers.date_time

class faker.providers.date_time.Provider(generator: Any)

Bases: BaseProvider

Most methods of the provider accept a ‘start_datetime’ and/or ‘end_datetime’ parameter.

These parameters accept a variety of types, and are used to define the range of the random date/time.

We call this type DateParseType.

A DateParseType can be:

  • a datetime or date object

  • an integer or a float, representing UNIX a timestamp

  • the special string ‘now’

  • the special string ‘today’

  • a timedelta object, representing a time delta from now

  • a ‘timedelta string’, such as ‘+2d’, ‘-3w’, ‘+4y’, etc. Representing a time delta from now.

am_pm() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.am_pm()
...
'AM'
'PM'
'AM'
'AM'
'PM'
century() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.century()
...
'XIII'
'XIV'
'II'
'IX'
'XVII'
date(pattern: str = '%Y-%m-%d', end_datetime: date | datetime | timedelta | str | int | None = None) str

Get a date string between January 1, 1970 and now.

Parameters:
  • pattern – Format of the date (year-month-day by default)

  • end_datetime – A DateParseType. Defaults to the current date and time

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date()
...
'2017-10-29'
'2012-12-05'
'1993-10-27'
'1984-08-31'
'1998-12-16'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'10/29/2017'
'12/05/2012'
'10/27/1993'
'08/31/1984'
'12/16/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-11-04'
'2012-12-10'
'1993-10-30'
'1984-09-01'
'1998-12-20'
date_between(start_date: date | datetime | timedelta | str | int = '-30y', end_date: date | datetime | timedelta | str | int = 'today') date

Get a Date object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().

Parameters:
  • start_date – A DateParseType. Defaults to 30 years ago

  • end_date – A DateParseType. Defaults to "today"

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between()
...
datetime.date(2021, 12, 20)
datetime.date(2019, 5, 17)
datetime.date(2009, 4, 2)
datetime.date(2004, 5, 27)
datetime.date(2011, 12, 22)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 8, 19)
datetime.date(2026, 8, 19)
datetime.date(2026, 8, 16)
datetime.date(2026, 8, 15)
datetime.date(2026, 8, 17)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 6, 30)
datetime.date(2026, 5, 29)
datetime.date(2026, 1, 23)
datetime.date(2025, 11, 24)
datetime.date(2026, 2, 26)
date_between_dates(date_start: date | datetime | timedelta | str | int | None = None, date_end: date | datetime | timedelta | str | int | None = None) date

Get a random date between the two given dates.

Parameters:
  • date_start – A DateParseType. Defaults to the UNIX epoch

  • date_end – A DateParseType. Defaults to the current date and time

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between_dates()
...
datetime.date(2026, 8, 21)
datetime.date(2026, 8, 21)
datetime.date(2026, 8, 21)
datetime.date(2026, 8, 21)
datetime.date(2026, 8, 21)
date_object(end_datetime: datetime | None = None) date

Get a date object between January 1, 1970 and now

Parameters:

end_datetime – A DateParseType. Defaults to the current date and time

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object()
...
datetime.date(2017, 10, 29)
datetime.date(2012, 12, 5)
datetime.date(1993, 10, 27)
datetime.date(1984, 8, 31)
datetime.date(1998, 12, 16)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 11, 4)
datetime.date(2012, 12, 10)
datetime.date(1993, 10, 30)
datetime.date(1984, 9, 1)
datetime.date(1998, 12, 20)
date_of_birth(tzinfo: tzinfo | None = None, minimum_age: int = 0, maximum_age: int = 115) date

Generate a random date of birth represented as a Date object, constrained by optional miminimum_age and maximum_age parameters.

Parameters:
  • tzinfo – Defaults to None.

  • minimum_age – Defaults to 0.

  • maximum_age – Defaults to 115.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth()
...
datetime.date(2008, 8, 3)
datetime.date(1998, 7, 23)
datetime.date(1959, 6, 4)
datetime.date(1940, 9, 2)
datetime.date(1969, 12, 11)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 5, 15)
datetime.date(1991, 7, 22)
datetime.date(1984, 6, 20)
datetime.date(1981, 1, 27)
datetime.date(1986, 5, 16)
date_this_century(before_today: bool = True, after_today: bool = False) date

Gets a Date object for the current century.

Parameters:
  • before_today – include days in current century before today. Defaults to True

  • after_today – include days in current century after today. Defaults to False

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century()
...
datetime.date(2022, 6, 29)
datetime.date(2020, 3, 10)
datetime.date(2011, 3, 15)
datetime.date(2006, 11, 24)
datetime.date(2013, 8, 14)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 8, 2)
datetime.date(2082, 3, 30)
datetime.date(2057, 6, 28)
datetime.date(2045, 8, 18)
datetime.date(2064, 2, 23)
date_this_decade(before_today: bool = True, after_today: bool = False) date

Gets a Date object for the decade year.

Parameters:
  • before_today – include days in current decade before today. Defaults to True

  • after_today – include days in current decade after today. Defaults to False

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade()
...
datetime.date(2025, 8, 8)
datetime.date(2025, 1, 11)
datetime.date(2022, 10, 16)
datetime.date(2021, 9, 19)
datetime.date(2023, 5, 24)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 6, 23)
datetime.date(2029, 3, 9)
datetime.date(2028, 1, 19)
datetime.date(2027, 7, 5)
datetime.date(2028, 5, 10)
date_this_month(before_today: bool = True, after_today: bool = False) date

Gets a Date object for the current month.

Parameters:
  • before_today – include days in current month before today. Defaults to True

  • after_today – include days in current month after today. Defaults to False

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month()
...
datetime.date(2026, 8, 17)
datetime.date(2026, 8, 16)
datetime.date(2026, 8, 9)
datetime.date(2026, 8, 6)
datetime.date(2026, 8, 11)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 8, 30)
datetime.date(2026, 8, 29)
datetime.date(2026, 8, 25)
datetime.date(2026, 8, 23)
datetime.date(2026, 8, 26)
date_this_year(before_today: bool = True, after_today: bool = False) date

Gets a Date object for the current year.

Parameters:
  • before_today – include days in current year before today. Defaults to True

  • after_today – include days in current year after today. Defaults to False

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year()
...
datetime.date(2026, 7, 15)
datetime.date(2026, 6, 25)
datetime.date(2026, 4, 8)
datetime.date(2026, 3, 2)
datetime.date(2026, 4, 29)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 12, 11)
datetime.date(2026, 11, 29)
datetime.date(2026, 10, 15)
datetime.date(2026, 9, 24)
datetime.date(2026, 10, 27)
date_time(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None) datetime

Get a datetime object for a date between January 1, 1970 and a specified end_datetime

Parameters:
  • tzinfo – timezone, instance of datetime.tzinfo subclass

  • end_datetime – A DateParseType. Defaults to the current date and time

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time()
...
datetime.datetime(2017, 10, 29, 7, 12, 24, 580340)
datetime.datetime(2012, 12, 5, 13, 46, 54, 504911)
datetime.datetime(1993, 10, 27, 5, 42, 0, 677366)
datetime.datetime(1984, 8, 31, 3, 11, 10, 524352)
datetime.datetime(1998, 12, 16, 14, 3, 53, 244895)
date_time_ad(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None, start_datetime: date | datetime | timedelta | str | int | None = None) datetime

Get a datetime object for a date between January 1, 0001 and now

Parameters:
  • tzinfo – timezone, instance of datetime.tzinfo subclass

  • end_datetime – A DateParseType. Defaults to the current date and time

  • start_datetime – A DateParseType. Defaults to UNIX timestamp -62135596800,

equivalent to 0001-01-01 00:00:00 UTC

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_ad()
...
datetime.datetime(1711, 6, 30, 9, 47, 20, 50194)
datetime.datetime(1536, 5, 5, 13, 53, 8, 388283)
datetime.datetime(852, 12, 4, 8, 4, 52, 721359)
datetime.datetime(525, 6, 22, 5, 17, 51, 494202)
datetime.datetime(1036, 8, 28, 22, 29, 34, 237099)
date_time_between(start_date: date | datetime | timedelta | str | int = '-30y', end_date: date | datetime | timedelta | str | int = 'now', tzinfo: tzinfo | None = None) datetime

Get a datetime object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().

Parameters:
  • start_date – A DateParseType. Defaults to 30 years ago

  • end_date – A DateParseType. Defaults to "now"

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between()
...
datetime.datetime(2021, 12, 20, 23, 56, 37, 236214)
datetime.datetime(2019, 5, 18, 13, 21, 23, 808743)
datetime.datetime(2009, 4, 3, 18, 51, 4, 361449)
datetime.datetime(2004, 5, 28, 12, 1, 40, 49189)
datetime.datetime(2011, 12, 23, 15, 18, 36, 171082)
date_time_between_dates(datetime_start: date | datetime | timedelta | str | int | None = None, datetime_end: date | datetime | timedelta | str | int | None = None, tzinfo: tzinfo | None = None) datetime

Get a random datetime between the two given datetimes.

Parameters:
  • datetime_start – A DateParseType. Defaults to the UNIX epoch

  • datetime_end – A DateParseType. Defaults to the current date and time

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates()
...
datetime.datetime(2026, 8, 21, 16, 45, 54)
datetime.datetime(2026, 8, 21, 16, 45, 54)
datetime.datetime(2026, 8, 21, 16, 45, 54)
datetime.datetime(2026, 8, 21, 16, 45, 54)
datetime.datetime(2026, 8, 21, 16, 45, 54)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2021, 12, 20, 23, 56, 37, 236214)
datetime.datetime(2019, 5, 18, 13, 21, 23, 808743)
datetime.datetime(2009, 4, 3, 18, 51, 4, 361449)
datetime.datetime(2004, 5, 28, 12, 1, 40, 49189)
datetime.datetime(2011, 12, 23, 15, 18, 36, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 6, 26, 2, 45, 51, 441207)
datetime.datetime(2027, 5, 25, 12, 48, 40, 993625)
datetime.datetime(2027, 1, 22, 7, 23, 40, 345382)
datetime.datetime(2026, 11, 24, 6, 22, 1, 534973)
datetime.datetime(2027, 2, 24, 10, 28, 35, 405703)
date_time_this_century(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) datetime

Gets a datetime object for the current century.

Parameters:
  • before_now – include days in current century before today. Defaults to True

  • after_now – include days in current century after today. Defaults to False

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century()
...
datetime.datetime(2022, 6, 29, 23, 16, 52, 953721)
datetime.datetime(2020, 3, 10, 16, 1, 42, 148251)
datetime.datetime(2011, 3, 16, 0, 49, 57, 792834)
datetime.datetime(2006, 11, 24, 4, 21, 58, 556608)
datetime.datetime(2013, 8, 14, 13, 10, 25, 900998)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 8, 2, 5, 40, 43, 214965)
datetime.datetime(2082, 3, 30, 7, 33, 58, 474638)
datetime.datetime(2057, 6, 29, 0, 58, 48, 129913)
datetime.datetime(2045, 8, 19, 10, 49, 19, 347914)
datetime.datetime(2064, 2, 23, 11, 0, 42, 805202)
date_time_this_decade(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) datetime

Gets a datetime object for the decade year.

Parameters:
  • before_now – include days in current decade before today. Defaults to True

  • after_now – include days in current decade after today. Defaults to False

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade()
...
datetime.datetime(2025, 8, 9, 11, 14, 32, 519983)
datetime.datetime(2025, 1, 11, 19, 27, 44, 823673)
datetime.datetime(2022, 10, 16, 18, 13, 23, 408284)
datetime.datetime(2021, 9, 19, 19, 4, 53, 775703)
datetime.datetime(2023, 5, 24, 16, 29, 22, 959758)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 6, 23, 21, 40, 30, 720871)
datetime.datetime(2029, 3, 9, 16, 40, 51, 468823)
datetime.datetime(2028, 1, 20, 6, 53, 36, 476282)
datetime.datetime(2027, 7, 5, 17, 25, 57, 818361)
datetime.datetime(2028, 5, 10, 16, 45, 9, 578825)
date_time_this_month(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) datetime

Gets a datetime object for the current month.

Parameters:
  • before_now – include days in current month before today. Defaults to True

  • after_now – include days in current month after today. Defaults to False

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month()
...
datetime.datetime(2026, 8, 18, 11, 28, 45, 195862)
datetime.datetime(2026, 8, 16, 16, 31, 30, 788316)
datetime.datetime(2026, 8, 9, 16, 55, 30, 868865)
datetime.datetime(2026, 8, 6, 8, 37, 14, 806053)
datetime.datetime(2026, 8, 11, 13, 59, 0, 193058)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 8, 30, 9, 32, 8, 291262)
datetime.datetime(2026, 8, 29, 12, 9, 28, 284519)
datetime.datetime(2026, 8, 26, 0, 44, 42, 53232)
datetime.datetime(2026, 8, 24, 8, 46, 41, 817931)
datetime.datetime(2026, 8, 26, 23, 10, 12, 20655)
date_time_this_year(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) datetime

Gets a datetime object for the current year.

Parameters:
  • before_now – include days in current year before today. Defaults to True

  • after_now – include days in current year after today. Defaults to False

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year()
...
datetime.datetime(2026, 7, 16, 11, 53, 51, 365876)
datetime.datetime(2026, 6, 26, 8, 59, 49, 996093)
datetime.datetime(2026, 4, 8, 20, 47, 36, 400628)
datetime.datetime(2026, 3, 2, 5, 59, 21, 137820)
datetime.datetime(2026, 4, 29, 23, 20, 57, 9423)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 12, 11, 10, 0, 10, 143818)
datetime.datetime(2026, 11, 29, 23, 26, 54, 55032)
datetime.datetime(2026, 10, 16, 8, 10, 42, 972454)
datetime.datetime(2026, 9, 24, 22, 53, 11, 499419)
datetime.datetime(2026, 10, 28, 8, 10, 56, 603657)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'29'
'05'
'27'
'31'
'16'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Sunday'
'Wednesday'
'Wednesday'
'Friday'
'Wednesday'
future_date(end_date: date | datetime | timedelta | str | int = '+30d') date

Get a Date object based on a random date between 1 day from now and a given date.

Parameters:
  • end_date – A DateParseType. Defaults to "+30d"

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date()
...
datetime.date(2026, 9, 15)
datetime.date(2026, 9, 12)
datetime.date(2026, 9, 3)
datetime.date(2026, 8, 29)
datetime.date(2026, 9, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 6, 25)
datetime.date(2027, 5, 24)
datetime.date(2027, 1, 22)
datetime.date(2026, 11, 24)
datetime.date(2027, 2, 24)
future_datetime(end_date: date | datetime | timedelta | str | int = '+30d', tzinfo: tzinfo | None = None) datetime

Get a datetime object based on a random date between 1 second form now and a given date.

Parameters:
  • end_date – A DateParseType. Defaults to "+30d"

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime()
...
datetime.datetime(2026, 9, 16, 0, 44, 55, 594731)
datetime.datetime(2026, 9, 13, 10, 29, 32, 54467)
datetime.datetime(2026, 9, 3, 7, 34, 36, 116942)
datetime.datetime(2026, 8, 29, 11, 11, 6, 957843)
datetime.datetime(2026, 9, 6, 0, 52, 58, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 6, 26, 2, 45, 51, 596785)
datetime.datetime(2027, 5, 25, 12, 48, 41, 235670)
datetime.datetime(2027, 1, 22, 7, 23, 40, 924810)
datetime.datetime(2026, 11, 24, 6, 22, 2, 276056)
datetime.datetime(2027, 2, 24, 10, 28, 35, 894428)
iso8601(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None, sep: str = 'T', timespec: str = 'auto') str

Get an ISO 8601 string for a datetime between the UNIX epoch and now.

Parameters:
  • tzinfo – timezone, instance of datetime.tzinfo subclass

  • end_datetime – A DateParseType. Defaults to the current date and time

  • sep – separator between date and time, defaults to ‘T’

  • timespec – format specifier for the time part, defaults to ‘auto’ - see datetime.isoformat() documentation

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.iso8601()
...
'2017-10-29T07:12:24.580340'
'2012-12-05T13:46:54.504911'
'1993-10-27T05:42:00.677366'
'1984-08-31T03:11:10.524352'
'1998-12-16T14:03:53.244895'
month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month()
...
'10'
'12'
'10'
'08'
'12'
month_name() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'October'
'December'
'October'
'August'
'December'
past_date(start_date: date | datetime | timedelta | str | int = '-30d', tzinfo: tzinfo | None = None) date

Get a Date object based on a random date between a given date and 1 day ago.

Parameters:
  • start_date – A DateParseType. Defaults to "-30d"

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date()
...
datetime.date(2026, 8, 15)
datetime.date(2026, 8, 12)
datetime.date(2026, 8, 3)
datetime.date(2026, 7, 29)
datetime.date(2026, 8, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 6, 24)
datetime.date(2026, 5, 23)
datetime.date(2026, 1, 20)
datetime.date(2025, 11, 22)
datetime.date(2026, 2, 22)
past_datetime(start_date: date | datetime | timedelta | str | int = '-30d', tzinfo: tzinfo | None = None) datetime

Get a datetime object based on a random date between a given date and 1 second ago.

Parameters:
  • start_date – A DateParseType. Defaults to "-30d"

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Example:

datetime(‘1999-02-02 11:42:52’)

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_datetime()
...
datetime.datetime(2026, 8, 17, 0, 44, 54, 594731)
datetime.datetime(2026, 8, 14, 10, 29, 31, 54467)
datetime.datetime(2026, 8, 4, 7, 34, 35, 116942)
datetime.datetime(2026, 7, 30, 11, 11, 5, 957843)
datetime.datetime(2026, 8, 7, 0, 52, 57, 566513)
pytimezone(*args: Any, **kwargs: Any) tzinfo | None

Generate a random timezone (see faker.timezone for any args) and return a Python object usable as a tzinfo for datetime or other fakers.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.pytimezone()
...
zoneinfo.ZoneInfo(key='Indian/Maldives')
zoneinfo.ZoneInfo(key='America/Barbados')
zoneinfo.ZoneInfo(key='Europe/Stockholm')
zoneinfo.ZoneInfo(key='Africa/Windhoek')
zoneinfo.ZoneInfo(key='Asia/Qatar')
time(pattern: str = '%H:%M:%S', end_datetime: date | datetime | timedelta | str | int | None = None) str

Get a time string (24h format by default)

Parameters:
  • pattern – format

  • end_datetime – A DateParseType. Defaults to the current date and time

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time()
...
'07:12:24'
'13:46:54'
'05:42:00'
'03:11:10'
'14:03:53'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'07:12 AM'
'01:46 PM'
'05:42 AM'
'03:11 AM'
'02:03 PM'
time_delta(end_datetime: date | datetime | timedelta | str | int | None = None) timedelta

Get a random timedelta object of duration between the current date and time and end_datetime

Parameters:

end_datetime – A DateParseType. Defaults to the current date and time

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_delta()
...
datetime.timedelta(0)
datetime.timedelta(0)
datetime.timedelta(0)
datetime.timedelta(0)
datetime.timedelta(0)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_delta(end_datetime='+30h')
...
datetime.timedelta(days=1, seconds=4797, microseconds=559965)
datetime.timedelta(seconds=81859, microseconds=75518)
datetime.timedelta(seconds=45421, microseconds=730730)
datetime.timedelta(seconds=27963, microseconds=9032)
datetime.timedelta(seconds=55217, microseconds=669908)
time_object(end_datetime: date | datetime | timedelta | str | int | None = None) time

Get a time object

Parameters:

end_datetime – A DateParseType. Defaults to the current date and time

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object()
...
datetime.time(7, 12, 24, 580340)
datetime.time(13, 46, 54, 504911)
datetime.time(5, 42, 0, 677366)
datetime.time(3, 11, 10, 524352)
datetime.time(14, 3, 53, 244895)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(8, 3, 4, 499006)
datetime.time(14, 32, 23, 140761)
datetime.time(6, 7, 14, 735057)
datetime.time(3, 26, 42, 624653)
datetime.time(14, 34, 33, 833892)
time_series(start_date: date | datetime | timedelta | str | int = '-30d', end_date: date | datetime | timedelta | str | int = 'now', precision: float | None = None, distrib: Callable[[datetime], float] | None = None, tzinfo: tzinfo | None = None) Iterator[Tuple[datetime, Any]]

Returns a generator yielding tuples of (<datetime>, <value>).

The data points will start at start_date, and be at every time interval specified by precision.

Parameters:
  • start_date – A DateParseType. Defaults to "-30d"

  • end_date – A DateParseType. Defaults to "now"

  • precision – A float representing the time interval between data points.

Defaults to 1/30th of the time :param distrib: A callable that accepts a datetime object and returns a value. Defaults to a uniform distribution :param tzinfo: timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_series()
...
<generator object Provider.time_series at 0x728b24d46e30>
<generator object Provider.time_series at 0x728b24d46e30>
<generator object Provider.time_series at 0x728b24d46e30>
<generator object Provider.time_series at 0x728b24d46e30>
<generator object Provider.time_series at 0x728b24d46e30>
timezone() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.timezone()
...
'Indian/Maldives'
'America/Barbados'
'Europe/Stockholm'
'Africa/Windhoek'
'Asia/Qatar'
unix_time(end_datetime: date | datetime | timedelta | str | int | None = None, start_datetime: date | datetime | timedelta | str | int | None = None) float

Get a timestamp between January 1, 1970 and now, unless passed explicit start_datetime or end_datetime values.

On Windows, the decimal part is always 0.

Parameters:
  • end_datetime – A DateParseType. Defaults to the UNIX epoch

  • start_datetime – A DateParseType. Defaults to the current date and time

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.unix_time()
...
1509261144.5803404
1354715214.5049107
751700520.6773661
462769870.5243519
913817033.244895
year() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.year()
...
'2017'
'2012'
'1993'
'1984'
'1998'