pandas.tseries.offsets.YearBegin

classpandas.tseries.offsets.YearBegin

Дата-смещение, увеличивающее дату до начала календарного года.

YearBegin переходит к следующей дате, которая является началом года.

Параметры:

n:int, по умолчанию 1

Количество представляемых лет.

normalize:bool, по умолчанию False

Нормализовать начальные/конечные даты до полуночи перед генерацией диапазона дат.

month:int, по умолчанию 1

Указанное целое число для месяца года.

См. также

DateOffset

Стандартный вид приращения даты.

Примеры

>>> ts = pd.Timestamp(2022, 12, 1)
>>> ts + pd.offsets.YearBegin()
Timestamp('2023-01-01 00:00:00')

>>> ts = pd.Timestamp(2023, 1, 1)
>>> ts + pd.offsets.YearBegin()
Timestamp('2024-01-01 00:00:00')

>>> ts = pd.Timestamp(2022, 1, 1)
>>> ts + pd.offsets.YearBegin(month=2)
Timestamp('2022-02-01 00:00:00')

Если нужно получить начало текущего года:

>>> ts = pd.Timestamp(2023, 1, 1)
>>> pd.offsets.YearBegin().rollback(ts)
Timestamp('2023-01-01 00:00:00')

Атрибуты

base	Возвращает копию объекта смещения вызова с n=1 и всеми другими атрибутами, равными.
freqstr	Возвращает строку, представляющую частоту.
kwds	Возвращает словарь дополнительных параметров для смещения.
month
n
name	Возвращает строку, представляющую базовую частоту.
nanos
normalize
rule_code

Методы

copy()	Возвращает копию частоты.
is_anchored()	(УСТЕРЕЖЕН) Возвращает булево значение, является ли частота частотой единицы (n=1).
is_month_end(ts)	Возвращает булево значение, происходит ли отметка времени в конце месяца.
is_month_start(ts)	Возвращает булево значение, происходит ли отметка времени в начале месяца.
is_on_offset(dt)	Возвращает булево значение, пересекается ли отметка времени с этой частотой.
is_quarter_end(ts)	Возвращает булево значение, происходит ли отметка времени в конце квартала.
is_quarter_start(ts)	Возвращает булево значение, происходит ли отметка времени в начале квартала.
is_year_end(ts)	Возвращает булево значение, происходит ли отметка времени в конце года.
is_year_start(ts)	Возвращает булево значение, происходит ли отметка времени в начале года.
rollback(dt)	Прокручивает предоставленную дату назад до следующего смещения только в том случае, если она не находится на смещении.
rollforward(dt)	Прокручивает предоставленную дату вперед до следующего смещения только в том случае, если она не находится на смещении.