Skip to content

pandas/index-year-mask

Rule index-year-mask
Pack pandas
Severity warning
Fix unsafe, with xpd check --fix --unsafe-fixes
Library versions every version

Selecting a year with df.index.year == 2023 computes the year of every row. On a DatetimeIndex, select it with a label, as in df.loc["2023"].

year = df[df.index.year == 2023]
year = df.loc["2023"]

The rule reports df[df.index.year == 2023], which computes the year of every row to build a mask.

xpd check --fix --unsafe-fixes applies the fixes of this rule. Check the result, because an unsafe fix can change what the code does.

The unsafe fix writes df.loc["2023"]. On a PeriodIndex of years the label is one period, so the fix returns the value where the mask returned a Series of one row.

df.loc["2023"] selects by label and needs a sorted DatetimeIndex.

xpd prints this message with the issue. A name that starts with $ stands for code from your file.

On a DatetimeIndex, a label selects the year without a mask over every row. Write $DF.loc["$Y"].

Browse the other rules of the pandas pack.