parse_human_duration

parse_human_duration(value)

Convert human-friendly duration input into a pandas Timedelta or DateOffset.

Parameters

Name	Type	Description	Default
value	str or numeric or timedelta - like	Supported examples include: "30 minutes", "2 hours", "3 months", "1 year", pd.Timedelta("7D"), datetime.timedelta(days=2).	required

Returns

Name	Type	Description
	Union[pd.Timedelta, pd.DateOffset]	Returns a Timedelta for fixed-width units (seconds through weeks) and a DateOffset for calendar-aware units (months, quarters, years).

Raises

Name	Type	Description
	ValueError	If the input cannot be parsed or represents an unsupported unit.

Examples

import pytimetk as tk

tk.parse_human_duration("45 minutes")

Timedelta('0 days 00:45:00')

tk.parse_human_duration("3 months")

<DateOffset: months=3>