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'
'AM'
'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-03'
'2012-11-12'
'1993-10-14'
'1984-08-23'
'1998-12-01'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'10/03/2017'
'11/12/2012'
'10/14/1993'
'08/23/1984'
'12/01/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-10-09'
'2012-11-18'
'1993-10-17'
'1984-08-25'
'1998-12-04'
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, 20)
datetime.date(2019, 4, 17)
datetime.date(2009, 3, 3)
datetime.date(2004, 4, 27)
datetime.date(2011, 11, 22)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 7, 20)
datetime.date(2026, 7, 20)
datetime.date(2026, 7, 17)
datetime.date(2026, 7, 16)
datetime.date(2026, 7, 18)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 5, 31)
datetime.date(2026, 4, 29)
datetime.date(2025, 12, 24)
datetime.date(2025, 10, 25)
datetime.date(2026, 1, 27)
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, 22)
datetime.date(2026, 7, 22)
datetime.date(2026, 7, 22)
datetime.date(2026, 7, 22)
datetime.date(2026, 7, 22)
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, 3)
datetime.date(2012, 11, 12)
datetime.date(1993, 10, 14)
datetime.date(1984, 8, 23)
datetime.date(1998, 12, 1)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 10, 9)
datetime.date(2012, 11, 18)
datetime.date(1993, 10, 17)
datetime.date(1984, 8, 25)
datetime.date(1998, 12, 4)
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, 4)
datetime.date(1998, 6, 23)
datetime.date(1959, 5, 5)
datetime.date(1940, 8, 3)
datetime.date(1969, 11, 11)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 4, 15)
datetime.date(1991, 6, 22)
datetime.date(1984, 5, 21)
datetime.date(1980, 12, 28)
datetime.date(1986, 4, 16)
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, 4)
datetime.date(2020, 2, 16)
datetime.date(2011, 3, 3)
datetime.date(2006, 11, 16)
datetime.date(2013, 7, 29)
>>> 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, 22)
datetime.date(2057, 6, 11)
datetime.date(2045, 7, 27)
datetime.date(2064, 2, 8)
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, 14)
datetime.date(2024, 12, 19)
datetime.date(2022, 10, 3)
datetime.date(2021, 9, 11)
datetime.date(2023, 5, 8)
>>> 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, 2)
datetime.date(2027, 6, 12)
datetime.date(2028, 4, 25)
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, 18)
datetime.date(2026, 7, 16)
datetime.date(2026, 7, 9)
datetime.date(2026, 7, 6)
datetime.date(2026, 7, 11)
>>> 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, 29)
datetime.date(2026, 7, 26)
datetime.date(2026, 7, 24)
datetime.date(2026, 7, 27)
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, 20)
datetime.date(2026, 6, 3)
datetime.date(2026, 3, 26)
datetime.date(2026, 2, 22)
datetime.date(2026, 4, 14)
>>> 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, 22)
datetime.date(2026, 9, 28)
datetime.date(2026, 9, 2)
datetime.date(2026, 10, 13)
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, 3, 23, 55, 28, 806945)
datetime.datetime(2012, 11, 12, 20, 41, 3, 734109)
datetime.datetime(1993, 10, 14, 15, 14, 17, 69451)
datetime.datetime(1984, 8, 23, 8, 58, 52, 727593)
datetime.datetime(1998, 12, 1, 6, 22, 18, 389799)
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, 5, 2, 30, 24, 276802)
datetime.datetime(1536, 4, 12, 20, 47, 17, 617477)
datetime.datetime(852, 11, 21, 17, 37, 9, 113449)
datetime.datetime(525, 6, 14, 11, 5, 33, 697449)
datetime.datetime(1036, 8, 13, 14, 47, 59, 382004)
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, 21, 0, 46, 28, 236214)
datetime.datetime(2019, 4, 18, 14, 11, 14, 808743)
datetime.datetime(2009, 3, 4, 19, 40, 55, 361449)
datetime.datetime(2004, 4, 28, 12, 51, 31, 49189)
datetime.datetime(2011, 11, 23, 16, 8, 27, 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, 22, 17, 35, 45)
datetime.datetime(2026, 7, 22, 17, 35, 45)
datetime.datetime(2026, 7, 22, 17, 35, 45)
datetime.datetime(2026, 7, 22, 17, 35, 45)
datetime.datetime(2026, 7, 22, 17, 35, 45)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2021, 11, 21, 0, 46, 28, 236214)
datetime.datetime(2019, 4, 18, 14, 11, 14, 808743)
datetime.datetime(2009, 3, 4, 19, 40, 55, 361449)
datetime.datetime(2004, 4, 28, 12, 51, 31, 49189)
datetime.datetime(2011, 11, 23, 16, 8, 27, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 5, 27, 3, 35, 42, 441207)
datetime.datetime(2027, 4, 25, 13, 38, 31, 993625)
datetime.datetime(2026, 12, 23, 8, 13, 31, 345382)
datetime.datetime(2026, 10, 25, 7, 11, 52, 534973)
datetime.datetime(2027, 1, 25, 11, 18, 26, 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, 4, 15, 59, 57, 180326)
datetime.datetime(2020, 2, 16, 22, 55, 51, 377449)
datetime.datetime(2011, 3, 3, 10, 22, 14, 184918)
datetime.datetime(2006, 11, 16, 10, 9, 40, 759849)
datetime.datetime(2013, 7, 30, 5, 28, 51, 45902)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 7, 28, 13, 47, 29, 988360)
datetime.datetime(2082, 3, 23, 1, 29, 40, 245440)
datetime.datetime(2057, 6, 11, 16, 16, 22, 737829)
datetime.datetime(2045, 7, 28, 5, 51, 28, 144673)
datetime.datetime(2064, 2, 8, 19, 32, 8, 660297)
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, 15, 3, 57, 36, 746588)
datetime.datetime(2024, 12, 20, 2, 21, 54, 52871)
datetime.datetime(2022, 10, 4, 3, 45, 39, 800369)
datetime.datetime(2021, 9, 12, 0, 52, 35, 978944)
datetime.datetime(2023, 5, 9, 8, 47, 48, 104662)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 6, 19, 5, 47, 17, 494266)
datetime.datetime(2029, 3, 2, 10, 36, 33, 239625)
datetime.datetime(2028, 1, 2, 22, 11, 11, 84198)
datetime.datetime(2027, 6, 13, 12, 28, 6, 615121)
datetime.datetime(2028, 4, 26, 1, 16, 35, 433921)
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, 19, 8, 26, 48, 909592)
datetime.datetime(2026, 7, 17, 11, 20, 45, 90349)
datetime.datetime(2026, 7, 10, 3, 22, 6, 183047)
datetime.datetime(2026, 7, 6, 15, 2, 59, 633279)
datetime.datetime(2026, 7, 12, 2, 40, 43, 551676)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 7, 30, 13, 23, 55, 577533)
datetime.datetime(2026, 7, 29, 18, 10, 4, 982486)
datetime.datetime(2026, 7, 26, 15, 7, 57, 739050)
datetime.datetime(2026, 7, 25, 3, 10, 47, 990706)
datetime.datetime(2026, 7, 27, 11, 18, 19, 662037)
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, 21, 4, 36, 55, 592481)
datetime.datetime(2026, 6, 3, 15, 53, 59, 225291)
datetime.datetime(2026, 3, 27, 6, 19, 52, 792712)
datetime.datetime(2026, 2, 22, 11, 47, 3, 341060)
datetime.datetime(2026, 4, 14, 15, 39, 22, 154327)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 12, 6, 18, 6, 56, 917213)
datetime.datetime(2026, 11, 22, 17, 22, 35, 825835)
datetime.datetime(2026, 9, 28, 23, 28, 17, 580369)
datetime.datetime(2026, 9, 2, 17, 55, 20, 296179)
datetime.datetime(2026, 10, 13, 16, 42, 22, 458753)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'03'
'12'
'14'
'23'
'01'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Tuesday'
'Monday'
'Thursday'
'Thursday'
'Tuesday'
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, 16)
datetime.date(2026, 8, 13)
datetime.date(2026, 8, 4)
datetime.date(2026, 7, 30)
datetime.date(2026, 8, 6)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 5, 26)
datetime.date(2027, 4, 24)
datetime.date(2026, 12, 23)
datetime.date(2026, 10, 25)
datetime.date(2027, 1, 25)
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, 17, 1, 34, 46, 594731)
datetime.datetime(2026, 8, 14, 11, 19, 23, 54467)
datetime.datetime(2026, 8, 4, 8, 24, 27, 116942)
datetime.datetime(2026, 7, 30, 12, 0, 57, 957843)
datetime.datetime(2026, 8, 7, 1, 42, 49, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 5, 27, 3, 35, 42, 596785)
datetime.datetime(2027, 4, 25, 13, 38, 32, 235670)
datetime.datetime(2026, 12, 23, 8, 13, 31, 924810)
datetime.datetime(2026, 10, 25, 7, 11, 53, 276056)
datetime.datetime(2027, 1, 25, 11, 18, 26, 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-03T23:55:28.806945'
'2012-11-12T20:41:03.734109'
'1993-10-14T15:14:17.069451'
'1984-08-23T08:58:52.727593'
'1998-12-01T06:22:18.389799'
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, 16)
datetime.date(2026, 7, 13)
datetime.date(2026, 7, 4)
datetime.date(2026, 6, 29)
datetime.date(2026, 7, 6)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 5, 25)
datetime.date(2026, 4, 23)
datetime.date(2025, 12, 21)
datetime.date(2025, 10, 23)
datetime.date(2026, 1, 23)
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, 18, 1, 34, 45, 594731)
datetime.datetime(2026, 7, 15, 11, 19, 22, 54467)
datetime.datetime(2026, 7, 5, 8, 24, 26, 116942)
datetime.datetime(2026, 6, 30, 12, 0, 56, 957843)
datetime.datetime(2026, 7, 8, 1, 42, 48, 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()
...
'23:55:28'
'20:41:03'
'15:14:17'
'08:58:52'
'06:22:18'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'11:55 PM'
'08:41 PM'
'03:14 PM'
'08:58 AM'
'06:22 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(23, 55, 28, 806945)
datetime.time(20, 41, 3, 734109)
datetime.time(15, 14, 17, 69451)
datetime.time(8, 58, 52, 727593)
datetime.time(6, 22, 18, 389799)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(0, 46, 8, 725611)
datetime.time(21, 26, 32, 369959)
datetime.time(15, 39, 31, 127142)
datetime.time(9, 14, 24, 827894)
datetime.time(6, 52, 58, 978796)
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 0x70a76dd65930>
<generator object Provider.time_series at 0x70a76dd65930>
<generator object Provider.time_series at 0x70a76dd65930>
<generator object Provider.time_series at 0x70a76dd65930>
<generator object Provider.time_series at 0x70a76dd65930>
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()
...
1507074928.8069453
1352752863.7341087
750611657.0694509
462099532.72759265
912493338.3897991
year() str
Examples:

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