nice-duration 0.9.0

Nice formatting of timedelta instances

nice_duration

This is a Python module that introduces a way of formatting a timedelta instance like so: 3h12m. It can also format an int or a float representing a number of seconds in the same way. A float is just converted to an int, so 70.9 is converted to 70.

The separator parameter, which defaults to the empty string, determines what the individual components are concatenated with. Setting separator to a single space changes the above example to 3h 12m.

Components with value 0 are left out. That can be changed by specifying

• leading_zeroes: set to True to keep the leading zeroes
• trailing_zeroes: set to True to keep the trailing zeroes
• infix_zeroes: set to True to keep the zeroes between values

For example, by setting trailing_zeroes to True, the example duration_string is changed to 3h12m0s.

For convenience, setting all_zeroes to True will set all three to True.

Limitations

• No sub-second precision
• Maximum unit is weeks (because bigger units have no fixed length)

Examples

>>> from datetime import timedelta
>>> from nice_duration import duration_string
>>> delta = timedelta(hours=3, minutes=20)
>>> duration_string(delta)
'3h20m'

int is interpreted as number of seconds

>>> duration_string(200) # When an int is given, it is interpreted as a number of seconds
'3h20m'

float is truncated to int and interpreted as a whole number of seconds

>>> duration_string(200.3) 
'3h20m'

negative value

>>> duration_string(-13) 
'-13s'

Setting separator:

>>> duration_string(delta, separator=" ")
'3h 20m'

Setting all_zeroes:

>>> duration_string(delta, all_zeroes=True)
'0w0d3h20m0s'

Setting trailing_zeroes:

>>> duration_string(delta, trailing_zeroes=True)
'3h20m0s'

Setting leading_zeroes:

>>> duration_string(delta, leading_zeroes=True)
'0w0d3h20m'

Setting infix_zeroes:

>>> duration_string(timedelta(hours=3, seconds=11), infix_zeroes=True)
'3h0m11s'

Return value when timedelta is 0:

>>> duration_string(timedelta())
'0s'