Period.descriptive

property Period.descriptive: str

This period’s frequency, named where there is a common word or recognised name for it.

For display only - see verbose for the same caveat.

Returns:

A string such as “Daily” or “15 minutes”, with a name, offset or origin in brackets if there is one

Examples

>>> Period.of_days(1).descriptive
'Daily'
>>> Period.of("P1D+T9H").descriptive
'Daily (UK Water Day)'
>>> Period.of("2024-01-01/P7D").descriptive
'Weekly (from 2024-01-01)'