faker2.providers.date_time

class faker2.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'
'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-28'
'2012-11-07'
'1993-10-11'
'1984-08-21'
'1998-11-27'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'09/28/2017'
'11/07/2012'
'10/11/1993'
'08/21/1984'
'11/27/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-10-04'
'2012-11-13'
'1993-10-14'
'1984-08-23'
'1998-12-01'
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, 11, 14)
datetime.date(2019, 4, 11)
datetime.date(2009, 2, 25)
datetime.date(2004, 4, 21)
datetime.date(2011, 11, 16)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 7, 14)
datetime.date(2026, 7, 14)
datetime.date(2026, 7, 11)
datetime.date(2026, 7, 10)
datetime.date(2026, 7, 12)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 5, 25)
datetime.date(2026, 4, 23)
datetime.date(2025, 12, 18)
datetime.date(2025, 10, 19)
datetime.date(2026, 1, 21)
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, 16)
datetime.date(2026, 7, 16)
datetime.date(2026, 7, 16)
datetime.date(2026, 7, 16)
datetime.date(2026, 7, 16)
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, 28)
datetime.date(2012, 11, 7)
datetime.date(1993, 10, 11)
datetime.date(1984, 8, 21)
datetime.date(1998, 11, 27)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 10, 4)
datetime.date(2012, 11, 13)
datetime.date(1993, 10, 14)
datetime.date(1984, 8, 23)
datetime.date(1998, 12, 1)
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, 28)
datetime.date(1998, 6, 17)
datetime.date(1959, 4, 29)
datetime.date(1940, 7, 28)
datetime.date(1969, 11, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 4, 9)
datetime.date(1991, 6, 16)
datetime.date(1984, 5, 15)
datetime.date(1980, 12, 22)
datetime.date(1986, 4, 10)
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, 29)
datetime.date(2020, 2, 11)
datetime.date(2011, 2, 28)
datetime.date(2006, 11, 14)
datetime.date(2013, 7, 26)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 7, 27)
datetime.date(2082, 3, 21)
datetime.date(2057, 6, 7)
datetime.date(2045, 7, 23)
datetime.date(2064, 2, 5)
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, 7, 9)
datetime.date(2024, 12, 14)
datetime.date(2022, 10, 1)
datetime.date(2021, 9, 10)
datetime.date(2023, 5, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 6, 18)
datetime.date(2029, 2, 28)
datetime.date(2027, 12, 30)
datetime.date(2027, 6, 8)
datetime.date(2028, 4, 22)
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, 13)
datetime.date(2026, 7, 12)
datetime.date(2026, 7, 7)
datetime.date(2026, 7, 4)
datetime.date(2026, 7, 8)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 7, 29)
datetime.date(2026, 7, 28)
datetime.date(2026, 7, 22)
datetime.date(2026, 7, 20)
datetime.date(2026, 7, 24)
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, 15)
datetime.date(2026, 5, 29)
datetime.date(2026, 3, 24)
datetime.date(2026, 2, 20)
datetime.date(2026, 4, 11)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 12, 5)
datetime.date(2026, 11, 21)
datetime.date(2026, 9, 25)
datetime.date(2026, 8, 28)
datetime.date(2026, 10, 10)
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, 28, 12, 40, 15, 671487)
datetime.datetime(2012, 11, 7, 22, 52, 15, 188855)
datetime.datetime(1993, 10, 11, 21, 51, 57, 829965)
datetime.datetime(1984, 8, 21, 16, 44, 10, 681631)
datetime.datetime(1998, 11, 27, 22, 54, 4, 393963)
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, 30, 15, 15, 11, 141342)
datetime.datetime(1536, 4, 7, 22, 58, 29, 72227)
datetime.datetime(852, 11, 19, 0, 14, 49, 873962)
datetime.datetime(525, 6, 12, 18, 50, 51, 651482)
datetime.datetime(1036, 8, 10, 7, 19, 45, 386166)
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, 11, 14, 13, 20, 18, 236214)
datetime.datetime(2019, 4, 12, 2, 45, 4, 808743)
datetime.datetime(2009, 2, 26, 8, 14, 45, 361449)
datetime.datetime(2004, 4, 22, 1, 25, 21, 49189)
datetime.datetime(2011, 11, 17, 4, 42, 17, 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, 16, 6, 9, 35)
datetime.datetime(2026, 7, 16, 6, 9, 35)
datetime.datetime(2026, 7, 16, 6, 9, 35)
datetime.datetime(2026, 7, 16, 6, 9, 35)
datetime.datetime(2026, 7, 16, 6, 9, 35)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2021, 11, 14, 13, 20, 18, 236214)
datetime.datetime(2019, 4, 12, 2, 45, 4, 808743)
datetime.datetime(2009, 2, 26, 8, 14, 45, 361449)
datetime.datetime(2004, 4, 22, 1, 25, 21, 49189)
datetime.datetime(2011, 11, 17, 4, 42, 17, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 5, 20, 16, 9, 32, 441207)
datetime.datetime(2027, 4, 19, 2, 12, 21, 993625)
datetime.datetime(2026, 12, 16, 20, 47, 21, 345382)
datetime.datetime(2026, 10, 18, 19, 45, 42, 534973)
datetime.datetime(2027, 1, 18, 23, 52, 16, 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, 30, 4, 44, 44, 44868)
datetime.datetime(2020, 2, 12, 1, 7, 2, 832196)
datetime.datetime(2011, 2, 28, 16, 59, 54, 945433)
datetime.datetime(2006, 11, 14, 17, 54, 58, 713887)
datetime.datetime(2013, 7, 26, 22, 0, 37, 50066)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 7, 27, 13, 36, 33, 123818)
datetime.datetime(2082, 3, 21, 11, 52, 18, 790693)
datetime.datetime(2057, 6, 7, 22, 12, 31, 977314)
datetime.datetime(2045, 7, 23, 10, 40, 0, 190635)
datetime.datetime(2064, 2, 5, 15, 34, 12, 656134)
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, 7, 9, 16, 42, 23, 611130)
datetime.datetime(2024, 12, 15, 4, 33, 5, 507618)
datetime.datetime(2022, 10, 1, 10, 23, 20, 560884)
datetime.datetime(2021, 9, 10, 8, 37, 53, 932983)
datetime.datetime(2023, 5, 6, 1, 19, 34, 108826)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 6, 18, 5, 36, 20, 629724)
datetime.datetime(2029, 2, 28, 20, 59, 11, 784878)
datetime.datetime(2027, 12, 30, 4, 7, 20, 323683)
datetime.datetime(2027, 6, 8, 17, 16, 38, 661082)
datetime.datetime(2028, 4, 22, 21, 18, 39, 429757)
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, 13, 21, 11, 35, 774134)
datetime.datetime(2026, 7, 12, 13, 31, 56, 545096)
datetime.datetime(2026, 7, 7, 9, 59, 46, 943562)
datetime.datetime(2026, 7, 4, 22, 48, 17, 587317)
datetime.datetime(2026, 7, 8, 19, 12, 29, 555840)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 7, 29, 13, 12, 58, 712991)
datetime.datetime(2026, 7, 28, 4, 32, 43, 527740)
datetime.datetime(2026, 7, 22, 21, 4, 6, 978536)
datetime.datetime(2026, 7, 20, 7, 59, 20, 36667)
datetime.datetime(2026, 7, 24, 7, 20, 23, 657874)
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, 15, 17, 21, 42, 457023)
datetime.datetime(2026, 5, 29, 18, 5, 10, 680037)
datetime.datetime(2026, 3, 24, 12, 57, 33, 553227)
datetime.datetime(2026, 2, 20, 19, 32, 21, 295099)
datetime.datetime(2026, 4, 11, 8, 11, 8, 158491)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 12, 5, 17, 56, 0, 52670)
datetime.datetime(2026, 11, 21, 3, 45, 14, 371088)
datetime.datetime(2026, 9, 25, 5, 24, 26, 819855)
datetime.datetime(2026, 8, 28, 22, 43, 52, 342140)
datetime.datetime(2026, 10, 10, 12, 44, 26, 454590)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'28'
'07'
'11'
'21'
'27'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Thursday'
'Wednesday'
'Monday'
'Tuesday'
'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, 8, 10)
datetime.date(2026, 8, 7)
datetime.date(2026, 7, 29)
datetime.date(2026, 7, 24)
datetime.date(2026, 7, 31)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 5, 20)
datetime.date(2027, 4, 18)
datetime.date(2026, 12, 17)
datetime.date(2026, 10, 19)
datetime.date(2027, 1, 19)
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, 8, 10, 14, 8, 36, 594731)
datetime.datetime(2026, 8, 7, 23, 53, 13, 54467)
datetime.datetime(2026, 7, 28, 20, 58, 17, 116942)
datetime.datetime(2026, 7, 24, 0, 34, 47, 957843)
datetime.datetime(2026, 7, 31, 14, 16, 39, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 5, 20, 16, 9, 32, 596785)
datetime.datetime(2027, 4, 19, 2, 12, 22, 235670)
datetime.datetime(2026, 12, 16, 20, 47, 21, 924810)
datetime.datetime(2026, 10, 18, 19, 45, 43, 276056)
datetime.datetime(2027, 1, 18, 23, 52, 16, 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-28T12:40:15.671487'
'2012-11-07T22:52:15.188855'
'1993-10-11T21:51:57.829965'
'1984-08-21T16:44:10.681631'
'1998-11-27T22:54:04.393963'
month() str
Examples:

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

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'September'
'November'
'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, 7, 10)
datetime.date(2026, 7, 7)
datetime.date(2026, 6, 28)
datetime.date(2026, 6, 23)
datetime.date(2026, 6, 30)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 5, 19)
datetime.date(2026, 4, 17)
datetime.date(2025, 12, 15)
datetime.date(2025, 10, 17)
datetime.date(2026, 1, 17)
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, 7, 11, 14, 8, 35, 594731)
datetime.datetime(2026, 7, 8, 23, 53, 12, 54467)
datetime.datetime(2026, 6, 28, 20, 58, 16, 116942)
datetime.datetime(2026, 6, 24, 0, 34, 46, 957843)
datetime.datetime(2026, 7, 1, 14, 16, 38, 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()
...
'12:40:15'
'22:52:15'
'21:51:57'
'16:44:10'
'22:54:04'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'12:40 PM'
'10:52 PM'
'09:51 PM'
'04:44 PM'
'10:54 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(12, 40, 15, 671487)
datetime.time(22, 52, 15, 188855)
datetime.time(21, 51, 57, 829965)
datetime.time(16, 44, 10, 681631)
datetime.time(22, 54, 4, 393963)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(13, 30, 55, 590153)
datetime.time(23, 37, 43, 824706)
datetime.time(22, 17, 11, 887656)
datetime.time(16, 59, 42, 781932)
datetime.time(23, 24, 44, 982960)
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 0x7f8342bcd340>
<generator object Provider.time_series at 0x7f8342bcd340>
<generator object Provider.time_series at 0x7f8342bcd340>
<generator object Provider.time_series at 0x7f8342bcd340>
<generator object Provider.time_series at 0x7f8342bcd340>
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()
...
1506602415.6714873
1352328735.1888552
750376317.8299654
461954650.6816312
912207244.393963
year() str
Examples:

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