faker.providers.date_time

class faker.providers.date_time.Provider(generator: Any)

Bases: BaseProvider

Most methods of the provider accept a ‘start_datetime’ and/or ‘end_datetime’ parameter.

These parameters accept a variety of types, and are used to define the range of the random date/time.

We call this type DateParseType.

A DateParseType can be:

  • a datetime or date object

  • an integer or a float, representing UNIX a timestamp

  • the special string ‘now’

  • the special string ‘today’

  • a timedelta object, representing a time delta from now

  • a ‘timedelta string’, such as ‘+2d’, ‘-3w’, ‘+4y’, etc. Representing a time delta from now.

am_pm() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.am_pm()
...
'AM'
'PM'
'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-08-21'
'2012-10-04'
'1993-09-22'
'1984-08-09'
'1998-11-04'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'08/21/2017'
'10/04/2012'
'09/22/1993'
'08/09/1984'
'11/04/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-08-27'
'2012-10-09'
'1993-09-25'
'1984-08-11'
'1998-11-08'
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, 9, 30)
datetime.date(2019, 2, 25)
datetime.date(2009, 1, 11)
datetime.date(2004, 3, 7)
datetime.date(2011, 10, 2)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 5, 30)
datetime.date(2026, 5, 30)
datetime.date(2026, 5, 27)
datetime.date(2026, 5, 26)
datetime.date(2026, 5, 28)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 4, 10)
datetime.date(2026, 3, 9)
datetime.date(2025, 11, 3)
datetime.date(2025, 9, 4)
datetime.date(2025, 12, 7)
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, 6, 1)
datetime.date(2026, 6, 1)
datetime.date(2026, 6, 1)
datetime.date(2026, 6, 1)
datetime.date(2026, 6, 1)
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, 8, 21)
datetime.date(2012, 10, 4)
datetime.date(1993, 9, 22)
datetime.date(1984, 8, 9)
datetime.date(1998, 11, 4)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 8, 27)
datetime.date(2012, 10, 9)
datetime.date(1993, 9, 25)
datetime.date(1984, 8, 11)
datetime.date(1998, 11, 8)
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, 5, 14)
datetime.date(1998, 5, 3)
datetime.date(1959, 3, 15)
datetime.date(1940, 6, 13)
datetime.date(1969, 9, 21)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 2, 23)
datetime.date(1991, 5, 2)
datetime.date(1984, 3, 31)
datetime.date(1980, 11, 7)
datetime.date(1986, 2, 24)
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, 4, 21)
datetime.date(2020, 1, 8)
datetime.date(2011, 2, 9)
datetime.date(2006, 11, 3)
datetime.date(2013, 7, 3)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 7, 20)
datetime.date(2082, 3, 10)
datetime.date(2057, 5, 12)
datetime.date(2045, 6, 19)
datetime.date(2064, 1, 14)
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, 6, 1)
datetime.date(2024, 11, 10)
datetime.date(2022, 9, 12)
datetime.date(2021, 8, 29)
datetime.date(2023, 4, 12)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 6, 11)
datetime.date(2029, 2, 17)
datetime.date(2027, 12, 3)
datetime.date(2027, 5, 6)
datetime.date(2028, 3, 31)
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, 6, 1)
datetime.date(2026, 6, 1)
datetime.date(2026, 6, 1)
datetime.date(2026, 6, 1)
datetime.date(2026, 6, 1)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 6, 26)
datetime.date(2026, 6, 23)
datetime.date(2026, 6, 13)
datetime.date(2026, 6, 8)
datetime.date(2026, 6, 16)
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, 5, 8)
datetime.date(2026, 4, 25)
datetime.date(2026, 3, 5)
datetime.date(2026, 2, 9)
datetime.date(2026, 3, 19)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 11, 28)
datetime.date(2026, 11, 10)
datetime.date(2026, 8, 30)
datetime.date(2026, 7, 26)
datetime.date(2026, 9, 18)
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, 8, 21, 8, 0, 6, 631509)
datetime.datetime(2012, 10, 4, 16, 4, 1, 802621)
datetime.datetime(1993, 9, 22, 21, 18, 39, 886363)
datetime.datetime(1984, 8, 9, 23, 40, 1, 432319)
datetime.datetime(1998, 11, 4, 19, 52, 57, 670107)
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, 4, 22, 10, 35, 2, 101364)
datetime.datetime(1536, 3, 4, 16, 10, 15, 685989)
datetime.datetime(852, 10, 30, 23, 41, 31, 930359)
datetime.datetime(525, 6, 1, 1, 46, 42, 402176)
datetime.datetime(1036, 7, 18, 4, 18, 38, 662312)
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, 9, 30, 7, 46, 48, 236214)
datetime.datetime(2019, 2, 25, 21, 11, 34, 808743)
datetime.datetime(2009, 1, 12, 2, 41, 15, 361449)
datetime.datetime(2004, 3, 7, 19, 51, 51, 49189)
datetime.datetime(2011, 10, 2, 23, 8, 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(2026, 6, 1, 0, 36, 5)
datetime.datetime(2026, 6, 1, 0, 36, 5)
datetime.datetime(2026, 6, 1, 0, 36, 5)
datetime.datetime(2026, 6, 1, 0, 36, 5)
datetime.datetime(2026, 6, 1, 0, 36, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2021, 9, 30, 7, 46, 48, 236214)
datetime.datetime(2019, 2, 25, 21, 11, 34, 808743)
datetime.datetime(2009, 1, 12, 2, 41, 15, 361449)
datetime.datetime(2004, 3, 7, 19, 51, 51, 49189)
datetime.datetime(2011, 10, 2, 23, 8, 47, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 4, 5, 10, 36, 2, 441207)
datetime.datetime(2027, 3, 4, 20, 38, 51, 993625)
datetime.datetime(2026, 11, 1, 15, 13, 51, 345382)
datetime.datetime(2026, 9, 3, 14, 12, 12, 534973)
datetime.datetime(2026, 12, 4, 18, 18, 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(2022, 4, 22, 0, 4, 35, 4889)
datetime.datetime(2020, 1, 8, 18, 18, 49, 445961)
datetime.datetime(2011, 2, 9, 16, 26, 37, 1830)
datetime.datetime(2006, 11, 3, 0, 50, 49, 464575)
datetime.datetime(2013, 7, 3, 18, 59, 30, 326210)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 7, 20, 12, 43, 12, 163796)
datetime.datetime(2082, 3, 10, 13, 7, 2, 176928)
datetime.datetime(2057, 5, 12, 17, 12, 19, 920917)
datetime.datetime(2045, 6, 19, 22, 10, 39, 439947)
datetime.datetime(2064, 1, 14, 13, 1, 49, 379990)
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, 6, 1, 12, 2, 14, 571152)
datetime.datetime(2024, 11, 10, 21, 44, 52, 121383)
datetime.datetime(2022, 9, 12, 9, 50, 2, 617281)
datetime.datetime(2021, 8, 29, 15, 33, 44, 683671)
datetime.datetime(2023, 4, 12, 22, 18, 27, 384970)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 6, 11, 4, 42, 59, 669703)
datetime.datetime(2029, 2, 17, 22, 13, 55, 171113)
datetime.datetime(2027, 12, 3, 23, 7, 8, 267286)
datetime.datetime(2027, 5, 6, 4, 47, 17, 910394)
datetime.datetime(2028, 3, 31, 18, 46, 16, 153613)
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, 6, 1, 0, 30, 28, 173309)
datetime.datetime(2026, 6, 1, 0, 27, 20, 971282)
datetime.datetime(2026, 6, 1, 0, 15, 10, 537472)
datetime.datetime(2026, 6, 1, 0, 9, 20, 554764)
datetime.datetime(2026, 6, 1, 0, 18, 26, 909772)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 6, 26, 8, 4, 38, 265844)
datetime.datetime(2026, 6, 23, 17, 52, 21, 841139)
datetime.datetime(2026, 6, 13, 15, 9, 36, 41)
datetime.datetime(2026, 6, 8, 18, 51, 56, 661995)
datetime.datetime(2026, 6, 16, 8, 24, 42, 168016)
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, 5, 8, 12, 41, 33, 417045)
datetime.datetime(2026, 4, 25, 11, 16, 57, 293803)
datetime.datetime(2026, 3, 5, 12, 24, 15, 609624)
datetime.datetime(2026, 2, 9, 2, 28, 12, 45787)
datetime.datetime(2026, 3, 19, 5, 10, 1, 434635)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 11, 28, 17, 2, 39, 92649)
datetime.datetime(2026, 11, 10, 4, 59, 57, 757323)
datetime.datetime(2026, 8, 30, 0, 24, 14, 763458)
datetime.datetime(2026, 7, 26, 10, 14, 31, 591452)
datetime.datetime(2026, 9, 18, 10, 12, 3, 178445)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'21'
'04'
'22'
'09'
'04'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Monday'
'Thursday'
'Wednesday'
'Thursday'
'Wednesday'
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, 6, 26)
datetime.date(2026, 6, 23)
datetime.date(2026, 6, 14)
datetime.date(2026, 6, 9)
datetime.date(2026, 6, 16)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 4, 5)
datetime.date(2027, 3, 4)
datetime.date(2026, 11, 2)
datetime.date(2026, 9, 4)
datetime.date(2026, 12, 5)
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, 6, 26, 8, 35, 6, 594731)
datetime.datetime(2026, 6, 23, 18, 19, 43, 54467)
datetime.datetime(2026, 6, 13, 15, 24, 47, 116942)
datetime.datetime(2026, 6, 8, 19, 1, 17, 957843)
datetime.datetime(2026, 6, 16, 8, 43, 9, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 4, 5, 10, 36, 2, 596785)
datetime.datetime(2027, 3, 4, 20, 38, 52, 235670)
datetime.datetime(2026, 11, 1, 15, 13, 51, 924810)
datetime.datetime(2026, 9, 3, 14, 12, 13, 276056)
datetime.datetime(2026, 12, 4, 18, 18, 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-08-21T08:00:06.631509'
'2012-10-04T16:04:01.802621'
'1993-09-22T21:18:39.886363'
'1984-08-09T23:40:01.432319'
'1998-11-04T19:52:57.670107'
month() str
Examples:

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

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'August'
'October'
'September'
'August'
'November'
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, 5, 26)
datetime.date(2026, 5, 23)
datetime.date(2026, 5, 14)
datetime.date(2026, 5, 9)
datetime.date(2026, 5, 16)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 4, 4)
datetime.date(2026, 3, 3)
datetime.date(2025, 10, 31)
datetime.date(2025, 9, 2)
datetime.date(2025, 12, 3)
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, 5, 27, 8, 35, 5, 594731)
datetime.datetime(2026, 5, 24, 18, 19, 42, 54467)
datetime.datetime(2026, 5, 14, 15, 24, 46, 116942)
datetime.datetime(2026, 5, 9, 19, 1, 16, 957843)
datetime.datetime(2026, 5, 17, 8, 43, 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()
...
'08:00:06'
'16:04:01'
'21:18:39'
'23:40:01'
'19:52:57'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'08:00 AM'
'04:04 PM'
'09:18 PM'
'11:40 PM'
'07:52 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(8, 0, 6, 631509)
datetime.time(16, 4, 1, 802621)
datetime.time(21, 18, 39, 886363)
datetime.time(23, 40, 1, 432319)
datetime.time(19, 52, 57, 670107)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(8, 50, 46, 550174)
datetime.time(16, 49, 30, 438471)
datetime.time(21, 43, 53, 944054)
datetime.time(23, 55, 33, 532620)
datetime.time(20, 23, 38, 259104)
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 0x7814de5fbbe0>
<generator object Provider.time_series at 0x7814de5fbbe0>
<generator object Provider.time_series at 0x7814de5fbbe0>
<generator object Provider.time_series at 0x7814de5fbbe0>
<generator object Provider.time_series at 0x7814de5fbbe0>
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()
...
1503302406.631509
1349366641.8026206
748732719.8863626
460942801.4323188
910209177.6701072
year() str
Examples:

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