timefmt.td

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

Module Contents

Functions

short(→ str)

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

long(→ str)

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

timefmt.td.short(timedelta_in: datetime.timedelta) str

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

Parameters:

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

Returns:

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

Return type:

str

Example:
>>> short(datetime.timedelta(hours=1000, seconds=9999))
'5W 6D 18:46:39'
>>> short(datetime.timedelta(hours=-1000, seconds=9999))
'5W 6D 13:13:21 ago'
>>> short(datetime.timedelta(seconds=90))
'0:01:30'
>>> short(datetime.timedelta(seconds=30))
'0:00:30'
timefmt.td.long(timedelta_in: datetime.timedelta) str

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

Parameters:

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

Returns:

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

Return type:

str

Example:
>>> long(datetime.timedelta(hours=1000, seconds=9999))
'5 weeks, 6 days, 18 hours, 46 minutes, and 39 seconds'
>>> long(datetime.timedelta(hours=-1000, seconds=9999))
'5 weeks, 6 days, 13 hours, 13 minutes, and 21 seconds ago'
>>> long(datetime.timedelta(seconds=90))
'1 minute and 30 seconds'
>>> long(datetime.timedelta(seconds=30))
'30 seconds'