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'
'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-12-09'
'2013-01-11'
'1993-11-16'
'1984-09-12'
'1999-01-10'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'12/09/2017'
'01/11/2013'
'11/16/1993'
'09/12/1984'
'01/10/1999'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-12-15'
'2013-01-17'
'1993-11-19'
'1984-09-14'
'1999-01-14'
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, 2, 7)
datetime.date(2019, 7, 5)
datetime.date(2009, 5, 21)
datetime.date(2004, 7, 15)
datetime.date(2012, 2, 9)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 10, 7)
datetime.date(2026, 10, 7)
datetime.date(2026, 10, 4)
datetime.date(2026, 10, 3)
datetime.date(2026, 10, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 8, 18)
datetime.date(2026, 7, 17)
datetime.date(2026, 3, 13)
datetime.date(2026, 1, 12)
datetime.date(2026, 4, 16)
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, 10, 9)
datetime.date(2026, 10, 9)
datetime.date(2026, 10, 9)
datetime.date(2026, 10, 9)
datetime.date(2026, 10, 9)
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, 12, 9)
datetime.date(2013, 1, 11)
datetime.date(1993, 11, 16)
datetime.date(1984, 9, 12)
datetime.date(1999, 1, 10)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 12, 15)
datetime.date(2013, 1, 17)
datetime.date(1993, 11, 19)
datetime.date(1984, 9, 14)
datetime.date(1999, 1, 14)
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, 9, 21)
datetime.date(1998, 9, 10)
datetime.date(1959, 7, 23)
datetime.date(1940, 10, 21)
datetime.date(1970, 1, 29)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 7, 3)
datetime.date(1991, 9, 9)
datetime.date(1984, 8, 8)
datetime.date(1981, 3, 17)
datetime.date(1986, 7, 4)
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, 8, 9)
datetime.date(2020, 4, 16)
datetime.date(2011, 4, 5)
datetime.date(2006, 12, 6)
datetime.date(2013, 9, 8)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 8, 9)
datetime.date(2082, 4, 11)
datetime.date(2057, 7, 27)
datetime.date(2045, 9, 24)
datetime.date(2064, 3, 18)
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, 9, 19)
datetime.date(2025, 2, 17)
datetime.date(2022, 11, 6)
datetime.date(2021, 10, 2)
datetime.date(2023, 6, 18)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 7, 1)
datetime.date(2029, 3, 21)
datetime.date(2028, 2, 17)
datetime.date(2027, 8, 10)
datetime.date(2028, 6, 3)
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, 10, 7)
datetime.date(2026, 10, 7)
datetime.date(2026, 10, 4)
datetime.date(2026, 10, 3)
datetime.date(2026, 10, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 10, 28)
datetime.date(2026, 10, 26)
datetime.date(2026, 10, 18)
datetime.date(2026, 10, 14)
datetime.date(2026, 10, 20)
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, 8, 26)
datetime.date(2026, 8, 1)
datetime.date(2026, 4, 29)
datetime.date(2026, 3, 14)
datetime.date(2026, 5, 24)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 12, 18)
datetime.date(2026, 12, 11)
datetime.date(2026, 11, 13)
datetime.date(2026, 10, 30)
datetime.date(2026, 11, 20)
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, 12, 9, 19, 10, 18, 27023)
datetime.datetime(2013, 1, 11, 19, 45, 41, 198649)
datetime.datetime(1993, 11, 16, 21, 44, 56, 629013)
datetime.datetime(1984, 9, 12, 20, 34, 8, 911352)
datetime.datetime(1999, 1, 10, 17, 5, 40, 989782)
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, 8, 10, 21, 45, 13, 496880)
datetime.datetime(1536, 6, 11, 19, 51, 55, 82016)
datetime.datetime(852, 12, 25, 0, 7, 48, 673004)
datetime.datetime(525, 7, 4, 22, 40, 49, 881203)
datetime.datetime(1036, 9, 23, 1, 31, 21, 981983)
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, 2, 8, 3, 24, 26, 236214)
datetime.datetime(2019, 7, 6, 16, 49, 12, 808743)
datetime.datetime(2009, 5, 22, 22, 18, 53, 361449)
datetime.datetime(2004, 7, 16, 15, 29, 29, 49189)
datetime.datetime(2012, 2, 10, 18, 46, 25, 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, 10, 9, 20, 13, 43)
datetime.datetime(2026, 10, 9, 20, 13, 43)
datetime.datetime(2026, 10, 9, 20, 13, 43)
datetime.datetime(2026, 10, 9, 20, 13, 43)
datetime.datetime(2026, 10, 9, 20, 13, 43)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2022, 2, 8, 3, 24, 26, 236214)
datetime.datetime(2019, 7, 6, 16, 49, 12, 808743)
datetime.datetime(2009, 5, 22, 22, 18, 53, 361449)
datetime.datetime(2004, 7, 16, 15, 29, 29, 49189)
datetime.datetime(2012, 2, 10, 18, 46, 25, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 8, 14, 6, 13, 40, 441207)
datetime.datetime(2027, 7, 13, 16, 16, 29, 993625)
datetime.datetime(2027, 3, 12, 10, 51, 29, 345382)
datetime.datetime(2027, 1, 12, 9, 49, 50, 534973)
datetime.datetime(2027, 4, 14, 13, 56, 24, 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, 8, 10, 11, 14, 46, 400403)
datetime.datetime(2020, 4, 16, 22, 0, 28, 841989)
datetime.datetime(2011, 4, 5, 16, 52, 53, 744481)
datetime.datetime(2006, 12, 6, 21, 44, 56, 943608)
datetime.datetime(2013, 9, 8, 16, 12, 13, 645885)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 8, 9, 21, 10, 38, 768282)
datetime.datetime(2082, 4, 11, 5, 3, 0, 780900)
datetime.datetime(2057, 7, 27, 12, 23, 41, 178267)
datetime.datetime(2045, 9, 24, 20, 54, 9, 960915)
datetime.datetime(2064, 3, 18, 11, 26, 44, 60315)
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, 9, 19, 23, 12, 25, 966666)
datetime.datetime(2025, 2, 18, 1, 26, 31, 517411)
datetime.datetime(2022, 11, 6, 10, 16, 19, 359931)
datetime.datetime(2021, 10, 2, 12, 27, 52, 162703)
datetime.datetime(2023, 6, 18, 19, 31, 10, 704645)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 7, 1, 13, 10, 26, 274188)
datetime.datetime(2029, 3, 21, 14, 9, 53, 775084)
datetime.datetime(2028, 2, 17, 18, 18, 29, 524636)
datetime.datetime(2027, 8, 11, 3, 30, 48, 431362)
datetime.datetime(2028, 6, 3, 17, 11, 10, 833938)
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, 10, 8, 11, 12, 37, 716268)
datetime.datetime(2026, 10, 7, 16, 51, 34, 596798)
datetime.datetime(2026, 10, 4, 17, 15, 26, 360901)
datetime.datetime(2026, 10, 3, 6, 56, 58, 352309)
datetime.datetime(2026, 10, 5, 12, 30, 25, 646444)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 10, 28, 13, 16, 4, 770857)
datetime.datetime(2026, 10, 26, 15, 17, 13, 476038)
datetime.datetime(2026, 10, 19, 3, 52, 35, 561196)
datetime.datetime(2026, 10, 15, 13, 54, 47, 271676)
datetime.datetime(2026, 10, 21, 4, 6, 35, 567270)
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, 8, 26, 23, 51, 44, 812559)
datetime.datetime(2026, 8, 2, 14, 58, 36, 689831)
datetime.datetime(2026, 4, 29, 12, 50, 32, 352274)
datetime.datetime(2026, 3, 14, 23, 22, 19, 524819)
datetime.datetime(2026, 5, 25, 2, 22, 44, 754310)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 12, 19, 1, 30, 5, 697134)
datetime.datetime(2026, 12, 11, 20, 55, 56, 361294)
datetime.datetime(2026, 11, 13, 19, 35, 36, 20807)
datetime.datetime(2026, 10, 31, 8, 58, 2, 112420)
datetime.datetime(2026, 11, 21, 8, 36, 57, 858771)
day_of_month() → str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'09'
'11'
'16'
'12'
'10'
day_of_week() → str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Saturday'
'Friday'
'Tuesday'
'Wednesday'
'Sunday'
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, 11, 3)
datetime.date(2026, 10, 31)
datetime.date(2026, 10, 22)
datetime.date(2026, 10, 17)
datetime.date(2026, 10, 24)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 8, 13)
datetime.date(2027, 7, 12)
datetime.date(2027, 3, 12)
datetime.date(2027, 1, 12)
datetime.date(2027, 4, 14)
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, 11, 4, 4, 12, 44, 594731)
datetime.datetime(2026, 11, 1, 13, 57, 21, 54467)
datetime.datetime(2026, 10, 22, 11, 2, 25, 116942)
datetime.datetime(2026, 10, 17, 14, 38, 55, 957843)
datetime.datetime(2026, 10, 25, 4, 20, 47, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 8, 14, 6, 13, 40, 596785)
datetime.datetime(2027, 7, 13, 16, 16, 30, 235670)
datetime.datetime(2027, 3, 12, 10, 51, 29, 924810)
datetime.datetime(2027, 1, 12, 9, 49, 51, 276056)
datetime.datetime(2027, 4, 14, 13, 56, 24, 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-12-09T19:10:18.027023'
'2013-01-11T19:45:41.198649'
'1993-11-16T21:44:56.629013'
'1984-09-12T20:34:08.911352'
'1999-01-10T17:05:40.989782'
month() → str
Examples:

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

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'December'
'January'
'November'
'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, 10, 3)
datetime.date(2026, 9, 30)
datetime.date(2026, 9, 21)
datetime.date(2026, 9, 16)
datetime.date(2026, 9, 23)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 8, 12)
datetime.date(2026, 7, 11)
datetime.date(2026, 3, 10)
datetime.date(2026, 1, 10)
datetime.date(2026, 4, 12)
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, 10, 5, 4, 12, 43, 594731)
datetime.datetime(2026, 10, 2, 13, 57, 20, 54467)
datetime.datetime(2026, 9, 22, 11, 2, 24, 116942)
datetime.datetime(2026, 9, 17, 14, 38, 54, 957843)
datetime.datetime(2026, 9, 25, 4, 20, 46, 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:10:18'
'19:45:41'
'21:44:56'
'20:34:08'
'17:05:40'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'07:10 PM'
'07:45 PM'
'09:44 PM'
'08:34 PM'
'05:05 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(19, 10, 18, 871445)
datetime.time(19, 45, 41, 956603)
datetime.time(21, 44, 57, 49585)
datetime.time(20, 34, 9, 170268)
datetime.time(17, 5, 41, 501057)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(20, 0, 58, 790111)
datetime.time(20, 31, 10, 592454)
datetime.time(22, 10, 11, 107276)
datetime.time(20, 49, 41, 270569)
datetime.time(17, 36, 22, 90054)
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 0x7813dc452b90>
<generator object Provider.time_series at 0x7813dc452b90>
<generator object Provider.time_series at 0x7813dc452b90>
<generator object Provider.time_series at 0x7813dc452b90>
<generator object Provider.time_series at 0x7813dc452b90>
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()
...
1512846618.8714452
1357933541.9566033
753486297.0495846
463869249.17026836
915987941.5010566
year() → str
Examples:

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