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-10-05'
'2012-11-14'
'1993-10-15'
'1984-08-23'
'1998-12-02'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'10/05/2017'
'11/14/2012'
'10/15/1993'
'08/23/1984'
'12/02/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-10-11'
'2012-11-19'
'1993-10-18'
'1984-08-25'
'1998-12-05'
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, 22)
datetime.date(2019, 4, 19)
datetime.date(2009, 3, 5)
datetime.date(2004, 4, 29)
datetime.date(2011, 11, 24)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 7, 22)
datetime.date(2026, 7, 22)
datetime.date(2026, 7, 19)
datetime.date(2026, 7, 18)
datetime.date(2026, 7, 20)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 6, 2)
datetime.date(2026, 5, 1)
datetime.date(2025, 12, 26)
datetime.date(2025, 10, 27)
datetime.date(2026, 1, 29)
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, 24)
datetime.date(2026, 7, 24)
datetime.date(2026, 7, 24)
datetime.date(2026, 7, 24)
datetime.date(2026, 7, 24)
date_object(end_datetime: datetime | None = None) date

Get a date object between January 1, 1970 and now

Parameters:

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

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object()
...
datetime.date(2017, 10, 5)
datetime.date(2012, 11, 14)
datetime.date(1993, 10, 15)
datetime.date(1984, 8, 23)
datetime.date(1998, 12, 2)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 10, 11)
datetime.date(2012, 11, 19)
datetime.date(1993, 10, 18)
datetime.date(1984, 8, 25)
datetime.date(1998, 12, 5)
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, 7, 6)
datetime.date(1998, 6, 25)
datetime.date(1959, 5, 7)
datetime.date(1940, 8, 5)
datetime.date(1969, 11, 13)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 4, 17)
datetime.date(1991, 6, 24)
datetime.date(1984, 5, 23)
datetime.date(1980, 12, 30)
datetime.date(1986, 4, 18)
date_this_century(before_today: bool = True, after_today: bool = False) date

Gets a Date object for the current century.

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

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

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century()
...
datetime.date(2022, 6, 5)
datetime.date(2020, 2, 17)
datetime.date(2011, 3, 3)
datetime.date(2006, 11, 16)
datetime.date(2013, 7, 30)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 7, 28)
datetime.date(2082, 3, 23)
datetime.date(2057, 6, 12)
datetime.date(2045, 7, 29)
datetime.date(2064, 2, 9)
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, 16)
datetime.date(2024, 12, 21)
datetime.date(2022, 10, 4)
datetime.date(2021, 9, 12)
datetime.date(2023, 5, 10)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 6, 19)
datetime.date(2029, 3, 2)
datetime.date(2028, 1, 3)
datetime.date(2027, 6, 14)
datetime.date(2028, 4, 26)
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, 20)
datetime.date(2026, 7, 18)
datetime.date(2026, 7, 10)
datetime.date(2026, 7, 6)
datetime.date(2026, 7, 12)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 7, 30)
datetime.date(2026, 7, 30)
datetime.date(2026, 7, 27)
datetime.date(2026, 7, 26)
datetime.date(2026, 7, 28)
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, 22)
datetime.date(2026, 6, 4)
datetime.date(2026, 3, 27)
datetime.date(2026, 2, 22)
datetime.date(2026, 4, 15)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 12, 6)
datetime.date(2026, 11, 23)
datetime.date(2026, 9, 29)
datetime.date(2026, 9, 3)
datetime.date(2026, 10, 14)
date_time(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None) datetime

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

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

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

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time()
...
datetime.datetime(2017, 10, 5, 19, 46, 18, 272495)
datetime.datetime(2012, 11, 14, 12, 2, 29, 666559)
datetime.datetime(1993, 10, 15, 13, 4, 35, 356199)
datetime.datetime(1984, 8, 23, 22, 25, 32, 553558)
datetime.datetime(1998, 12, 2, 8, 55, 11, 996014)
date_time_ad(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None, start_datetime: date | datetime | timedelta | str | int | None = None) datetime

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

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

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

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

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

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_ad()
...
datetime.datetime(1711, 6, 6, 22, 21, 13, 742348)
datetime.datetime(1536, 4, 14, 12, 8, 43, 549927)
datetime.datetime(852, 11, 22, 15, 27, 27, 400192)
datetime.datetime(525, 6, 15, 0, 32, 13, 523407)
datetime.datetime(1036, 8, 14, 17, 20, 52, 988216)
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, 23, 4, 42, 0, 236214)
datetime.datetime(2019, 4, 20, 18, 6, 46, 808743)
datetime.datetime(2009, 3, 6, 23, 36, 27, 361449)
datetime.datetime(2004, 4, 30, 16, 47, 3, 49189)
datetime.datetime(2011, 11, 25, 20, 3, 59, 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, 24, 21, 31, 17)
datetime.datetime(2026, 7, 24, 21, 31, 17)
datetime.datetime(2026, 7, 24, 21, 31, 17)
datetime.datetime(2026, 7, 24, 21, 31, 17)
datetime.datetime(2026, 7, 24, 21, 31, 17)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2021, 11, 23, 4, 42, 0, 236214)
datetime.datetime(2019, 4, 20, 18, 6, 46, 808743)
datetime.datetime(2009, 3, 6, 23, 36, 27, 361449)
datetime.datetime(2004, 4, 30, 16, 47, 3, 49189)
datetime.datetime(2011, 11, 25, 20, 3, 59, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 5, 29, 7, 31, 14, 441207)
datetime.datetime(2027, 4, 27, 17, 34, 3, 993625)
datetime.datetime(2026, 12, 25, 12, 9, 3, 345382)
datetime.datetime(2026, 10, 27, 11, 7, 24, 534973)
datetime.datetime(2027, 1, 27, 15, 13, 58, 405703)
date_time_this_century(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) datetime

