pandas.timedelta_range — pandas 3.0.0rc0+33.g1fd184de2a documentation (original) (raw)

pandas.timedelta_range(start=None, end=None, periods=None, freq=None, name=None, closed=None, *, unit=None)[source]#

Return a fixed frequency TimedeltaIndex with day as the default.

Parameters:

startstr or timedelta-like, default None

Left bound for generating timedeltas.

endstr or timedelta-like, default None

Right bound for generating timedeltas.

periodsint, default None

Number of periods to generate.

freqstr, Timedelta, datetime.timedelta, or DateOffset, default ‘D’

Frequency strings can have multiples, e.g. ‘5h’.

namestr, default None

Name of the resulting TimedeltaIndex.

closedstr, default None

Make the interval closed with respect to the given frequency to the ‘left’, ‘right’, or both sides (None).

unit{‘s’, ‘ms’, ‘us’, ‘ns’, None}, default None

Specify the desired resolution of the result. If not specified, this is inferred from the ‘start’, ‘end’, and ‘freq’ using the same inference as Timedelta taking the highest resolution of the three that are provided.

Added in version 2.0.0.

Returns:

TimedeltaIndex

Fixed frequency, with day as the default.

Notes

Of the four parameters start, end, periods, and freq, a maximum of three can be specified at once. Of the three parametersstart, end, and periods, at least two must be specified. If freq is omitted, the resulting DatetimeIndex will haveperiods linearly spaced elements between start and end(closed on both sides).

To learn more about the frequency strings, please seethis link.

Examples

pd.timedelta_range(start="1 day", periods=4) TimedeltaIndex(['1 days', '2 days', '3 days', '4 days'], dtype='timedelta64[us]', freq='D')

The closed parameter specifies which endpoint is included. The default behavior is to include both endpoints.

pd.timedelta_range(start="1 day", periods=4, closed="right") TimedeltaIndex(['2 days', '3 days', '4 days'], dtype='timedelta64[us]', freq='D')

The freq parameter specifies the frequency of the TimedeltaIndex. Only fixed frequencies can be passed, non-fixed frequencies such as ‘M’ (month end) will raise.

pd.timedelta_range(start="1 day", end="2 days", freq="6h") TimedeltaIndex(['1 days 00:00:00', '1 days 06:00:00', '1 days 12:00:00', '1 days 18:00:00', '2 days 00:00:00'], dtype='timedelta64[us]', freq='6h')

Specify start, end, and periods; the frequency is generated automatically (linearly spaced).

pd.timedelta_range(start="1 day", end="5 days", periods=4) TimedeltaIndex(['1 days 00:00:00', '2 days 08:00:00', '3 days 16:00:00', '5 days 00:00:00'], dtype='timedelta64[us]', freq=None)

Specify a unit

pd.timedelta_range("1 Day", periods=3, freq="100000D", unit="s") TimedeltaIndex(['1 days', '100001 days', '200001 days'], dtype='timedelta64[s]', freq='100000D')