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'
'AM'
'AM'
'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-29'
'2012-10-12'
'1993-09-27'
'1984-08-12'
'1998-11-09'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(pattern='%m/%d/%Y')
...
'08/29/2017'
'10/12/2012'
'09/27/1993'
'08/12/1984'
'11/09/1998'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date(end_datetime='+1w')
...
'2017-09-04'
'2012-10-17'
'1993-09-29'
'1984-08-14'
'1998-11-13'
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, 10, 9)
datetime.date(2019, 3, 6)
datetime.date(2009, 1, 20)
datetime.date(2004, 3, 16)
datetime.date(2011, 10, 11)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date='-1w')
...
datetime.date(2026, 6, 8)
datetime.date(2026, 6, 8)
datetime.date(2026, 6, 5)
datetime.date(2026, 6, 4)
datetime.date(2026, 6, 6)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between(start_date="-1y", end_date="+1w")
...
datetime.date(2026, 4, 19)
datetime.date(2026, 3, 18)
datetime.date(2025, 11, 12)
datetime.date(2025, 9, 13)
datetime.date(2025, 12, 16)
date_between_dates(date_start: date | datetime | timedelta | str | int | None = None, date_end: date | datetime | timedelta | str | int | None = None) date

Get a random date between the two given dates.

Parameters:
  • date_start – A DateParseType. Defaults to the UNIX epoch

  • date_end – A DateParseType. Defaults to the current date and time

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between_dates()
...
datetime.date(2026, 6, 10)
datetime.date(2026, 6, 10)
datetime.date(2026, 6, 10)
datetime.date(2026, 6, 10)
datetime.date(2026, 6, 10)
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, 29)
datetime.date(2012, 10, 12)
datetime.date(1993, 9, 27)
datetime.date(1984, 8, 12)
datetime.date(1998, 11, 9)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object(end_datetime='+1w')
...
datetime.date(2017, 9, 4)
datetime.date(2012, 10, 17)
datetime.date(1993, 9, 29)
datetime.date(1984, 8, 14)
datetime.date(1998, 11, 13)
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, 23)
datetime.date(1998, 5, 12)
datetime.date(1959, 3, 24)
datetime.date(1940, 6, 22)
datetime.date(1969, 9, 30)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth(minimum_age=30, maximum_age=50)
...
datetime.date(1993, 3, 4)
datetime.date(1991, 5, 11)
datetime.date(1984, 4, 9)
datetime.date(1980, 11, 16)
datetime.date(1986, 3, 5)
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, 29)
datetime.date(2020, 1, 15)
datetime.date(2011, 2, 13)
datetime.date(2006, 11, 5)
datetime.date(2013, 7, 8)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century(before_today=False, after_today=True)
...
datetime.date(2088, 7, 21)
datetime.date(2082, 3, 12)
datetime.date(2057, 5, 17)
datetime.date(2045, 6, 26)
datetime.date(2064, 1, 18)
date_this_decade(before_today: bool = True, after_today: bool = False) date

Gets a Date object for the decade year.

Parameters:
  • before_today – include days in current decade before today. Defaults to True

  • after_today – include days in current decade after today. Defaults to False

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade()
...
datetime.date(2025, 6, 9)
datetime.date(2024, 11, 17)
datetime.date(2022, 9, 16)
datetime.date(2021, 8, 31)
datetime.date(2023, 4, 17)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade(before_today=False, after_today=True)
...
datetime.date(2029, 6, 12)
datetime.date(2029, 2, 20)
datetime.date(2027, 12, 9)
datetime.date(2027, 5, 12)
datetime.date(2028, 4, 5)
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, 8)
datetime.date(2026, 6, 7)
datetime.date(2026, 6, 4)
datetime.date(2026, 6, 3)
datetime.date(2026, 6, 5)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month(before_today=False, after_today=True)
...
datetime.date(2026, 6, 27)
datetime.date(2026, 6, 25)
datetime.date(2026, 6, 18)
datetime.date(2026, 6, 15)
datetime.date(2026, 6, 20)
date_this_year(before_today: bool = True, after_today: bool = False) date

Gets a Date object for the current year.

