pandas.tseries.offsets.WeekOfMonth#

class pandas.tseries.offsets.WeekOfMonth#

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

This offset allows for generating or adjusting dates by specifying a particular week and weekday within a month. The week is zero-indexed, where 0 corresponds to the first week of the month, and weekday follows a Monday=0 convention.

Attributes

n

(int, default 1) The number of months represented.

normalize

(bool, default False) Normalize start/end dates to midnight before generating date range.

week

(int {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.

weekday

(int {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.

See also

offsets.Week

Describes weekly frequency adjustments.

offsets.MonthEnd

Describes month-end frequency adjustments.

date_range

Generates a range of dates based on a specific frequency.

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

Returns a integer of the total number of nanoseconds for fixed frequencies.

normalize

rule_code

Return a string representing the base frequency.

week

weekday

Methods

copy()

Return a copy of the frequency.

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.