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'
'AM'
'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-04-09'
'2012-06-06'
'1993-07-18'
'1984-06-30'
'1998-08-16'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'04/09/2017'
'06/06/2012'
'07/18/1993'
'06/30/1984'
'08/16/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-04-15'
'2012-06-12'
'1993-07-21'
'1984-07-01'
'1998-08-19'
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, 4, 25)
datetime.date(2018, 9, 20)
datetime.date(2008, 8, 6)
datetime.date(2003, 10, 1)
datetime.date(2011, 4, 27)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2025, 12, 23)
datetime.date(2025, 12, 23)
datetime.date(2025, 12, 20)
datetime.date(2025, 12, 19)
datetime.date(2025, 12, 21)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2025, 11, 3)
datetime.date(2025, 10, 2)
datetime.date(2025, 5, 29)
datetime.date(2025, 3, 30)
datetime.date(2025, 7, 2)
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, 12, 25)
datetime.date(2025, 12, 25)
datetime.date(2025, 12, 25)
datetime.date(2025, 12, 25)
datetime.date(2025, 12, 25)
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, 4, 9)
datetime.date(2012, 6, 6)
datetime.date(1993, 7, 18)
datetime.date(1984, 6, 30)
datetime.date(1998, 8, 16)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 4, 15)
datetime.date(2012, 6, 12)
datetime.date(1993, 7, 21)
datetime.date(1984, 7, 1)
datetime.date(1998, 8, 19)
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, 12, 8)
datetime.date(1997, 11, 26)
datetime.date(1958, 10, 8)
datetime.date(1940, 1, 7)
datetime.date(1969, 4, 16)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1992, 9, 17)
datetime.date(1990, 11, 24)
datetime.date(1983, 10, 24)
datetime.date(1980, 6, 1)
datetime.date(1985, 9, 19)
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, 12, 9)
datetime.date(2019, 9, 10)
datetime.date(2010, 12, 5)
datetime.date(2006, 9, 23)
datetime.date(2013, 4, 13)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 6, 25)
datetime.date(2082, 1, 31)
datetime.date(2057, 2, 10)
datetime.date(2045, 2, 22)
datetime.date(2063, 10, 29)
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, 1, 19)
datetime.date(2024, 7, 14)
datetime.date(2022, 7, 7)
datetime.date(2021, 7, 19)
datetime.date(2023, 1, 22)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 5, 17)
datetime.date(2029, 1, 10)
datetime.date(2027, 9, 3)
datetime.date(2027, 1, 9)
datetime.date(2028, 1, 14)
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, 12, 21)
datetime.date(2025, 12, 19)
datetime.date(2025, 12, 11)
datetime.date(2025, 12, 7)
datetime.date(2025, 12, 13)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2025, 12, 30)
datetime.date(2025, 12, 30)
datetime.date(2025, 12, 27)
datetime.date(2025, 12, 26)
datetime.date(2025, 12, 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, 10, 30)
datetime.date(2025, 9, 29)
datetime.date(2025, 5, 31)
datetime.date(2025, 4, 3)
datetime.date(2025, 7, 3)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2025, 12, 30)
datetime.date(2025, 12, 30)
datetime.date(2025, 12, 27)
datetime.date(2025, 12, 26)
datetime.date(2025, 12, 28)
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, 4, 9, 21, 51, 20, 394793)
datetime.datetime(2012, 6, 6, 21, 48, 56, 316353)
datetime.datetime(1993, 7, 18, 10, 27, 16, 482061)
datetime.datetime(1984, 6, 30, 1, 49, 28, 345684)
datetime.datetime(1998, 8, 16, 1, 4, 9, 458377)
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, 12, 10, 0, 26, 15, 864647)
datetime.datetime(1535, 11, 5, 21, 55, 10, 199722)
datetime.datetime(852, 8, 25, 12, 50, 8, 526054)
datetime.datetime(525, 4, 21, 3, 56, 9, 315536)
datetime.datetime(1036, 4, 28, 9, 29, 50, 450581)
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, 4, 25, 7, 39, 48, 236214)
datetime.datetime(2018, 9, 20, 21, 4, 34, 808743)
datetime.datetime(2008, 8, 7, 2, 34, 15, 361449)
datetime.datetime(2003, 10, 1, 19, 44, 51, 49189)
datetime.datetime(2011, 4, 27, 23, 1, 47, 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, 12, 25, 0, 29, 5)
datetime.datetime(2025, 12, 25, 0, 29, 5)
datetime.datetime(2025, 12, 25, 0, 29, 5)
datetime.datetime(2025, 12, 25, 0, 29, 5)
datetime.datetime(2025, 12, 25, 0, 29, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2021, 4, 25, 7, 39, 48, 236214)
datetime.datetime(2018, 9, 20, 21, 4, 34, 808743)
datetime.datetime(2008, 8, 7, 2, 34, 15, 361449)
datetime.datetime(2003, 10, 1, 19, 44, 51, 49189)
datetime.datetime(2011, 4, 27, 23, 1, 47, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2026, 10, 29, 10, 29, 2, 441207)
datetime.datetime(2026, 9, 27, 20, 31, 51, 993625)
datetime.datetime(2026, 5, 27, 15, 6, 51, 345382)
datetime.datetime(2026, 3, 29, 14, 5, 12, 534973)
datetime.datetime(2026, 6, 29, 18, 11, 46, 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, 12, 9, 13, 55, 48, 768173)
datetime.datetime(2019, 9, 11, 0, 3, 43, 959693)
datetime.datetime(2010, 12, 5, 5, 35, 13, 597528)
datetime.datetime(2006, 9, 23, 3, 0, 16, 377940)
datetime.datetime(2013, 4, 14, 0, 10, 42, 114480)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 6, 25, 22, 44, 58, 400513)
datetime.datetime(2082, 1, 31, 7, 15, 7, 663196)
datetime.datetime(2057, 2, 10, 3, 56, 43, 325219)
datetime.datetime(2045, 2, 22, 19, 54, 12, 526582)
datetime.datetime(2063, 10, 29, 7, 43, 37, 591720)
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, 1, 19, 1, 53, 28, 334435)
datetime.datetime(2024, 7, 14, 3, 29, 46, 635115)
datetime.datetime(2022, 7, 7, 22, 58, 39, 212979)
datetime.datetime(2021, 7, 19, 17, 43, 11, 597036)
datetime.datetime(2023, 1, 22, 3, 29, 39, 173240)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 5, 17, 14, 44, 45, 906419)
datetime.datetime(2029, 1, 10, 16, 22, 0, 657381)
datetime.datetime(2027, 9, 3, 9, 51, 31, 671588)
datetime.datetime(2027, 1, 9, 2, 30, 50, 997029)
datetime.datetime(2028, 1, 14, 13, 28, 4, 365343)
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, 12, 21, 6, 47, 46, 667453)
datetime.datetime(2025, 12, 19, 4, 56, 56, 880370)
datetime.datetime(2025, 12, 11, 2, 27, 11, 127419)
datetime.datetime(2025, 12, 7, 5, 15, 41, 583137)
datetime.datetime(2025, 12, 13, 6, 44, 31, 436619)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2025, 12, 30, 21, 56, 17, 819671)
datetime.datetime(2025, 12, 30, 7, 27, 13, 192465)
datetime.datetime(2025, 12, 27, 22, 56, 12, 794678)
datetime.datetime(2025, 12, 26, 19, 51, 26, 40848)
datetime.datetime(2025, 12, 28, 14, 7, 51, 777095)
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, 10, 30, 7, 40, 54, 690022)
datetime.datetime(2025, 9, 29, 8, 42, 41, 858660)
datetime.datetime(2025, 5, 31, 13, 45, 17, 578403)
datetime.datetime(2025, 4, 3, 16, 44, 17, 596391)
datetime.datetime(2025, 7, 3, 1, 7, 12, 835985)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2025, 12, 30, 21, 56, 17, 819671)
datetime.datetime(2025, 12, 30, 7, 27, 13, 192465)
datetime.datetime(2025, 12, 27, 22, 56, 12, 794678)
datetime.datetime(2025, 12, 26, 19, 51, 26, 40848)
datetime.datetime(2025, 12, 28, 14, 7, 51, 777095)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'09'
'06'
'18'
'30'
'16'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Sunday'
'Wednesday'
'Sunday'
'Saturday'
'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, 1, 19)
datetime.date(2026, 1, 16)
datetime.date(2026, 1, 7)
datetime.date(2026, 1, 2)
datetime.date(2026, 1, 9)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2026, 10, 29)
datetime.date(2026, 9, 27)
datetime.date(2026, 5, 28)
datetime.date(2026, 3, 30)
datetime.date(2026, 6, 30)
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, 1, 19, 8, 28, 6, 594731)
datetime.datetime(2026, 1, 16, 18, 12, 43, 54467)
datetime.datetime(2026, 1, 6, 15, 17, 47, 116942)
datetime.datetime(2026, 1, 1, 18, 54, 17, 957843)
datetime.datetime(2026, 1, 9, 8, 36, 9, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2026, 10, 29, 10, 29, 2, 596785)
datetime.datetime(2026, 9, 27, 20, 31, 52, 235670)
datetime.datetime(2026, 5, 27, 15, 6, 51, 924810)
datetime.datetime(2026, 3, 29, 14, 5, 13, 276056)
datetime.datetime(2026, 6, 29, 18, 11, 46, 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-04-09T21:51:20.394793'
'2012-06-06T21:48:56.316353'
'1993-07-18T10:27:16.482061'
'1984-06-30T01:49:28.345684'
'1998-08-16T01:04:09.458377'
month() str
Examples:

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

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'April'
'June'
'July'
'June'
'August'
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, 12, 19)
datetime.date(2025, 12, 16)
datetime.date(2025, 12, 7)
datetime.date(2025, 12, 2)
datetime.date(2025, 12, 9)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2025, 10, 28)
datetime.date(2025, 9, 26)
datetime.date(2025, 5, 26)
datetime.date(2025, 3, 28)
datetime.date(2025, 6, 28)
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, 12, 20, 8, 28, 5, 594731)
datetime.datetime(2025, 12, 17, 18, 12, 42, 54467)
datetime.datetime(2025, 12, 7, 15, 17, 46, 116942)
datetime.datetime(2025, 12, 2, 18, 54, 16, 957843)
datetime.datetime(2025, 12, 10, 8, 36, 8, 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()
...
'21:51:20'
'21:48:56'
'10:27:16'
'01:49:28'
'01:04:09'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'09:51 PM'
'09:48 PM'
'10:27 AM'
'01:49 AM'
'01:04 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(21, 51, 20, 394793)
datetime.time(21, 48, 56, 316353)
datetime.time(10, 27, 16, 482061)
datetime.time(1, 49, 28, 345684)
datetime.time(1, 4, 9, 458377)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(22, 42, 0, 313458)
datetime.time(22, 34, 24, 952203)
datetime.time(10, 52, 30, 539752)
datetime.time(2, 5, 0, 445985)
datetime.time(1, 34, 50, 47374)
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 0x7fa11d93b1c0>
<generator object Provider.time_series at 0x7fa11d93b1c0>
<generator object Provider.time_series at 0x7fa11d93b1c0>
<generator object Provider.time_series at 0x7fa11d93b1c0>
<generator object Provider.time_series at 0x7fa11d93b1c0>
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()
...
1491774680.3947926
1339019336.3163526
742991236.4820607
457408168.3456844
903229449.4583771
year() str
Examples:

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