Gets a datetime object for the current century.

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

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

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century()
...
datetime.datetime(2022, 6, 6, 11, 50, 46, 645875)
datetime.datetime(2020, 2, 18, 14, 17, 17, 309899)
datetime.datetime(2011, 3, 4, 8, 12, 32, 471666)
datetime.datetime(2006, 11, 16, 23, 36, 20, 585814)
datetime.datetime(2013, 7, 31, 8, 1, 44, 652117)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 7, 28, 21, 52, 12, 522811)
datetime.datetime(2082, 3, 23, 14, 3, 46, 312989)
datetime.datetime(2057, 6, 12, 22, 21, 36, 451081)
datetime.datetime(2045, 7, 29, 20, 20, 20, 318707)
datetime.datetime(2064, 2, 9, 20, 54, 47, 54083)
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, 16, 23, 48, 26, 212137)
datetime.datetime(2024, 12, 21, 17, 43, 19, 985322)
datetime.datetime(2022, 10, 5, 1, 35, 58, 87117)
datetime.datetime(2021, 9, 12, 14, 19, 15, 804910)
datetime.datetime(2023, 5, 10, 11, 20, 41, 710877)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 6, 19, 13, 52, 0, 28717)
datetime.datetime(2029, 3, 2, 23, 10, 39, 307174)
datetime.datetime(2028, 1, 4, 4, 16, 24, 797450)
datetime.datetime(2027, 6, 15, 2, 56, 58, 789155)
datetime.datetime(2028, 4, 27, 2, 39, 13, 827706)
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, 21, 4, 17, 38, 375141)
datetime.datetime(2026, 7, 19, 2, 42, 11, 22799)
datetime.datetime(2026, 7, 11, 1, 12, 24, 469795)
datetime.datetime(2026, 7, 7, 4, 29, 39, 459245)
datetime.datetime(2026, 7, 13, 5, 13, 37, 157891)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 7, 30, 21, 28, 38, 111984)
datetime.datetime(2026, 7, 30, 6, 44, 11, 50036)
datetime.datetime(2026, 7, 27, 21, 13, 11, 452302)
datetime.datetime(2026, 7, 26, 17, 39, 40, 164740)
datetime.datetime(2026, 7, 28, 12, 40, 58, 55823)
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, 23, 0, 27, 45, 58031)
datetime.datetime(2026, 6, 5, 7, 15, 25, 157741)
datetime.datetime(2026, 3, 28, 4, 10, 11, 79460)
datetime.datetime(2026, 2, 23, 1, 13, 43, 167026)
datetime.datetime(2026, 4, 15, 18, 12, 15, 760542)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 12, 7, 2, 11, 39, 451663)
datetime.datetime(2026, 11, 23, 5, 56, 41, 893384)
datetime.datetime(2026, 9, 30, 5, 33, 31, 293621)
datetime.datetime(2026, 9, 4, 8, 24, 12, 470213)
datetime.datetime(2026, 10, 14, 18, 5, 0, 852538)
day_of_month() str
Examples:

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

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

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

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

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date()
...
datetime.date(2026, 8, 18)
datetime.date(2026, 8, 15)
datetime.date(2026, 8, 6)
datetime.date(2026, 8, 1)
datetime.date(2026, 8, 8)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 5, 28)
datetime.date(2027, 4, 26)
datetime.date(2026, 12, 25)
datetime.date(2026, 10, 27)
datetime.date(2027, 1, 27)
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, 19, 5, 30, 18, 594731)
datetime.datetime(2026, 8, 16, 15, 14, 55, 54467)
datetime.datetime(2026, 8, 6, 12, 19, 59, 116942)
datetime.datetime(2026, 8, 1, 15, 56, 29, 957843)
datetime.datetime(2026, 8, 9, 5, 38, 21, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 5, 29, 7, 31, 14, 596785)
datetime.datetime(2027, 4, 27, 17, 34, 4, 235670)
datetime.datetime(2026, 12, 25, 12, 9, 3, 924810)
datetime.datetime(2026, 10, 27, 11, 7, 25, 276056)
datetime.datetime(2027, 1, 27, 15, 13, 58, 894428)
iso8601(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None, sep: str = 'T', timespec: str = 'auto') str

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

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

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

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

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

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.iso8601()
...
'2017-10-05T19:46:18.272495'
'2012-11-14T12:02:29.666559'
'1993-10-15T13:04:35.356199'
'1984-08-23T22:25:32.553558'
'1998-12-02T08:55:11.996014'
month() str
Examples:

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

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

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

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

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date()
...
datetime.date(2026, 7, 18)
datetime.date(2026, 7, 15)
datetime.date(2026, 7, 6)
datetime.date(2026, 7, 1)
datetime.date(2026, 7, 8)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 5, 27)
datetime.date(2026, 4, 25)
datetime.date(2025, 12, 23)
datetime.date(2025, 10, 25)
datetime.date(2026, 1, 25)
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, 20, 5, 30, 17, 594731)
datetime.datetime(2026, 7, 17, 15, 14, 54, 54467)
datetime.datetime(2026, 7, 7, 12, 19, 58, 116942)
datetime.datetime(2026, 7, 2, 15, 56, 28, 957843)
datetime.datetime(2026, 7, 10, 5, 38, 20, 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()
...
'19:46:18'
'12:02:29'
'13:04:35'
'22:25:32'
'08:55:11'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'07:46 PM'
'12:02 PM'
'01:04 PM'
'10:25 PM'
'08:55 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(19, 46, 18, 272495)
datetime.time(12, 2, 29, 666559)
datetime.time(13, 4, 35, 356199)
datetime.time(22, 25, 32, 553558)
datetime.time(8, 55, 11, 996014)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(20, 36, 58, 191160)
datetime.time(12, 47, 58, 302410)
datetime.time(13, 29, 49, 413890)
datetime.time(22, 41, 4, 653859)
datetime.time(9, 25, 52, 585011)
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 0x7219e6926dc0>
<generator object Provider.time_series at 0x7219e6926dc0>
<generator object Provider.time_series at 0x7219e6926dc0>
<generator object Provider.time_series at 0x7219e6926dc0>
<generator object Provider.time_series at 0x7219e6926dc0>
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()
...
1507232778.2724946
1352894549.666559
750690275.3561988
462147932.5535584
912588911.996014
year() str
Examples:

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