timefmt.dt

Contains methods to format datetime.datetime objects into human-readable strings.

Module Contents

Functions

short(→ str)

Return the datetime.datetime object as a short human-readable string.

long(→ str)

Return the datetime.datetime object as a long human-readable string.

timefmt.dt.short(datetime_in: datetime.datetime) str

Return the datetime.datetime object as a short human-readable string.

Parameters:

datetime_in (datetime.datetime) – The timedelta to convert.

Returns:

The datetime.datetime object as a short human-readable string

Return type:

str

Example:
>>> from freezegun import freeze_time
>>> freezer = freeze_time("2023-12-31")
>>> r = freezer.start()
>>> from zoneinfo import ZoneInfo
>>> test_datetime = datetime.datetime(2023, 12, 31, 12, 23, 31, 379292, tzinfo=ZoneInfo("MST"))
>>> short(test_datetime)
'12:23:31 PM'
>>> test_datetime2 = datetime.datetime(2023, 12, 31, 12, 53, 10, 467258, tzinfo=ZoneInfo("EST"))
>>> short(test_datetime2)
'12:53:10 PM'
>>> short(test_datetime2 + datetime.timedelta(days=1))
'2024/01/01 @ 12:53:10 PM'
timefmt.dt.long(datetime_in: datetime.datetime) str

Return the datetime.datetime object as a long human-readable string.

Parameters:

datetime_in (datetime.datetime) – The timedelta to convert.

Returns:

The datetime.datetime object as a long human-readable string

Return type:

str

Example:
>>> from freezegun import freeze_time
>>> freezer = freeze_time("2023-12-31")
>>> r = freezer.start()
>>> from zoneinfo import ZoneInfo
>>> test_datetime = datetime.datetime(2023, 12, 31, 12, 23, 31, 379292, tzinfo=ZoneInfo("MST"))
>>> long(test_datetime)
'12:23:31 PM MST'
>>> test_datetime2 = datetime.datetime(2023, 12, 31, 12, 53, 10, 467258, tzinfo=ZoneInfo("EST"))
>>> long(test_datetime2)
'12:53:10 PM EST'
>>> long(test_datetime2 + datetime.timedelta(days=1))
'Monday, January 1st, 2024 at 12:53:10 PM EST'