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'
'PM'
'AM'
'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()
...
'2018-01-07'
'2013-02-06'
'1993-12-01'
'1984-09-21'
'1999-01-28'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'01/07/2018'
'02/06/2013'
'12/01/1993'
'09/21/1984'
'01/28/1999'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2018-01-13'
'2013-02-11'
'1993-12-04'
'1984-09-23'
'1999-01-31'
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(2022, 3, 13)
datetime.date(2019, 8, 8)
datetime.date(2009, 6, 24)
datetime.date(2004, 8, 18)
datetime.date(2012, 3, 14)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 11, 10)
datetime.date(2026, 11, 10)
datetime.date(2026, 11, 7)
datetime.date(2026, 11, 6)
datetime.date(2026, 11, 8)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 9, 21)
datetime.date(2026, 8, 20)
datetime.date(2026, 4, 16)
datetime.date(2026, 2, 15)
datetime.date(2026, 5, 20)
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, 11, 12)
datetime.date(2026, 11, 12)
datetime.date(2026, 11, 12)
datetime.date(2026, 11, 12)
datetime.date(2026, 11, 12)
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(2018, 1, 7)
datetime.date(2013, 2, 6)
datetime.date(1993, 12, 1)
datetime.date(1984, 9, 21)
datetime.date(1999, 1, 28)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2018, 1, 13)
datetime.date(2013, 2, 11)
datetime.date(1993, 12, 4)
datetime.date(1984, 9, 23)
datetime.date(1999, 1, 31)
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, 10, 25)
datetime.date(1998, 10, 14)
datetime.date(1959, 8, 26)
datetime.date(1940, 11, 24)
datetime.date(1970, 3, 4)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 8, 6)
datetime.date(1991, 10, 13)
datetime.date(1984, 9, 11)
datetime.date(1981, 4, 20)
datetime.date(1986, 8, 7)
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, 9, 7)
datetime.date(2020, 5, 12)
datetime.date(2011, 4, 19)
datetime.date(2006, 12, 15)
datetime.date(2013, 9, 25)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 8, 15)
datetime.date(2082, 4, 19)
datetime.date(2057, 8, 15)
datetime.date(2045, 10, 19)
datetime.date(2064, 4, 3)
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, 10, 17)
datetime.date(2025, 3, 15)
datetime.date(2022, 11, 20)
datetime.date(2021, 10, 11)
datetime.date(2023, 7, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 7, 6)
datetime.date(2029, 3, 29)
datetime.date(2028, 3, 7)
datetime.date(2027, 9, 4)
datetime.date(2028, 6, 19)
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, 11, 10)
datetime.date(2026, 11, 9)
datetime.date(2026, 11, 5)
datetime.date(2026, 11, 3)
datetime.date(2026, 11, 6)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 11, 28)
datetime.date(2026, 11, 26)
datetime.date(2026, 11, 19)
datetime.date(2026, 11, 16)
datetime.date(2026, 11, 21)
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, 9, 23)
datetime.date(2026, 8, 27)
datetime.date(2026, 5, 13)
datetime.date(2026, 3, 23)
datetime.date(2026, 6, 11)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 12, 24)
datetime.date(2026, 12, 19)
datetime.date(2026, 12, 3)
datetime.date(2026, 11, 24)
datetime.date(2026, 12, 7)
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(2018, 1, 7, 10, 24, 45, 387697)
datetime.datetime(2013, 2, 6, 12, 37, 48, 14052)
datetime.datetime(1993, 12, 1, 4, 2, 7, 200831)
datetime.datetime(1984, 9, 21, 15, 17, 27, 803451)
datetime.datetime(1999, 1, 28, 1, 12, 2, 239546)
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, 9, 8, 12, 59, 40, 857552)
datetime.datetime(1536, 7, 7, 12, 44, 1, 897423)
datetime.datetime(853, 1, 8, 6, 24, 59, 244827)
datetime.datetime(525, 7, 13, 17, 24, 8, 773300)
datetime.datetime(1036, 10, 10, 9, 37, 43, 231750)
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, 3, 14, 1, 16, 1, 236214)
datetime.datetime(2019, 8, 9, 14, 40, 47, 808743)
datetime.datetime(2009, 6, 25, 20, 10, 28, 361449)
datetime.datetime(2004, 8, 19, 13, 21, 4, 49189)
datetime.datetime(2012, 3, 15, 16, 38, 0, 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, 11, 12, 18, 5, 18)
datetime.datetime(2026, 11, 12, 18, 5, 18)
datetime.datetime(2026, 11, 12, 18, 5, 18)
datetime.datetime(2026, 11, 12, 18, 5, 18)
datetime.datetime(2026, 11, 12, 18, 5, 18)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2022, 3, 14, 1, 16, 1, 236214)
datetime.datetime(2019, 8, 9, 14, 40, 47, 808743)
datetime.datetime(2009, 6, 25, 20, 10, 28, 361449)
datetime.datetime(2004, 8, 19, 13, 21, 4, 49189)
datetime.datetime(2012, 3, 15, 16, 38, 0, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 9, 17, 4, 5, 15, 441207)
datetime.datetime(2027, 8, 16, 14, 8, 4, 993625)
datetime.datetime(2027, 4, 15, 8, 43, 4, 345382)
datetime.datetime(2027, 2, 15, 7, 41, 25, 534973)
datetime.datetime(2027, 5, 18, 11, 47, 59, 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, 9, 8, 2, 29, 13, 761077)
datetime.datetime(2020, 5, 12, 14, 52, 35, 657392)
datetime.datetime(2011, 4, 19, 23, 10, 4, 316299)
datetime.datetime(2006, 12, 15, 16, 28, 15, 835707)
datetime.datetime(2013, 9, 26, 0, 18, 34, 895649)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 8, 15, 3, 47, 46, 407608)
datetime.datetime(2082, 4, 19, 10, 2, 28, 965497)
datetime.datetime(2057, 8, 16, 3, 58, 5, 606448)
datetime.datetime(2045, 10, 20, 0, 2, 26, 68815)
datetime.datetime(2064, 4, 4, 1, 11, 57, 810551)
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, 10, 18, 14, 26, 53, 327340)
datetime.datetime(2025, 3, 15, 18, 18, 38, 332814)
datetime.datetime(2022, 11, 20, 16, 33, 29, 931750)
datetime.datetime(2021, 10, 11, 7, 11, 11, 54803)
datetime.datetime(2023, 7, 6, 3, 37, 31, 954409)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 7, 6, 19, 47, 33, 913514)
datetime.datetime(2029, 3, 29, 19, 9, 21, 959682)
datetime.datetime(2028, 3, 8, 9, 52, 53, 952817)
datetime.datetime(2027, 9, 5, 6, 39, 4, 539262)
datetime.datetime(2028, 6, 20, 6, 56, 24, 584174)
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, 11, 10, 22, 12, 5, 589817)
datetime.datetime(2026, 11, 9, 21, 48, 36, 339365)
datetime.datetime(2026, 11, 5, 22, 38, 18, 10622)
datetime.datetime(2026, 11, 4, 1, 2, 14, 620424)
datetime.datetime(2026, 11, 7, 0, 13, 28, 682495)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 11, 28, 3, 52, 13, 849336)
datetime.datetime(2026, 11, 26, 14, 0, 19, 473056)
datetime.datetime(2026, 11, 20, 10, 15, 41, 526891)
datetime.datetime(2026, 11, 17, 11, 28, 15, 596335)
datetime.datetime(2026, 11, 22, 1, 58, 53, 395293)
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, 9, 24, 15, 6, 12, 173233)
datetime.datetime(2026, 8, 28, 7, 50, 43, 505234)
datetime.datetime(2026, 5, 13, 19, 7, 42, 924093)
datetime.datetime(2026, 3, 23, 18, 5, 38, 416919)
datetime.datetime(2026, 6, 11, 10, 29, 6, 4074)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 12, 24, 8, 7, 13, 336461)
datetime.datetime(2026, 12, 20, 1, 55, 24, 545892)
datetime.datetime(2026, 12, 3, 11, 10, 0, 448989)
datetime.datetime(2026, 11, 25, 12, 6, 18, 220320)
datetime.datetime(2026, 12, 7, 22, 22, 11, 609006)
day_of_month() → str
Examples:

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

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

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

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

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date()
...
datetime.date(2026, 12, 7)
datetime.date(2026, 12, 4)
datetime.date(2026, 11, 25)
datetime.date(2026, 11, 20)
datetime.date(2026, 11, 27)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 9, 16)
datetime.date(2027, 8, 15)
datetime.date(2027, 4, 15)
datetime.date(2027, 2, 15)
datetime.date(2027, 5, 18)
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, 12, 8, 2, 4, 19, 594731)
datetime.datetime(2026, 12, 5, 11, 48, 56, 54467)
datetime.datetime(2026, 11, 25, 8, 54, 0, 116942)
datetime.datetime(2026, 11, 20, 12, 30, 30, 957843)
datetime.datetime(2026, 11, 28, 2, 12, 22, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 9, 17, 4, 5, 15, 596785)
datetime.datetime(2027, 8, 16, 14, 8, 5, 235670)
datetime.datetime(2027, 4, 15, 8, 43, 4, 924810)
datetime.datetime(2027, 2, 15, 7, 41, 26, 276056)
datetime.datetime(2027, 5, 18, 11, 47, 59, 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()
...
'2018-01-07T10:24:45.387697'
'2013-02-06T12:37:48.014052'
'1993-12-01T04:02:07.200831'
'1984-09-21T15:17:27.803451'
'1999-01-28T01:12:02.239546'
month() → str
Examples:

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

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'January'
'February'
'December'
'September'
'January'
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, 11, 6)
datetime.date(2026, 11, 3)
datetime.date(2026, 10, 25)
datetime.date(2026, 10, 20)
datetime.date(2026, 10, 27)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 9, 15)
datetime.date(2026, 8, 14)
datetime.date(2026, 4, 13)
datetime.date(2026, 2, 13)
datetime.date(2026, 5, 16)
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, 11, 8, 2, 4, 18, 594731)
datetime.datetime(2026, 11, 5, 11, 48, 55, 54467)
datetime.datetime(2026, 10, 26, 8, 53, 59, 116942)
datetime.datetime(2026, 10, 21, 12, 30, 29, 957843)
datetime.datetime(2026, 10, 29, 2, 12, 21, 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:24:45'
'12:37:48'
'04:02:07'
'15:17:27'
'01:12:02'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'10:24 AM'
'12:37 PM'
'04:02 AM'
'03:17 PM'
'01:12 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(10, 24, 45, 387697)
datetime.time(12, 37, 48, 14052)
datetime.time(4, 2, 7, 200831)
datetime.time(15, 17, 27, 803451)
datetime.time(1, 12, 2, 239546)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(11, 15, 25, 306363)
datetime.time(13, 23, 16, 649902)
datetime.time(4, 27, 21, 258522)
datetime.time(15, 32, 59, 903752)
datetime.time(1, 42, 42, 828543)
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. Must be greater than zero for a non-empty interval. :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 0x7f172de4e8a0>
<generator object Provider.time_series at 0x7f172de4e8a0>
<generator object Provider.time_series at 0x7f172de4e8a0>
<generator object Provider.time_series at 0x7f172de4e8a0>
<generator object Provider.time_series at 0x7f172de4e8a0>
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()
...
1515320685.3876975
1360154268.0140517
754718527.2008314
464627847.8034512
917485922.2395462
year() → str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.year()
...
'2018'
'2013'
'1993'
'1984'
'1999'