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'
'PM'
'AM'
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-11-07'
'2012-12-13'
'1993-10-31'
'1984-09-02'
'1998-12-22'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'11/07/2017'
'12/13/2012'
'10/31/1993'
'09/02/1984'
'12/22/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-11-13'
'2012-12-19'
'1993-11-03'
'1984-09-04'
'1998-12-25'
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, 31)
datetime.date(2019, 5, 28)
datetime.date(2009, 4, 13)
datetime.date(2004, 6, 7)
datetime.date(2012, 1, 2)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 8, 30)
datetime.date(2026, 8, 30)
datetime.date(2026, 8, 27)
datetime.date(2026, 8, 26)
datetime.date(2026, 8, 28)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 7, 11)
datetime.date(2026, 6, 9)
datetime.date(2026, 2, 3)
datetime.date(2025, 12, 5)
datetime.date(2026, 3, 9)
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, 9, 1)
datetime.date(2026, 9, 1)
datetime.date(2026, 9, 1)
datetime.date(2026, 9, 1)
datetime.date(2026, 9, 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, 11, 7)
datetime.date(2012, 12, 13)
datetime.date(1993, 10, 31)
datetime.date(1984, 9, 2)
datetime.date(1998, 12, 22)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 11, 13)
datetime.date(2012, 12, 19)
datetime.date(1993, 11, 3)
datetime.date(1984, 9, 4)
datetime.date(1998, 12, 25)
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, 14)
datetime.date(1998, 8, 3)
datetime.date(1959, 6, 15)
datetime.date(1940, 9, 13)
datetime.date(1969, 12, 22)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 5, 26)
datetime.date(1991, 8, 2)
datetime.date(1984, 7, 1)
datetime.date(1981, 2, 7)
datetime.date(1986, 5, 27)
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, 7, 8)
datetime.date(2020, 3, 18)
datetime.date(2011, 3, 20)
datetime.date(2006, 11, 26)
datetime.date(2013, 8, 19)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 8, 3)
datetime.date(2082, 4, 1)
datetime.date(2057, 7, 5)
datetime.date(2045, 8, 27)
datetime.date(2064, 2, 28)
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, 18)
datetime.date(2025, 1, 19)
datetime.date(2022, 10, 21)
datetime.date(2021, 9, 22)
datetime.date(2023, 5, 29)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 6, 25)
datetime.date(2029, 3, 12)
datetime.date(2028, 1, 26)
datetime.date(2027, 7, 13)
datetime.date(2028, 5, 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, 9, 1)
datetime.date(2026, 9, 1)
datetime.date(2026, 9, 1)
datetime.date(2026, 9, 1)
datetime.date(2026, 9, 1)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 9, 26)
datetime.date(2026, 9, 23)
datetime.date(2026, 9, 13)
datetime.date(2026, 9, 8)
datetime.date(2026, 9, 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, 7, 25)
datetime.date(2026, 7, 4)
datetime.date(2026, 4, 13)
datetime.date(2026, 3, 4)
datetime.date(2026, 5, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 12, 13)
datetime.date(2026, 12, 2)
datetime.date(2026, 10, 22)
datetime.date(2026, 10, 2)
datetime.date(2026, 11, 2)
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, 11, 7, 14, 54, 27, 166874)
datetime.datetime(2012, 12, 13, 22, 34, 33, 345132)
datetime.datetime(1993, 10, 31, 21, 6, 58, 532290)
datetime.datetime(1984, 9, 2, 23, 46, 38, 652356)
datetime.datetime(1998, 12, 22, 5, 30, 34, 412840)
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, 7, 9, 17, 29, 22, 636726)
datetime.datetime(1536, 5, 13, 22, 40, 47, 228500)
datetime.datetime(852, 12, 8, 23, 29, 50, 576279)
datetime.datetime(525, 6, 25, 1, 53, 19, 622208)
datetime.datetime(1036, 9, 3, 13, 56, 15, 405045)
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(2022, 1, 1, 0, 51, 34, 236214)
datetime.datetime(2019, 5, 29, 14, 16, 20, 808743)
datetime.datetime(2009, 4, 14, 19, 46, 1, 361449)
datetime.datetime(2004, 6, 8, 12, 56, 37, 49189)
datetime.datetime(2012, 1, 3, 16, 13, 33, 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, 9, 1, 17, 40, 51)
datetime.datetime(2026, 9, 1, 17, 40, 51)
datetime.datetime(2026, 9, 1, 17, 40, 51)
datetime.datetime(2026, 9, 1, 17, 40, 51)
datetime.datetime(2026, 9, 1, 17, 40, 51)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2022, 1, 1, 0, 51, 34, 236214)
datetime.datetime(2019, 5, 29, 14, 16, 20, 808743)
datetime.datetime(2009, 4, 14, 19, 46, 1, 361449)
datetime.datetime(2004, 6, 8, 12, 56, 37, 49189)
datetime.datetime(2012, 1, 3, 16, 13, 33, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 7, 7, 3, 40, 48, 441207)
datetime.datetime(2027, 6, 5, 13, 43, 37, 993625)
datetime.datetime(2027, 2, 2, 8, 18, 37, 345382)
datetime.datetime(2026, 12, 5, 7, 16, 58, 534973)
datetime.datetime(2027, 3, 7, 11, 23, 32, 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, 7, 9, 6, 58, 55, 540254)
datetime.datetime(2020, 3, 19, 0, 49, 20, 988472)
datetime.datetime(2011, 3, 20, 16, 14, 55, 647758)
datetime.datetime(2006, 11, 27, 0, 57, 26, 684612)
datetime.datetime(2013, 8, 20, 4, 37, 7, 68943)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 8, 3, 22, 53, 37, 628431)
datetime.datetime(2082, 4, 1, 23, 41, 16, 634417)
datetime.datetime(2057, 7, 5, 10, 28, 47, 274990)
datetime.datetime(2045, 8, 27, 15, 8, 48, 219910)
datetime.datetime(2064, 2, 28, 20, 28, 58, 637257)
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, 18, 18, 56, 35, 106517)
datetime.datetime(2025, 1, 20, 4, 15, 23, 663894)
datetime.datetime(2022, 10, 21, 9, 38, 21, 263208)
datetime.datetime(2021, 9, 22, 15, 40, 21, 903708)
datetime.datetime(2023, 5, 30, 7, 56, 4, 127703)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 6, 25, 14, 53, 25, 134337)
datetime.datetime(2029, 3, 12, 8, 48, 9, 628602)
datetime.datetime(2028, 1, 26, 16, 23, 35, 621359)
datetime.datetime(2027, 7, 13, 21, 45, 26, 690357)
datetime.datetime(2028, 5, 16, 2, 13, 25, 410880)
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, 9, 1, 14, 55, 48, 295271)
datetime.datetime(2026, 9, 1, 13, 24, 4, 555701)
datetime.datetime(2026, 9, 1, 7, 26, 9, 801692)
datetime.datetime(2026, 9, 1, 4, 34, 40, 310073)
datetime.datetime(2026, 9, 1, 9, 2, 23, 147290)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 9, 26, 10, 44, 4, 143882)
datetime.datetime(2026, 9, 23, 22, 0, 24, 256720)
datetime.datetime(2026, 9, 14, 1, 3, 22, 735822)
datetime.datetime(2026, 9, 9, 7, 31, 22, 906687)
datetime.datetime(2026, 9, 16, 16, 45, 31, 930498)
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, 25, 19, 35, 53, 952410)
datetime.datetime(2026, 7, 4, 17, 47, 28, 836314)
datetime.datetime(2026, 4, 13, 12, 12, 34, 255551)
datetime.datetime(2026, 3, 5, 2, 34, 49, 265824)
datetime.datetime(2026, 5, 5, 14, 47, 38, 177368)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 12, 13, 3, 13, 4, 557284)
datetime.datetime(2026, 12, 2, 15, 34, 12, 214812)
datetime.datetime(2026, 10, 22, 17, 40, 42, 117530)
datetime.datetime(2026, 10, 3, 3, 12, 40, 371415)
datetime.datetime(2026, 11, 2, 17, 39, 12, 435712)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'07'
'13'
'31'
'02'
'22'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Tuesday'
'Thursday'
'Sunday'
'Sunday'
'Tuesday'
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, 26)
datetime.date(2026, 9, 23)
datetime.date(2026, 9, 14)
datetime.date(2026, 9, 9)
datetime.date(2026, 9, 16)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 7, 6)
datetime.date(2027, 6, 4)
datetime.date(2027, 2, 2)
datetime.date(2026, 12, 5)
datetime.date(2027, 3, 7)
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, 27, 1, 39, 52, 594731)
datetime.datetime(2026, 9, 24, 11, 24, 29, 54467)
datetime.datetime(2026, 9, 14, 8, 29, 33, 116942)
datetime.datetime(2026, 9, 9, 12, 6, 3, 957843)
datetime.datetime(2026, 9, 17, 1, 47, 55, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 7, 7, 3, 40, 48, 596785)
datetime.datetime(2027, 6, 5, 13, 43, 38, 235670)
datetime.datetime(2027, 2, 2, 8, 18, 37, 924810)
datetime.datetime(2026, 12, 5, 7, 16, 59, 276056)
datetime.datetime(2027, 3, 7, 11, 23, 32, 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-11-07T14:54:27.166874'
'2012-12-13T22:34:33.345132'
'1993-10-31T21:06:58.532290'
'1984-09-02T23:46:38.652356'
'1998-12-22T05:30:34.412840'
month() str
Examples:

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

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'November'
'December'
'October'
'September'
'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, 26)
datetime.date(2026, 8, 23)
datetime.date(2026, 8, 14)
datetime.date(2026, 8, 9)
datetime.date(2026, 8, 16)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 7, 5)
datetime.date(2026, 6, 3)
datetime.date(2026, 1, 31)
datetime.date(2025, 12, 3)
datetime.date(2026, 3, 5)
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, 28, 1, 39, 51, 594731)
datetime.datetime(2026, 8, 25, 11, 24, 28, 54467)
datetime.datetime(2026, 8, 15, 8, 29, 32, 116942)
datetime.datetime(2026, 8, 10, 12, 6, 2, 957843)
datetime.datetime(2026, 8, 18, 1, 47, 54, 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()
...
'14:54:27'
'22:34:33'
'21:06:58'
'23:46:38'
'05:30:34'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'02:54 PM'
'10:34 PM'
'09:06 PM'
'11:46 PM'
'05:30 AM'
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(14, 54, 27, 166874)
datetime.time(22, 34, 33, 345132)
datetime.time(21, 6, 58, 532290)
datetime.time(23, 46, 38, 652356)
datetime.time(5, 30, 34, 412840)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(15, 45, 7, 85540)
datetime.time(23, 20, 1, 980982)
datetime.time(21, 32, 12, 589981)
datetime.time(0, 2, 10, 752657)
datetime.time(6, 1, 15, 1837)
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 0x701d36295380>
<generator object Provider.time_series at 0x701d36295380>
<generator object Provider.time_series at 0x701d36295380>
<generator object Provider.time_series at 0x701d36295380>
<generator object Provider.time_series at 0x701d36295380>
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()
...
1510066467.1668742
1355438073.3451316
752101618.5322897
463016798.652356
914304634.41284
year() str
Examples:

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