Parameters:
  • before_today – include days in current year before today. Defaults to True

  • after_today – include days in current year after today. Defaults to False

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year()
...
datetime.date(2026, 5, 16)
datetime.date(2026, 5, 2)
datetime.date(2026, 3, 9)
datetime.date(2026, 2, 11)
datetime.date(2026, 3, 23)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year(before_today=False, after_today=True)
...
datetime.date(2026, 11, 30)
datetime.date(2026, 11, 12)
datetime.date(2026, 9, 4)
datetime.date(2026, 8, 2)
datetime.date(2026, 9, 22)
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, 29, 15, 33, 12, 610741)
datetime.datetime(2012, 10, 12, 3, 11, 6, 205241)
datetime.datetime(1993, 9, 27, 0, 41, 58, 214753)
datetime.datetime(1984, 8, 12, 12, 51, 13, 45213)
datetime.datetime(1998, 11, 9, 20, 42, 21, 60388)
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, 30, 18, 8, 8, 80597)
datetime.datetime(1536, 3, 12, 3, 17, 20, 88608)
datetime.datetime(852, 11, 4, 3, 4, 50, 258743)
datetime.datetime(525, 6, 3, 14, 57, 54, 15068)
datetime.datetime(1036, 7, 23, 5, 8, 2, 52593)
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, 10, 10, 4, 5, 51, 236214)
datetime.datetime(2019, 3, 7, 17, 30, 37, 808743)
datetime.datetime(2009, 1, 21, 23, 0, 18, 361449)
datetime.datetime(2004, 3, 17, 16, 10, 54, 49189)
datetime.datetime(2011, 10, 12, 19, 27, 50, 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, 10, 20, 55, 8)
datetime.datetime(2026, 6, 10, 20, 55, 8)
datetime.datetime(2026, 6, 10, 20, 55, 8)
datetime.datetime(2026, 6, 10, 20, 55, 8)
datetime.datetime(2026, 6, 10, 20, 55, 8)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
...
datetime.datetime(2021, 10, 10, 4, 5, 51, 236214)
datetime.datetime(2019, 3, 7, 17, 30, 37, 808743)
datetime.datetime(2009, 1, 21, 23, 0, 18, 361449)
datetime.datetime(2004, 3, 17, 16, 10, 54, 49189)
datetime.datetime(2011, 10, 12, 19, 27, 50, 171082)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
...
datetime.datetime(2027, 4, 15, 6, 55, 5, 441207)
datetime.datetime(2027, 3, 14, 16, 57, 54, 993625)
datetime.datetime(2026, 11, 11, 11, 32, 54, 345382)
datetime.datetime(2026, 9, 13, 10, 31, 15, 534973)
datetime.datetime(2026, 12, 14, 14, 37, 49, 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, 30, 7, 37, 40, 984121)
datetime.datetime(2020, 1, 16, 5, 25, 53, 848582)
datetime.datetime(2011, 2, 13, 19, 49, 55, 330221)
datetime.datetime(2006, 11, 5, 14, 2, 1, 77469)
datetime.datetime(2013, 7, 8, 19, 48, 53, 716492)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century(before_now=False, after_now=True)
...
datetime.datetime(2088, 7, 22, 1, 29, 9, 184565)
datetime.datetime(2082, 3, 12, 22, 19, 0, 774307)
datetime.datetime(2057, 5, 18, 10, 8, 4, 592526)
datetime.datetime(2045, 6, 27, 5, 18, 30, 827053)
datetime.datetime(2064, 1, 19, 8, 31, 28, 989708)
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, 9, 19, 35, 20, 550384)
datetime.datetime(2024, 11, 18, 8, 51, 56, 524004)
datetime.datetime(2022, 9, 16, 13, 13, 20, 945672)
datetime.datetime(2021, 9, 1, 4, 44, 56, 296565)
datetime.datetime(2023, 4, 17, 23, 7, 50, 775252)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade(before_now=False, after_now=True)
...
datetime.datetime(2029, 6, 12, 17, 28, 56, 690470)
datetime.datetime(2029, 2, 20, 7, 25, 53, 768492)
datetime.datetime(2027, 12, 9, 16, 2, 52, 938895)
datetime.datetime(2027, 5, 13, 11, 55, 9, 297500)
datetime.datetime(2028, 4, 5, 14, 15, 55, 763331)
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, 9, 8, 3, 34, 152540)
datetime.datetime(2026, 6, 8, 11, 34, 25, 373903)
datetime.datetime(2026, 6, 5, 3, 38, 28, 865863)
datetime.datetime(2026, 6, 3, 13, 20, 32, 167659)
datetime.datetime(2026, 6, 6, 1, 7, 50, 300053)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month(before_now=False, after_now=True)
...
datetime.datetime(2026, 6, 27, 20, 50, 35, 286613)
datetime.datetime(2026, 6, 26, 3, 4, 20, 438518)
datetime.datetime(2026, 6, 19, 8, 5, 20, 671650)
datetime.datetime(2026, 6, 16, 1, 59, 48, 49100)
datetime.datetime(2026, 6, 21, 3, 54, 21, 777734)
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, 16, 20, 14, 39, 396277)
datetime.datetime(2026, 5, 2, 22, 24, 1, 696423)
datetime.datetime(2026, 3, 9, 15, 47, 33, 938015)
datetime.datetime(2026, 2, 11, 15, 39, 23, 658681)
datetime.datetime(2026, 3, 24, 5, 59, 24, 824916)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year(before_now=False, after_now=True)
...
datetime.datetime(2026, 11, 30, 5, 48, 36, 113417)
datetime.datetime(2026, 11, 12, 14, 11, 56, 354702)
datetime.datetime(2026, 9, 4, 17, 19, 59, 435067)
datetime.datetime(2026, 8, 2, 17, 22, 22, 978558)
datetime.datetime(2026, 9, 23, 5, 41, 42, 788164)
day_of_month() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'29'
'12'
'27'
'12'
'09'
day_of_week() str
Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'Tuesday'
'Friday'
'Monday'
'Sunday'
'Monday'
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, 7, 5)
datetime.date(2026, 7, 2)
datetime.date(2026, 6, 23)
datetime.date(2026, 6, 18)
datetime.date(2026, 6, 25)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date(end_date='+1y')
...
datetime.date(2027, 4, 14)
datetime.date(2027, 3, 13)
datetime.date(2026, 11, 11)
datetime.date(2026, 9, 13)
datetime.date(2026, 12, 14)
future_datetime(end_date: date | datetime | timedelta | str | int = '+30d', tzinfo: tzinfo | None = None) datetime

