Skip to content

DEPR: rename startingMonth to starting_month (argument in BQuarterBegin) #58110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 15 commits into from
Closed

DEPR: rename startingMonth to starting_month (argument in BQuarterBegin) #58110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
60bc2b2
remove 'or tuple'
gboeker Mar 27, 2024
3369ee6
Merge branch 'pandas-dev:main' into main
gboeker Mar 27, 2024
b9ffd56
remove trailing space
gboeker Mar 27, 2024
b24ef19
Merge branch 'main' into main
gboeker Mar 28, 2024
8d44d87
Merge branch 'pandas-dev:main' into main
gboeker Apr 1, 2024
c854f97
rename startingMonth to starting_month
gboeker Apr 1, 2024
ee3db3c
Merge branch 'pandas-dev:main' into rename
gboeker Apr 1, 2024
69e3a5a
change startingMonth in test files
gboeker Apr 3, 2024
59f437a
Merge branch 'main' into rename
gboeker Apr 7, 2024
30721bb
Merge branch 'main' into rename
gboeker Apr 9, 2024
ff19642
Merge branch 'pandas-dev:main' into rename
gboeker Apr 11, 2024
9a64729
Merge branch 'main' into rename
gboeker Apr 21, 2024
9b34b5f
Merge branch 'pandas-dev:main' into rename
gboeker May 4, 2024
9df38e7
fix line too long
gboeker May 4, 2024
1c6acf0
fix correct function
gboeker May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.BQuarterBegin.nanos GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.normalize GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.rule_code GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.startingMonth GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.starting_month GL08" \
-i "pandas.tseries.offsets.BQuarterEnd PR02" \
-i "pandas.tseries.offsets.BQuarterEnd.copy SA01" \
-i "pandas.tseries.offsets.BQuarterEnd.freqstr SA01" \
Expand All @@ -628,7 +628,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.BQuarterEnd.nanos GL08" \
-i "pandas.tseries.offsets.BQuarterEnd.normalize GL08" \
-i "pandas.tseries.offsets.BQuarterEnd.rule_code GL08" \
-i "pandas.tseries.offsets.BQuarterEnd.startingMonth GL08" \
-i "pandas.tseries.offsets.BQuarterEnd.starting_month GL08" \
-i "pandas.tseries.offsets.BYearBegin PR02" \
-i "pandas.tseries.offsets.BYearBegin.copy SA01" \
-i "pandas.tseries.offsets.BYearBegin.freqstr SA01" \
Expand Down Expand Up @@ -800,7 +800,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.FY5253.nanos GL08" \
-i "pandas.tseries.offsets.FY5253.normalize GL08" \
-i "pandas.tseries.offsets.FY5253.rule_code GL08" \
-i "pandas.tseries.offsets.FY5253.startingMonth GL08" \
-i "pandas.tseries.offsets.FY5253.starting_month GL08" \
-i "pandas.tseries.offsets.FY5253.variation GL08" \
-i "pandas.tseries.offsets.FY5253.weekday GL08" \
-i "pandas.tseries.offsets.FY5253Quarter PR02" \
Expand All @@ -816,7 +816,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.FY5253Quarter.normalize GL08" \
-i "pandas.tseries.offsets.FY5253Quarter.qtr_with_extra_week GL08" \
-i "pandas.tseries.offsets.FY5253Quarter.rule_code GL08" \
-i "pandas.tseries.offsets.FY5253Quarter.startingMonth GL08" \
-i "pandas.tseries.offsets.FY5253Quarter.starting_month GL08" \
-i "pandas.tseries.offsets.FY5253Quarter.variation GL08" \
-i "pandas.tseries.offsets.FY5253Quarter.weekday GL08" \
-i "pandas.tseries.offsets.FY5253Quarter.year_has_extra_week GL08" \
Expand Down Expand Up @@ -912,7 +912,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.QuarterBegin.nanos GL08" \
-i "pandas.tseries.offsets.QuarterBegin.normalize GL08" \
-i "pandas.tseries.offsets.QuarterBegin.rule_code GL08" \
-i "pandas.tseries.offsets.QuarterBegin.startingMonth GL08" \
-i "pandas.tseries.offsets.QuarterBegin.starting_month GL08" \
-i "pandas.tseries.offsets.QuarterEnd PR02" \
-i "pandas.tseries.offsets.QuarterEnd.copy SA01" \
-i "pandas.tseries.offsets.QuarterEnd.freqstr SA01" \
Expand All @@ -923,7 +923,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.QuarterEnd.nanos GL08" \
-i "pandas.tseries.offsets.QuarterEnd.normalize GL08" \
-i "pandas.tseries.offsets.QuarterEnd.rule_code GL08" \
-i "pandas.tseries.offsets.QuarterEnd.startingMonth GL08" \
-i "pandas.tseries.offsets.QuarterEnd.starting_month GL08" \
-i "pandas.tseries.offsets.Second PR02" \
-i "pandas.tseries.offsets.Second.copy SA01" \
-i "pandas.tseries.offsets.Second.freqstr SA01" \
Expand Down
12 changes: 6 additions & 6 deletions doc/source/reference/offset_frequency.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ Properties
BQuarterEnd.normalize
BQuarterEnd.rule_code
BQuarterEnd.n
BQuarterEnd.startingMonth
BQuarterEnd.starting_month

