pandas.DatetimeIndex.snap — pandas 3.0.0.dev0+2100.gf496acffcc documentation (original) (raw)

DatetimeIndex.snap(freq='S')[source]#

Snap time stamps to nearest occurring frequency.

Parameters:

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

Frequency strings can have multiples, e.g. ‘5h’. Seehere for a list of frequency aliases.

Returns:

DatetimeIndex

Time stamps to nearest occurring freq.

Examples

idx = pd.DatetimeIndex( ... ["2023-01-01", "2023-01-02", "2023-02-01", "2023-02-02"], ... dtype="M8[ns]", ... ) idx DatetimeIndex(['2023-01-01', '2023-01-02', '2023-02-01', '2023-02-02'], dtype='datetime64[ns]', freq=None) idx.snap("MS") DatetimeIndex(['2023-01-01', '2023-01-01', '2023-02-01', '2023-02-01'], dtype='datetime64[ns]', freq=None)