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'
'AM'
'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()
...
'2016-08-20'
'2011-11-11'
'1993-03-24'
'1984-04-19'
'1998-03-28'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'08/20/2016'
'11/11/2011'
'03/24/1993'
'04/19/1984'
'03/28/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2016-08-26'
'2011-11-16'
'1993-03-27'
'1984-04-21'
'1998-03-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(2020, 7, 23)
datetime.date(2017, 12, 18)
datetime.date(2007, 11, 4)
datetime.date(2002, 12, 29)
datetime.date(2010, 7, 25)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2025, 3, 22)
datetime.date(2025, 3, 22)
datetime.date(2025, 3, 19)
datetime.date(2025, 3, 18)
datetime.date(2025, 3, 20)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2025, 1, 31)
datetime.date(2024, 12, 30)
datetime.date(2024, 8, 26)
datetime.date(2024, 6, 27)
datetime.date(2024, 9, 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(2025, 3, 24)
datetime.date(2025, 3, 24)
datetime.date(2025, 3, 24)
datetime.date(2025, 3, 24)
datetime.date(2025, 3, 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(2016, 8, 20)
datetime.date(2011, 11, 11)
datetime.date(1993, 3, 24)
datetime.date(1984, 4, 19)
datetime.date(1998, 3, 28)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2016, 8, 26)
datetime.date(2011, 11, 16)
datetime.date(1993, 3, 27)
datetime.date(1984, 4, 21)
datetime.date(1998, 3, 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(2007, 3, 7)
datetime.date(1997, 2, 23)
datetime.date(1958, 1, 5)
datetime.date(1939, 4, 6)
datetime.date(1968, 7, 14)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1991, 12, 16)
datetime.date(1990, 2, 21)
datetime.date(1983, 1, 21)
datetime.date(1979, 8, 30)
datetime.date(1984, 12, 17)
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(2021, 4, 20)
datetime.date(2019, 2, 13)
datetime.date(2010, 8, 11)
datetime.date(2006, 7, 13)
datetime.date(2012, 11, 23)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 5, 14)
datetime.date(2081, 11, 25)
datetime.date(2056, 9, 3)
datetime.date(2044, 8, 2)
datetime.date(2063, 6, 16)
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(2024, 5, 31)
datetime.date(2023, 12, 17)
datetime.date(2022, 3, 13)
datetime.date(2021, 5, 9)
datetime.date(2022, 9, 3)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 4, 4)
datetime.date(2028, 11, 4)
datetime.date(2027, 3, 27)
datetime.date(2026, 6, 18)
datetime.date(2027, 9, 1)
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(2025, 3, 20)
datetime.date(2025, 3, 18)
datetime.date(2025, 3, 10)
datetime.date(2025, 3, 6)
datetime.date(2025, 3, 12)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2025, 3, 30)
datetime.date(2025, 3, 30)
datetime.date(2025, 3, 27)
datetime.date(2025, 3, 26)
datetime.date(2025, 3, 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(2025, 3, 11)
datetime.date(2025, 3, 4)
datetime.date(2025, 2, 4)
datetime.date(2025, 1, 22)
datetime.date(2025, 2, 11)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2025, 11, 17)
datetime.date(2025, 10, 24)
datetime.date(2025, 7, 21)
datetime.date(2025, 6, 5)
datetime.date(2025, 8, 15)
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(2016, 8, 20, 9, 43, 44, 4596)
datetime.datetime(2011, 11, 11, 5, 5, 5, 768073)
datetime.datetime(1993, 3, 24, 15, 13, 27, 643870)
datetime.datetime(1984, 4, 19, 18, 50, 42, 940748)
datetime.datetime(1998, 3, 28, 6, 27, 9, 369456)
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(1710, 4, 21, 12, 18, 39, 474449)
datetime.datetime(1535, 4, 11, 5, 11, 19, 651443)
datetime.datetime(852, 5, 1, 17, 36, 19, 687866)
datetime.datetime(525, 2, 8, 20, 57, 23, 910599)
datetime.datetime(1035, 12, 9, 14, 52, 50, 361660)
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(2020, 7, 23, 23, 26, 30, 236214)
datetime.datetime(2017, 12, 19, 12, 51, 16, 808743)
datetime.datetime(2007, 11, 5, 18, 20, 57, 361449)
datetime.datetime(2002, 12, 30, 11, 31, 33, 49189)
datetime.datetime(2010, 7, 26, 14, 48, 29, 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(2025, 3, 24, 16, 15, 47)
datetime.datetime(2025, 3, 24, 16, 15, 47)
datetime.datetime(2025, 3, 24, 16, 15, 47)
datetime.datetime(2025, 3, 24, 16, 15, 47)
datetime.datetime(2025, 3, 24, 16, 15, 47)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2020, 7, 23, 23, 26, 30, 236214)
datetime.datetime(2017, 12, 19, 12, 51, 16, 808743)
datetime.datetime(2007, 11, 5, 18, 20, 57, 361449)
datetime.datetime(2002, 12, 30, 11, 31, 33, 49189)
datetime.datetime(2010, 7, 26, 14, 48, 29, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2026, 1, 27, 2, 15, 44, 441207)
datetime.datetime(2025, 12, 26, 12, 18, 33, 993625)
datetime.datetime(2025, 8, 25, 6, 53, 33, 345382)
datetime.datetime(2025, 6, 27, 5, 51, 54, 534973)
datetime.datetime(2025, 9, 27, 9, 58, 28, 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(2021, 4, 21, 1, 48, 12, 377976)
datetime.datetime(2019, 2, 14, 7, 19, 53, 411413)
datetime.datetime(2010, 8, 11, 10, 21, 24, 759338)
datetime.datetime(2006, 7, 13, 20, 1, 30, 973005)
datetime.datetime(2012, 11, 24, 5, 33, 42, 25559)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 5, 14, 2, 39, 16, 790709)
datetime.datetime(2081, 11, 25, 15, 45, 40, 211476)
datetime.datetime(2056, 9, 3, 14, 57, 14, 163409)
datetime.datetime(2044, 8, 2, 18, 39, 39, 931518)
datetime.datetime(2063, 6, 16, 18, 7, 19, 680641)
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(2024, 5, 31, 13, 45, 51, 944239)
datetime.datetime(2023, 12, 18, 10, 45, 56, 86835)
datetime.datetime(2022, 3, 14, 3, 44, 50, 374789)
datetime.datetime(2021, 5, 9, 10, 44, 26, 192100)
datetime.datetime(2022, 9, 3, 8, 52, 39, 84319)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 4, 4, 18, 39, 4, 296615)
datetime.datetime(2028, 11, 5, 0, 52, 33, 205661)
datetime.datetime(2027, 3, 27, 20, 52, 2, 509778)
datetime.datetime(2026, 6, 19, 1, 16, 18, 401965)
datetime.datetime(2027, 9, 1, 23, 51, 46, 454264)
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(2025, 3, 20, 23, 51, 13, 469492)
datetime.datetime(2025, 3, 18, 22, 43, 2, 945952)
datetime.datetime(2025, 3, 10, 22, 59, 43, 49770)
datetime.datetime(2025, 3, 7, 3, 7, 58, 165162)
datetime.datetime(2025, 3, 13, 2, 32, 18, 727416)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2025, 3, 30, 20, 39, 33, 17633)
datetime.datetime(2025, 3, 30, 5, 27, 49, 126884)
datetime.datetime(2025, 3, 27, 18, 10, 22, 872327)
datetime.datetime(2025, 3, 26, 13, 45, 51, 458823)
datetime.datetime(2025, 3, 28, 10, 6, 46, 486298)
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(2025, 3, 11, 19, 33, 18, 299826)
datetime.datetime(2025, 3, 4, 15, 58, 51, 310380)
datetime.datetime(2025, 2, 4, 18, 31, 28, 740213)
datetime.datetime(2025, 1, 22, 9, 45, 32, 191455)
datetime.datetime(2025, 2, 12, 6, 30, 12, 747064)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2025, 11, 18, 1, 50, 36, 209868)
datetime.datetime(2025, 10, 24, 15, 57, 45, 740745)
datetime.datetime(2025, 7, 21, 9, 56, 43, 632868)
datetime.datetime(2025, 6, 5, 18, 36, 53, 445784)
datetime.datetime(2025, 8, 16, 0, 31, 33, 866016)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'20'
'11'
'24'
'19'
'28'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Saturday'
'Friday'
'Wednesday'
'Thursday'
'Saturday'
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(2025, 4, 18)
datetime.date(2025, 4, 15)
datetime.date(2025, 4, 6)
datetime.date(2025, 4, 1)
datetime.date(2025, 4, 8)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2026, 1, 26)
datetime.date(2025, 12, 25)
datetime.date(2025, 8, 25)
datetime.date(2025, 6, 27)
datetime.date(2025, 9, 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(2025, 4, 19, 0, 14, 48, 594731)
datetime.datetime(2025, 4, 16, 9, 59, 25, 54467)
datetime.datetime(2025, 4, 6, 7, 4, 29, 116942)
datetime.datetime(2025, 4, 1, 10, 40, 59, 957843)
datetime.datetime(2025, 4, 9, 0, 22, 51, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2026, 1, 27, 2, 15, 44, 596785)
datetime.datetime(2025, 12, 26, 12, 18, 34, 235670)
datetime.datetime(2025, 8, 25, 6, 53, 33, 924810)
datetime.datetime(2025, 6, 27, 5, 51, 55, 276056)
datetime.datetime(2025, 9, 27, 9, 58, 28, 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()
...
'2016-08-20T09:43:44.004596'
'2011-11-11T05:05:05.768073'
'1993-03-24T15:13:27.643870'
'1984-04-19T18:50:42.940748'
'1998-03-28T06:27:09.369456'
month() str
Examples:

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

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'August'
'November'
'March'
'April'
'March'
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(2025, 3, 18)
datetime.date(2025, 3, 15)
datetime.date(2025, 3, 6)
datetime.date(2025, 3, 1)
datetime.date(2025, 3, 8)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2025, 1, 25)
datetime.date(2024, 12, 24)
datetime.date(2024, 8, 23)
datetime.date(2024, 6, 25)
datetime.date(2024, 9, 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(2025, 3, 20, 0, 14, 47, 594731)
datetime.datetime(2025, 3, 17, 9, 59, 24, 54467)
datetime.datetime(2025, 3, 7, 7, 4, 28, 116942)
datetime.datetime(2025, 3, 2, 10, 40, 58, 957843)
datetime.datetime(2025, 3, 10, 0, 22, 50, 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()
...
'09:43:44'
'05:05:05'
'15:13:27'
'18:50:42'
'06:27:09'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'09:43 AM'
'05:05 AM'
'03:13 PM'
'06:50 PM'
'06:27 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(9, 43, 44, 4596)
datetime.time(5, 5, 5, 768073)
datetime.time(15, 13, 27, 643870)
datetime.time(18, 50, 42, 940748)
datetime.time(6, 27, 9, 369456)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(10, 34, 23, 923262)
datetime.time(5, 50, 34, 403924)
datetime.time(15, 38, 41, 701561)
datetime.time(19, 6, 15, 41049)
datetime.time(6, 57, 49, 958453)
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 0x789153b506d0>
<generator object Provider.time_series at 0x789153b506d0>
<generator object Provider.time_series at 0x789153b506d0>
<generator object Provider.time_series at 0x789153b506d0>
<generator object Provider.time_series at 0x789153b506d0>
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()
...
1471686224.004596
1320987905.7680728
732986007.6438704
451248642.94074845
891066429.3694558
year() str
Examples:

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