Methods
~~~~~~~
Expand Down Expand Up @@ -690,7 +690,7 @@ Properties
BQuarterBegin.normalize
BQuarterBegin.rule_code
BQuarterBegin.n
BQuarterBegin.startingMonth
BQuarterBegin.starting_month

Methods
~~~~~~~
Expand Down Expand Up @@ -725,7 +725,7 @@ Properties
QuarterEnd.normalize
QuarterEnd.rule_code
QuarterEnd.n
QuarterEnd.startingMonth
QuarterEnd.starting_month

Methods
~~~~~~~
Expand Down Expand Up @@ -760,7 +760,7 @@ Properties
QuarterBegin.normalize
QuarterBegin.rule_code
QuarterBegin.n
QuarterBegin.startingMonth
QuarterBegin.starting_month

Methods
~~~~~~~
Expand Down Expand Up @@ -935,7 +935,7 @@ Properties
FY5253.normalize
FY5253.rule_code
FY5253.n
FY5253.startingMonth
FY5253.starting_month
FY5253.variation
FY5253.weekday

Expand Down Expand Up @@ -975,7 +975,7 @@ Properties
FY5253Quarter.rule_code
FY5253Quarter.n
FY5253Quarter.qtr_with_extra_week
FY5253Quarter.startingMonth
FY5253Quarter.starting_month
FY5253Quarter.variation
FY5253Quarter.weekday

Expand Down
4 changes: 2 additions & 2 deletions pandas/_libs/tslibs/fields.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,8 @@ def get_start_end_field(
is_business = freqstr[0] == "B"

# YearBegin(), BYearBegin() use month = starting month of year.
# QuarterBegin(), BQuarterBegin() use startingMonth = starting
# month of year. Other offsets use month, startingMonth as ending
# QuarterBegin(), BQuarterBegin() use starting_month = starting
# month of year. Other offsets use month, starting_month as ending
# month of year.

if (freqstr[0:2] in ["MS", "QS", "YS"]) or (
Expand Down
6 changes: 3 additions & 3 deletions pandas/_libs/tslibs/offsets.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ class YearBegin(YearOffset): ...

class QuarterOffset(SingleConstructorOffset):
def __init__(
self, n: int = ..., normalize: bool = ..., startingMonth: int | None = ...
self, n: int = ..., normalize: bool = ..., starting_month: int | None = ...
) -> None: ...

class BQuarterEnd(QuarterOffset): ...
Expand Down Expand Up @@ -203,7 +203,7 @@ class FY5253Mixin(SingleConstructorOffset):
n: int = ...,
normalize: bool = ...,
weekday: int = ...,
startingMonth: int = ...,
starting_month: int = ...,
variation: Literal["nearest", "last"] = ...,
) -> None: ...

Expand All @@ -215,7 +215,7 @@ class FY5253Quarter(FY5253Mixin):
n: int = ...,
normalize: bool = ...,
weekday: int = ...,
startingMonth: int = ...,
starting_month: int = ...,
qtr_with_extra_week: int = ...,
variation: Literal["nearest", "last"] = ...,
) -> None: ...
Expand Down
Loading
Loading