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()
...
'PM'
'PM'
'PM'
'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-08-22'
'2012-10-05'
'1993-09-23'
'1984-08-10'
'1998-11-05'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'08/22/2017'
'10/05/2012'
'09/23/1993'
'08/10/1984'
'11/05/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-08-28'
'2012-10-11'
'1993-09-26'
'1984-08-12'
'1998-11-09'
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, 10, 1)
datetime.date(2019, 2, 26)
datetime.date(2009, 1, 12)
datetime.date(2004, 3, 8)
datetime.date(2011, 10, 3)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 5, 31)
datetime.date(2026, 5, 31)
datetime.date(2026, 5, 28)
datetime.date(2026, 5, 27)
datetime.date(2026, 5, 29)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 4, 11)
datetime.date(2026, 3, 10)
datetime.date(2025, 11, 4)
datetime.date(2025, 9, 5)
datetime.date(2025, 12, 8)
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, 6, 2)
datetime.date(2026, 6, 2)
datetime.date(2026, 6, 2)
datetime.date(2026, 6, 2)
datetime.date(2026, 6, 2)
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, 8, 22)
datetime.date(2012, 10, 5)
datetime.date(1993, 9, 23)
datetime.date(1984, 8, 10)
datetime.date(1998, 11, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 8, 28)
datetime.date(2012, 10, 11)
datetime.date(1993, 9, 26)
datetime.date(1984, 8, 12)
datetime.date(1998, 11, 9)
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, 5, 15)
datetime.date(1998, 5, 4)
datetime.date(1959, 3, 16)
datetime.date(1940, 6, 14)
datetime.date(1969, 9, 22)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 2, 24)
datetime.date(1991, 5, 3)
datetime.date(1984, 4, 1)
datetime.date(1980, 11, 8)
datetime.date(1986, 2, 25)
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, 4, 22)
datetime.date(2020, 1, 9)
datetime.date(2011, 2, 10)
datetime.date(2006, 11, 3)
datetime.date(2013, 7, 4)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 7, 20)
datetime.date(2082, 3, 10)
datetime.date(2057, 5, 13)
datetime.date(2045, 6, 20)
datetime.date(2064, 1, 15)
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, 6, 2)
datetime.date(2024, 11, 11)
datetime.date(2022, 9, 12)
datetime.date(2021, 8, 29)
datetime.date(2023, 4, 13)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 6, 11)
datetime.date(2029, 2, 18)
datetime.date(2027, 12, 4)
datetime.date(2027, 5, 6)
datetime.date(2028, 4, 1)
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, 6, 1)
datetime.date(2026, 6, 1)
datetime.date(2026, 6, 1)
datetime.date(2026, 6, 1)
datetime.date(2026, 6, 1)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 6, 26)
datetime.date(2026, 6, 23)
datetime.date(2026, 6, 14)
datetime.date(2026, 6, 9)
datetime.date(2026, 6, 16)
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, 5, 9)
datetime.date(2026, 4, 26)
datetime.date(2026, 3, 5)
datetime.date(2026, 2, 9)
datetime.date(2026, 3, 19)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 11, 28)
datetime.date(2026, 11, 10)
datetime.date(2026, 8, 30)
datetime.date(2026, 7, 27)
datetime.date(2026, 9, 18)
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, 8, 22, 18, 54, 15, 758594)
datetime.datetime(2012, 10, 5, 23, 23, 44, 659824)
datetime.datetime(1993, 9, 23, 14, 41, 40, 517019)
datetime.datetime(1984, 8, 10, 10, 22, 7, 985846)
datetime.datetime(1998, 11, 5, 17, 0, 54, 837372)
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, 4, 23, 21, 29, 11, 228447)
datetime.datetime(1536, 3, 5, 23, 29, 58, 543190)
datetime.datetime(852, 10, 31, 17, 4, 32, 561012)
datetime.datetime(525, 6, 1, 12, 28, 48, 955696)
datetime.datetime(1036, 7, 19, 1, 26, 35, 829575)
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, 10, 2, 1, 6, 47, 236214)
datetime.datetime(2019, 2, 27, 14, 31, 33, 808743)
datetime.datetime(2009, 1, 13, 20, 1, 14, 361449)
datetime.datetime(2004, 3, 9, 13, 11, 50, 49189)
datetime.datetime(2011, 10, 4, 16, 28, 46, 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, 6, 2, 17, 56, 4)
datetime.datetime(2026, 6, 2, 17, 56, 4)
datetime.datetime(2026, 6, 2, 17, 56, 4)
datetime.datetime(2026, 6, 2, 17, 56, 4)
datetime.datetime(2026, 6, 2, 17, 56, 4)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2021, 10, 2, 1, 6, 47, 236214)
datetime.datetime(2019, 2, 27, 14, 31, 33, 808743)
datetime.datetime(2009, 1, 13, 20, 1, 14, 361449)
datetime.datetime(2004, 3, 9, 13, 11, 50, 49189)
datetime.datetime(2011, 10, 4, 16, 28, 46, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 4, 7, 3, 56, 1, 441207)
datetime.datetime(2027, 3, 6, 13, 58, 50, 993625)
datetime.datetime(2026, 11, 3, 8, 33, 50, 345382)
datetime.datetime(2026, 9, 5, 7, 32, 11, 534973)
datetime.datetime(2026, 12, 6, 11, 38, 45, 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, 4, 23, 10, 58, 44, 131974)
datetime.datetime(2020, 1, 10, 1, 38, 32, 303164)
datetime.datetime(2011, 2, 10, 9, 49, 37, 632486)
datetime.datetime(2006, 11, 3, 11, 32, 56, 18102)
datetime.datetime(2013, 7, 4, 16, 7, 27, 493475)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 7, 20, 19, 9, 2, 36712)
datetime.datetime(2082, 3, 10, 23, 7, 18, 319725)
datetime.datetime(2057, 5, 13, 17, 9, 18, 290261)
datetime.datetime(2045, 6, 21, 4, 48, 31, 886420)
datetime.datetime(2064, 1, 15, 9, 13, 51, 212725)
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, 6, 2, 22, 56, 23, 698237)
datetime.datetime(2024, 11, 12, 5, 4, 34, 978586)
datetime.datetime(2022, 9, 13, 3, 13, 3, 247937)
datetime.datetime(2021, 8, 30, 2, 15, 51, 237197)
datetime.datetime(2023, 4, 13, 19, 26, 24, 552235)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 6, 11, 11, 8, 49, 542617)
datetime.datetime(2029, 2, 18, 8, 14, 11, 313910)
datetime.datetime(2027, 12, 4, 23, 4, 6, 636630)
datetime.datetime(2027, 5, 7, 11, 25, 10, 356868)
datetime.datetime(2028, 4, 1, 14, 58, 17, 986348)
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, 6, 2, 11, 24, 37, 300394)
datetime.datetime(2026, 6, 2, 7, 47, 3, 828485)
datetime.datetime(2026, 6, 1, 17, 38, 11, 168128)
datetime.datetime(2026, 6, 1, 10, 51, 27, 108291)
datetime.datetime(2026, 6, 1, 21, 26, 24, 77037)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 6, 26, 14, 30, 28, 138759)
datetime.datetime(2026, 6, 24, 3, 52, 37, 983936)
datetime.datetime(2026, 6, 14, 15, 6, 34, 369385)
datetime.datetime(2026, 6, 10, 1, 29, 49, 108468)
datetime.datetime(2026, 6, 17, 4, 36, 44, 751)
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, 5, 9, 23, 35, 42, 544130)
datetime.datetime(2026, 4, 26, 18, 36, 40, 151006)
datetime.datetime(2026, 3, 6, 5, 47, 16, 240280)
datetime.datetime(2026, 2, 9, 13, 10, 18, 599313)
datetime.datetime(2026, 3, 20, 2, 17, 58, 601900)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 11, 28, 23, 28, 28, 965564)
datetime.datetime(2026, 11, 10, 15, 0, 13, 900120)
datetime.datetime(2026, 8, 31, 0, 21, 13, 132802)
datetime.datetime(2026, 7, 27, 16, 52, 24, 37925)
datetime.datetime(2026, 9, 19, 6, 24, 5, 11180)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'22'
'05'
'23'
'10'
'05'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Tuesday'
'Friday'
'Thursday'
'Friday'
'Thursday'
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, 6, 27)
datetime.date(2026, 6, 24)
datetime.date(2026, 6, 15)
datetime.date(2026, 6, 10)
datetime.date(2026, 6, 17)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 4, 6)
datetime.date(2027, 3, 5)
datetime.date(2026, 11, 3)
datetime.date(2026, 9, 5)
datetime.date(2026, 12, 6)
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, 6, 28, 1, 55, 5, 594731)
datetime.datetime(2026, 6, 25, 11, 39, 42, 54467)
datetime.datetime(2026, 6, 15, 8, 44, 46, 116942)
datetime.datetime(2026, 6, 10, 12, 21, 16, 957843)
datetime.datetime(2026, 6, 18, 2, 3, 8, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 4, 7, 3, 56, 1, 596785)
datetime.datetime(2027, 3, 6, 13, 58, 51, 235670)
datetime.datetime(2026, 11, 3, 8, 33, 50, 924810)
datetime.datetime(2026, 9, 5, 7, 32, 12, 276056)
datetime.datetime(2026, 12, 6, 11, 38, 45, 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-08-22T18:54:15.758594'
'2012-10-05T23:23:44.659824'
'1993-09-23T14:41:40.517019'
'1984-08-10T10:22:07.985846'
'1998-11-05T17:00:54.837372'
month() str
Examples:

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

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'August'
'October'
'September'
'August'
'November'
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, 5, 27)
datetime.date(2026, 5, 24)
datetime.date(2026, 5, 15)
datetime.date(2026, 5, 10)
datetime.date(2026, 5, 17)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 4, 5)
datetime.date(2026, 3, 4)
datetime.date(2025, 11, 1)
datetime.date(2025, 9, 3)
datetime.date(2025, 12, 4)
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, 5, 29, 1, 55, 4, 594731)
datetime.datetime(2026, 5, 26, 11, 39, 41, 54467)
datetime.datetime(2026, 5, 16, 8, 44, 45, 116942)
datetime.datetime(2026, 5, 11, 12, 21, 15, 957843)
datetime.datetime(2026, 5, 19, 2, 3, 7, 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()
...
'18:54:15'
'23:23:44'
'14:41:40'
'10:22:07'
'17:00:54'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'06:54 PM'
'11:23 PM'
'02:41 PM'
'10:22 AM'
'05:00 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(18, 54, 15, 758594)
datetime.time(23, 23, 44, 659824)
datetime.time(14, 41, 40, 517019)
datetime.time(10, 22, 7, 985846)
datetime.time(17, 0, 54, 837372)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(19, 44, 55, 677260)
datetime.time(0, 9, 13, 295674)
datetime.time(15, 6, 54, 574710)
datetime.time(10, 37, 40, 86147)
datetime.time(17, 31, 35, 426369)
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 0x74aac25eb220>
<generator object Provider.time_series at 0x74aac25eb220>
<generator object Provider.time_series at 0x74aac25eb220>
<generator object Provider.time_series at 0x74aac25eb220>
<generator object Provider.time_series at 0x74aac25eb220>
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()
...
1503428055.758594
1349479424.6598237
748795300.5170187
460981327.9858457
910285254.8373721
year() str
Examples:

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