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'
'AM'
'PM'
'PM'
'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-09-16'
'2012-10-28'
'1993-10-05'
'1984-08-17'
'1998-11-20'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'09/16/2017'
'10/28/2012'
'10/05/1993'
'08/17/1984'
'11/20/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-09-22'
'2012-11-02'
'1993-10-08'
'1984-08-19'
'1998-11-24'
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, 30)
datetime.date(2019, 3, 27)
datetime.date(2009, 2, 10)
datetime.date(2004, 4, 6)
datetime.date(2011, 11, 1)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 6, 29)
datetime.date(2026, 6, 29)
datetime.date(2026, 6, 26)
datetime.date(2026, 6, 25)
datetime.date(2026, 6, 27)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 5, 10)
datetime.date(2026, 4, 8)
datetime.date(2025, 12, 3)
datetime.date(2025, 10, 4)
datetime.date(2026, 1, 6)
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, 7, 1)
datetime.date(2026, 7, 1)
datetime.date(2026, 7, 1)
datetime.date(2026, 7, 1)
datetime.date(2026, 7, 1)
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, 9, 16)
datetime.date(2012, 10, 28)
datetime.date(1993, 10, 5)
datetime.date(1984, 8, 17)
datetime.date(1998, 11, 20)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 9, 22)
datetime.date(2012, 11, 2)
datetime.date(1993, 10, 8)
datetime.date(1984, 8, 19)
datetime.date(1998, 11, 24)
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, 6, 13)
datetime.date(1998, 6, 2)
datetime.date(1959, 4, 14)
datetime.date(1940, 7, 13)
datetime.date(1969, 10, 21)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 3, 25)
datetime.date(1991, 6, 1)
datetime.date(1984, 4, 30)
datetime.date(1980, 12, 7)
datetime.date(1986, 3, 26)
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, 5, 17)
datetime.date(2020, 1, 31)
datetime.date(2011, 2, 22)
datetime.date(2006, 11, 10)
datetime.date(2013, 7, 19)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 7, 25)
datetime.date(2082, 3, 17)
datetime.date(2057, 5, 30)
datetime.date(2045, 7, 12)
datetime.date(2064, 1, 29)
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, 26)
datetime.date(2024, 12, 3)
datetime.date(2022, 9, 25)
datetime.date(2021, 9, 6)
datetime.date(2023, 4, 28)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 6, 15)
datetime.date(2029, 2, 25)
datetime.date(2027, 12, 21)
datetime.date(2027, 5, 28)
datetime.date(2028, 4, 15)
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, 7, 1)
datetime.date(2026, 7, 1)
datetime.date(2026, 7, 1)
datetime.date(2026, 7, 1)
datetime.date(2026, 7, 1)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 7, 27)
datetime.date(2026, 7, 24)
datetime.date(2026, 7, 14)
datetime.date(2026, 7, 9)
datetime.date(2026, 7, 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, 6, 2)
datetime.date(2026, 5, 18)
datetime.date(2026, 3, 18)
datetime.date(2026, 2, 16)
datetime.date(2026, 4, 3)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 12, 3)
datetime.date(2026, 11, 17)
datetime.date(2026, 9, 16)
datetime.date(2026, 8, 17)
datetime.date(2026, 10, 3)
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, 9, 16, 10, 25, 3, 584177)
datetime.datetime(2012, 10, 28, 2, 20, 20, 429979)
datetime.datetime(1993, 10, 5, 21, 18, 10, 359269)
datetime.datetime(1984, 8, 17, 23, 44, 19, 586233)
datetime.datetime(1998, 11, 20, 15, 9, 38, 226774)
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, 5, 18, 12, 59, 59, 54031)
datetime.datetime(1536, 3, 28, 2, 26, 34, 313347)
datetime.datetime(852, 11, 12, 23, 41, 2, 403259)
datetime.datetime(525, 6, 9, 1, 51, 0, 556084)
datetime.datetime(1036, 8, 2, 23, 35, 19, 218979)
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, 31, 5, 36, 29, 236214)
datetime.datetime(2019, 3, 28, 19, 1, 15, 808743)
datetime.datetime(2009, 2, 12, 0, 30, 56, 361449)
datetime.datetime(2004, 4, 7, 17, 41, 32, 49189)
datetime.datetime(2011, 11, 2, 20, 58, 28, 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, 7, 1, 22, 25, 46)
datetime.datetime(2026, 7, 1, 22, 25, 46)
datetime.datetime(2026, 7, 1, 22, 25, 46)
datetime.datetime(2026, 7, 1, 22, 25, 46)
datetime.datetime(2026, 7, 1, 22, 25, 46)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2021, 10, 31, 5, 36, 29, 236214)
datetime.datetime(2019, 3, 28, 19, 1, 15, 808743)
datetime.datetime(2009, 2, 12, 0, 30, 56, 361449)
datetime.datetime(2004, 4, 7, 17, 41, 32, 49189)
datetime.datetime(2011, 11, 2, 20, 58, 28, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 5, 6, 8, 25, 43, 441207)
datetime.datetime(2027, 4, 4, 18, 28, 32, 993625)
datetime.datetime(2026, 12, 2, 13, 3, 32, 345382)
datetime.datetime(2026, 10, 4, 12, 1, 53, 534973)
datetime.datetime(2027, 1, 4, 16, 8, 27, 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, 5, 18, 2, 29, 31, 957557)
datetime.datetime(2020, 2, 1, 4, 35, 8, 73319)
datetime.datetime(2011, 2, 22, 16, 26, 7, 474737)
datetime.datetime(2006, 11, 11, 0, 55, 7, 618489)
datetime.datetime(2013, 7, 19, 14, 16, 10, 882878)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 7, 25, 8, 7, 56, 211129)
datetime.datetime(2082, 3, 18, 0, 40, 24, 549569)
datetime.datetime(2057, 5, 30, 15, 2, 30, 448010)
datetime.datetime(2045, 7, 12, 19, 56, 2, 286033)
datetime.datetime(2064, 1, 29, 15, 34, 49, 823322)
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, 27, 14, 27, 11, 523820)
datetime.datetime(2024, 12, 4, 8, 1, 10, 748742)
datetime.datetime(2022, 9, 25, 9, 49, 33, 90188)
datetime.datetime(2021, 9, 6, 15, 38, 2, 837584)
datetime.datetime(2023, 4, 28, 17, 35, 7, 941638)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 6, 16, 0, 7, 43, 717035)
datetime.datetime(2029, 2, 25, 9, 47, 17, 543754)
datetime.datetime(2027, 12, 21, 20, 57, 18, 794379)
datetime.datetime(2027, 5, 29, 2, 32, 40, 756480)
datetime.datetime(2028, 4, 15, 21, 19, 16, 596946)
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, 7, 1, 18, 56, 23, 686823)
datetime.datetime(2026, 7, 1, 17, 0, 1, 786220)
datetime.datetime(2026, 7, 1, 9, 25, 59, 472866)
datetime.datetime(2026, 7, 1, 5, 48, 26, 491919)
datetime.datetime(2026, 7, 1, 11, 28, 3, 388652)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 7, 27, 7, 44, 21, 800302)
datetime.datetime(2026, 7, 24, 17, 20, 49, 286615)
datetime.datetime(2026, 7, 14, 13, 54, 5, 449232)
datetime.datetime(2026, 7, 9, 17, 15, 22, 132066)
datetime.datetime(2026, 7, 17, 7, 21, 0, 825062)
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, 6, 3, 15, 6, 30, 369713)
datetime.datetime(2026, 5, 18, 21, 33, 15, 921161)
datetime.datetime(2026, 3, 18, 12, 23, 46, 82531)
datetime.datetime(2026, 2, 17, 2, 32, 30, 199701)
datetime.datetime(2026, 4, 4, 0, 26, 41, 991302)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 12, 3, 12, 27, 23, 139981)
datetime.datetime(2026, 11, 17, 16, 33, 20, 129964)
datetime.datetime(2026, 9, 16, 22, 14, 25, 290551)
datetime.datetime(2026, 8, 18, 7, 59, 54, 437538)
datetime.datetime(2026, 10, 3, 12, 45, 3, 621778)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'16'
'28'
'05'
'17'
'20'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Saturday'
'Sunday'
'Tuesday'
'Friday'
'Friday'
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, 7, 26)
datetime.date(2026, 7, 23)
datetime.date(2026, 7, 14)
datetime.date(2026, 7, 9)
datetime.date(2026, 7, 16)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 5, 5)
datetime.date(2027, 4, 3)
datetime.date(2026, 12, 2)
datetime.date(2026, 10, 4)
datetime.date(2027, 1, 4)
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, 7, 27, 6, 24, 47, 594731)
datetime.datetime(2026, 7, 24, 16, 9, 24, 54467)
datetime.datetime(2026, 7, 14, 13, 14, 28, 116942)
datetime.datetime(2026, 7, 9, 16, 50, 58, 957843)
datetime.datetime(2026, 7, 17, 6, 32, 50, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 5, 6, 8, 25, 43, 596785)
datetime.datetime(2027, 4, 4, 18, 28, 33, 235670)
datetime.datetime(2026, 12, 2, 13, 3, 32, 924810)
datetime.datetime(2026, 10, 4, 12, 1, 54, 276056)
datetime.datetime(2027, 1, 4, 16, 8, 27, 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-09-16T10:25:03.584177'
'2012-10-28T02:20:20.429979'
'1993-10-05T21:18:10.359269'
'1984-08-17T23:44:19.586233'
'1998-11-20T15:09:38.226774'
month() str
Examples:

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

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'September'
'October'
'October'
'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, 6, 25)
datetime.date(2026, 6, 22)
datetime.date(2026, 6, 13)
datetime.date(2026, 6, 8)
datetime.date(2026, 6, 15)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 5, 4)
datetime.date(2026, 4, 2)
datetime.date(2025, 11, 30)
datetime.date(2025, 10, 2)
datetime.date(2026, 1, 2)
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, 6, 27, 6, 24, 46, 594731)
datetime.datetime(2026, 6, 24, 16, 9, 23, 54467)
datetime.datetime(2026, 6, 14, 13, 14, 27, 116942)
datetime.datetime(2026, 6, 9, 16, 50, 57, 957843)
datetime.datetime(2026, 6, 17, 6, 32, 49, 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()
...
'10:25:03'
'02:20:20'
'21:18:10'
'23:44:19'
'15:09:38'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'10:25 AM'
'02:20 AM'
'09:18 PM'
'11:44 PM'
'03:09 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(10, 25, 3, 584177)
datetime.time(2, 20, 20, 429979)
datetime.time(21, 18, 10, 359269)
datetime.time(23, 44, 19, 586233)
datetime.time(15, 9, 38, 226774)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(11, 15, 43, 502842)
datetime.time(3, 5, 49, 65830)
datetime.time(21, 43, 24, 416960)
datetime.time(23, 59, 51, 686534)
datetime.time(15, 40, 18, 815771)
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 0x79ebf660b3e0>
<generator object Provider.time_series at 0x79ebf660b3e0>
<generator object Provider.time_series at 0x79ebf660b3e0>
<generator object Provider.time_series at 0x79ebf660b3e0>
<generator object Provider.time_series at 0x79ebf660b3e0>
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()
...
1505557503.5841765
1351390820.4299793
749855890.3592694
461634259.58623296
911574578.2267745
year() str
Examples:

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