pandas.tseries.offsets.WeekOfMonth#

class pandas.tseries.offsets.WeekOfMonth#

Describes monthly dates like “the Tuesday of the 2nd week of each month”.

Parameters:
nint, default 1

The number of months represented.

normalizebool, default False

Normalize start/end dates to midnight before generating date range.

weekint {0, 1, 2, 3, …}, default 0

A specific integer for the week of the month. e.g. 0 is 1st week of month, 1 is the 2nd week, etc.

weekdayint {0, 1, …, 6}, default 0

A specific integer for the day of the week.

  • 0 is Monday

  • 1 is Tuesday

  • 2 is Wednesday

  • 3 is Thursday

  • 4 is Friday

  • 5 is Saturday

  • 6 is Sunday.

Examples

>>> ts = pd.Timestamp(2022, 1, 1)
>>> ts + pd.offsets.WeekOfMonth()
Timestamp('2022-01-03 00:00:00')

Attributes

base

Returns a copy of the calling offset object with n=1 and all other attributes equal.

freqstr

Return a string representing the frequency.

kwds

Return a dict of extra parameters for the offset.

n

name

Return a string representing the base frequency.

nanos

normalize

rule_code

week

weekday

Methods

copy()

Return a copy of the frequency.

is_anchored()

(DEPRECATED) Return boolean whether the frequency is a unit frequency (n=1).

is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

rollback(dt)

Roll provided date backward to next offset only if not on offset.

rollforward(dt)

Roll provided date forward to next offset only if not on offset.