Get a datetime object based on a random date between 1 second form now and a given date.

Parameters:
  • end_date – A DateParseType. Defaults to "+30d"

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime()
...
datetime.datetime(2026, 7, 6, 4, 54, 9, 594731)
datetime.datetime(2026, 7, 3, 14, 38, 46, 54467)
datetime.datetime(2026, 6, 23, 11, 43, 50, 116942)
datetime.datetime(2026, 6, 18, 15, 20, 20, 957843)
datetime.datetime(2026, 6, 26, 5, 2, 12, 566513)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime(end_date='+1y')
...
datetime.datetime(2027, 4, 15, 6, 55, 5, 596785)
datetime.datetime(2027, 3, 14, 16, 57, 55, 235670)
datetime.datetime(2026, 11, 11, 11, 32, 54, 924810)
datetime.datetime(2026, 9, 13, 10, 31, 16, 276056)
datetime.datetime(2026, 12, 14, 14, 37, 49, 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-29T15:33:12.610741'
'2012-10-12T03:11:06.205241'
'1993-09-27T00:41:58.214753'
'1984-08-12T12:51:13.045213'
'1998-11-09T20:42:21.060388'
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, 6, 4)
datetime.date(2026, 6, 1)
datetime.date(2026, 5, 23)
datetime.date(2026, 5, 18)
datetime.date(2026, 5, 25)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date(start_date='-1y')
...
datetime.date(2026, 4, 13)
datetime.date(2026, 3, 12)
datetime.date(2025, 11, 9)
datetime.date(2025, 9, 11)
datetime.date(2025, 12, 12)
past_datetime(start_date: date | datetime | timedelta | str | int = '-30d', tzinfo: tzinfo | None = None) datetime

Get a datetime object based on a random date between a given date and 1 second ago.

Parameters:
  • start_date – A DateParseType. Defaults to "-30d"

  • tzinfo – timezone, instance of datetime.tzinfo subclass

Example:

datetime(‘1999-02-02 11:42:52’)

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_datetime()
...
datetime.datetime(2026, 6, 6, 4, 54, 8, 594731)
datetime.datetime(2026, 6, 3, 14, 38, 45, 54467)
datetime.datetime(2026, 5, 24, 11, 43, 49, 116942)
datetime.datetime(2026, 5, 19, 15, 20, 19, 957843)
datetime.datetime(2026, 5, 27, 5, 2, 11, 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()
...
'15:33:12'
'03:11:06'
'00:41:58'
'12:51:13'
'20:42:21'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time(pattern='%I:%M %p')
...
'03:33 PM'
'03:11 AM'
'12:41 AM'
'12:51 PM'
'08:42 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(15, 33, 12, 610741)
datetime.time(3, 11, 6, 205241)
datetime.time(0, 41, 58, 214753)
datetime.time(12, 51, 13, 45213)
datetime.time(20, 42, 21, 60388)
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object(end_datetime='+1h')
...
datetime.time(16, 23, 52, 529407)
datetime.time(3, 56, 34, 841092)
datetime.time(1, 7, 12, 272444)
datetime.time(13, 6, 45, 145514)
datetime.time(21, 13, 1, 649385)
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 0x7b719ccb5310>
<generator object Provider.time_series at 0x7b719ccb5310>
<generator object Provider.time_series at 0x7b719ccb5310>
<generator object Provider.time_series at 0x7b719ccb5310>
<generator object Provider.time_series at 0x7b719ccb5310>
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()
...
1504020792.610741
1350011466.2052412
749090518.2147534
461163073.04521334
910644141.0603884
year() str
Examples:

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