Skip to content

Commit 756fbd4

Browse files
committed
DOC: Enforce Numpy Docstring Validation for freqstr, nanos, and rule_code methods of pandas.tseries.offsets Week, WeekOfMonth, YearBegin, and YearEnd classes.
1 parent 92834f4 commit 756fbd4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+501
-248
lines changed

.devcontainer.json

-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
// Use 'settings' to set *default* container specific settings.json values on container create.
99
// You can edit these settings after create using File > Preferences > Settings > Remote.
1010
"settings": {
11-
"terminal.integrated.shell.linux": "/bin/bash",
1211
"python.pythonPath": "/usr/local/bin/python",
1312
"python.formatting.provider": "black",
1413
"python.linting.enabled": true,

.github/actions/setup-conda/action.yml

+6
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,9 @@ runs:
1414
condarc-file: ci/.condarc
1515
cache-environment: true
1616
cache-downloads: true
17+
18+
- name: Uninstall pyarrow
19+
if: ${{ env.REMOVE_PYARROW == '1' }}
20+
run: |
21+
micromamba remove -y pyarrow
22+
shell: bash -el {0}

.github/workflows/unit-tests.yml

+6-1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ jobs:
2929
env_file: [actions-310.yaml, actions-311.yaml, actions-312.yaml]
3030
# Prevent the include jobs from overriding other jobs
3131
pattern: [""]
32+
pandas_future_infer_string: ["0"]
3233
include:
3334
- name: "Downstream Compat"
3435
env_file: actions-311-downstream_compat.yaml
@@ -58,6 +59,9 @@ jobs:
5859
# It will be temporarily activated during tests with locale.setlocale
5960
extra_loc: "zh_CN"
6061
- name: "Future infer strings"
62+
env_file: actions-312.yaml
63+
pandas_future_infer_string: "1"
64+
- name: "Future infer strings (without pyarrow)"
6165
env_file: actions-311.yaml
6266
pandas_future_infer_string: "1"
6367
- name: "Pypy"
@@ -85,9 +89,10 @@ jobs:
8589
NPY_PROMOTION_STATE: ${{ matrix.env_file == 'actions-311-numpydev.yaml' && 'weak' || 'legacy' }}
8690
# Clipboard tests
8791
QT_QPA_PLATFORM: offscreen
92+
REMOVE_PYARROW: ${{ matrix.name == 'Future infer strings (without pyarrow)' && '1' || '0' }}
8893
concurrency:
8994
# https://github.community/t/concurrecy-not-work-for-push/183068/7
90-
group: ${{ github.event_name == 'push' && github.run_number || github.ref }}-${{ matrix.env_file }}-${{ matrix.pattern }}-${{ matrix.extra_apt || '' }}}
95+
group: ${{ github.event_name == 'push' && github.run_number || github.ref }}-${{ matrix.env_file }}-${{ matrix.pattern }}-${{ matrix.extra_apt || '' }}-${{ matrix.pandas_future_infer_string }}
9196
cancel-in-progress: true
9297

9398
services:

.gitpod.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ tasks:
1414
cp gitpod/settings.json .vscode/settings.json
1515
git fetch --tags
1616
python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true
17-
pre-commit install
17+
pre-commit install --install-hooks
1818
command: |
1919
python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true
2020
echo "✨ Pre-build complete! You can close this terminal ✨ "

Dockerfile

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ FROM python:3.10.8
22
WORKDIR /home/pandas
33

44
RUN apt-get update && apt-get -y upgrade
5-
RUN apt-get install -y build-essential
5+
RUN apt-get install -y build-essential bash-completion
66

77
# hdf5 needed for pytables installation
88
# libgles2-mesa needed for pytest-qt
@@ -12,4 +12,6 @@ RUN python -m pip install --upgrade pip
1212
COPY requirements-dev.txt /tmp
1313
RUN python -m pip install -r /tmp/requirements-dev.txt
1414
RUN git config --global --add safe.directory /home/pandas
15+
16+
ENV SHELL "/bin/bash"
1517
CMD ["/bin/bash"]

ci/code_checks.sh

-2
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
163163
-i "pandas.Series.str.center RT03,SA01" \
164164
-i "pandas.Series.str.decode PR07,RT03,SA01" \
165165
-i "pandas.Series.str.encode PR07,RT03,SA01" \
166-
-i "pandas.Series.str.index RT03" \
167166
-i "pandas.Series.str.ljust RT03,SA01" \
168167
-i "pandas.Series.str.lower RT03" \
169168
-i "pandas.Series.str.lstrip RT03" \
@@ -172,7 +171,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
172171
-i "pandas.Series.str.partition RT03" \
173172
-i "pandas.Series.str.repeat SA01" \
174173
-i "pandas.Series.str.replace SA01" \
175-
-i "pandas.Series.str.rindex RT03" \
176174
-i "pandas.Series.str.rjust RT03,SA01" \
177175
-i "pandas.Series.str.rpartition RT03" \
178176
-i "pandas.Series.str.rstrip RT03" \

doc/source/whatsnew/v3.0.0.rst

+3
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Other enhancements
5050
- :meth:`DataFrame.pivot_table` and :func:`pivot_table` now allow the passing of keyword arguments to ``aggfunc`` through ``**kwargs`` (:issue:`57884`)
5151
- :meth:`Series.cummin` and :meth:`Series.cummax` now supports :class:`CategoricalDtype` (:issue:`52335`)
5252
- :meth:`Series.plot` now correctly handle the ``ylabel`` parameter for pie charts, allowing for explicit control over the y-axis label (:issue:`58239`)
53+
- :meth:`pandas.concat` will raise a ``ValueError`` when ``ignore_index=True`` and ``keys`` is not ``None`` (:issue:`59274`)
54+
- Multiplying two :class:`DateOffset` objects will now raise a ``TypeError`` instead of a ``RecursionError`` (:issue:`59442`)
5355
- Restore support for reading Stata 104-format and enable reading 103-format dta files (:issue:`58554`)
5456
- Support reading Stata 102-format (Stata 1) dta files (:issue:`58978`)
5557
- Support reading Stata 110-format (Stata 7) dta files (:issue:`47176`)
@@ -617,6 +619,7 @@ Groupby/resample/rolling
617619

618620
Reshaping
619621
^^^^^^^^^
622+
- Bug in :func:`qcut` where values at the quantile boundaries could be incorrectly assigned (:issue:`59355`)
620623
- Bug in :meth:`DataFrame.join` inconsistently setting result index name (:issue:`55815`)
621624
- Bug in :meth:`DataFrame.unstack` producing incorrect results when ``sort=False`` (:issue:`54987`, :issue:`55516`)
622625
- Bug in :meth:`DataFrame.unstack` producing incorrect results when manipulating empty :class:`DataFrame` with an :class:`ExtentionDtype` (:issue:`59123`)

pandas/_libs/tslibs/offsets.pyx

+20-14
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,12 @@ cdef class BaseOffset:
491491
elif is_integer_object(other):
492492
return type(self)(n=other * self.n, normalize=self.normalize,
493493
**self.kwds)
494+
elif isinstance(other, BaseOffset):
495+
# Otherwise raises RecurrsionError due to __rmul__
496+
raise TypeError(
497+
f"Cannot multiply {type(self).__name__} with "
498+
f"{type(other).__name__}."
499+
)
494500
return NotImplemented
495501

496502
def __rmul__(self, other):
@@ -604,7 +610,7 @@ cdef class BaseOffset:
604610

605611
>>> pd.offsets.Week(5).rule_code
606612
'W'
607-
"""
613+
""" # noqa
608614
return self._prefix
609615

610616
@cache_readonly
@@ -632,7 +638,7 @@ cdef class BaseOffset:
632638

633639
>>> pd.offsets.Nano(-3).freqstr
634640
'-3ns'
635-
"""
641+
""" # noqa
636642
try:
637643
code = self.rule_code
638644
except NotImplementedError:
@@ -797,25 +803,25 @@ cdef class BaseOffset:
797803
@property
798804
def nanos(self):
799805
"""
800-
Returns a ValueError becuase the frequency is non-fixed.
801-
806+
Returns a ValueError because the frequency is non-fixed.
807+
802808
Raises
803809
------
804810
ValueError
805811
If the frequency is non-fixed.
806812
807813
See Also
808814
--------
809-
tseries.offsets.WeekOfMonth.nanos : Raises a ValueError becuase the frequency is non-fixed.
810-
tseries.offsets.YearBegin.nanos : Raises a ValueError becuase the frequency is non-fixed.
815+
tseries.offsets.WeekOfMonth.nanos : Raises a ValueError because the frequency is non-fixed.
816+
tseries.offsets.YearBegin.nanos : Raises a ValueError because the frequency is non-fixed.
811817
tseries.offsets.Hour.nanos : Returns an integer of the total number of nanoseconds.
812818
tseries.offsets.Day.nanos : Returns an integer of the total number of nanoseconds.
813819
814820
Examples
815821
--------
816822
>>> pd.offsets.Week(n=1).nanos
817-
ValueError: <5 * Weeks: weekday=None> is a non-fixed frequency
818-
"""
823+
ValueError: <Week: weekday=None> is a non-fixed frequency
824+
""" # noqa
819825
raise ValueError(f"{self} is a non-fixed frequency")
820826

821827
# ------------------------------------------------------------------
@@ -1029,14 +1035,14 @@ cdef class Tick(SingleConstructorOffset):
10291035
--------
10301036
tseries.offsets.Hour.nanos : Returns an integer of the total number of nanoseconds.
10311037
tseries.offsets.Day.nanos : Returns an integer of the total number of nanoseconds.
1032-
tseries.offsets.WeekOfMonth.nanos : Raises a ValueError becuase the frequency is non-fixed.
1033-
tseries.offsets.YearBegin.nanos : Raises a ValueError becuase the frequency is non-fixed.
1038+
tseries.offsets.WeekOfMonth.nanos : Raises a ValueError because the frequency is non-fixed.
1039+
tseries.offsets.YearBegin.nanos : Raises a ValueError because the frequency is non-fixed.
10341040

10351041
Examples
10361042
--------
10371043
>>> pd.offsets.Hour(5).nanos
10381044
18000000000000
1039-
"""
1045+
""" # noqa
10401046
return self.n * self._nanos_inc
10411047

10421048
def is_on_offset(self, dt: datetime) -> bool:
@@ -2480,7 +2486,7 @@ cdef class WeekOfMonthMixin(SingleConstructorOffset):
24802486

24812487
>>> pd.offsets.WeekOfMonth(n=1, week=0, weekday=0).rule_code
24822488
'WOM-1MON'
2483-
"""
2489+
""" # noqa
24842490
weekday = int_to_weekday.get(self.weekday, "")
24852491
if self.week == -1:
24862492
# LastWeekOfMonth
@@ -2542,7 +2548,7 @@ cdef class YearOffset(SingleConstructorOffset):
25422548

25432549
>>> pd.tseries.offsets.YearEnd(n=1, month=6).rule_code
25442550
'YE-JUN'
2545-
"""
2551+
""" # noqa
25462552
month = MONTH_ALIASES[self.month]
25472553
return f"{self._prefix}-{month}"
25482554

@@ -3544,7 +3550,7 @@ cdef class Week(SingleConstructorOffset):
35443550

35453551
>>> pd.offsets.Week(5).rule_code
35463552
'W'
3547-
"""
3553+
""" # noqa
35483554
suffix = ""
35493555
if self.weekday is not None:
35503556
weekday = int_to_weekday[self.weekday]

pandas/core/array_algos/quantile.py

+10-10
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ def quantile_with_mask(
9494
flat = np.array([fill_value] * len(qs))
9595
result = np.repeat(flat, len(values)).reshape(len(values), len(qs))
9696
else:
97-
result = _nanpercentile(
97+
result = _nanquantile(
9898
values,
99-
qs * 100.0,
99+
qs,
100100
na_value=fill_value,
101101
mask=mask,
102102
interpolation=interpolation,
@@ -108,15 +108,15 @@ def quantile_with_mask(
108108
return result
109109

110110

111-
def _nanpercentile_1d(
111+
def _nanquantile_1d(
112112
values: np.ndarray,
113113
mask: npt.NDArray[np.bool_],
114114
qs: npt.NDArray[np.float64],
115115
na_value: Scalar,
116116
interpolation: str,
117117
) -> Scalar | np.ndarray:
118118
"""
119-
Wrapper for np.percentile that skips missing values, specialized to
119+
Wrapper for np.quantile that skips missing values, specialized to
120120
1-dimensional case.
121121
122122
Parameters
@@ -142,7 +142,7 @@ def _nanpercentile_1d(
142142
# equiv: 'np.array([na_value] * len(qs))' but much faster
143143
return np.full(len(qs), na_value)
144144

145-
return np.percentile(
145+
return np.quantile(
146146
values,
147147
qs,
148148
# error: No overload variant of "percentile" matches argument
@@ -152,7 +152,7 @@ def _nanpercentile_1d(
152152
)
153153

154154

155-
def _nanpercentile(
155+
def _nanquantile(
156156
values: np.ndarray,
157157
qs: npt.NDArray[np.float64],
158158
*,
@@ -161,7 +161,7 @@ def _nanpercentile(
161161
interpolation: str,
162162
):
163163
"""
164-
Wrapper for np.percentile that skips missing values.
164+
Wrapper for np.quantile that skips missing values.
165165
166166
Parameters
167167
----------
@@ -180,7 +180,7 @@ def _nanpercentile(
180180

181181
if values.dtype.kind in "mM":
182182
# need to cast to integer to avoid rounding errors in numpy
183-
result = _nanpercentile(
183+
result = _nanquantile(
184184
values.view("i8"),
185185
qs=qs,
186186
na_value=na_value.view("i8"),
@@ -196,7 +196,7 @@ def _nanpercentile(
196196
# Caller is responsible for ensuring mask shape match
197197
assert mask.shape == values.shape
198198
result = [
199-
_nanpercentile_1d(val, m, qs, na_value, interpolation=interpolation)
199+
_nanquantile_1d(val, m, qs, na_value, interpolation=interpolation)
200200
for (val, m) in zip(list(values), list(mask))
201201
]
202202
if values.dtype.kind == "f":
@@ -215,7 +215,7 @@ def _nanpercentile(
215215
result = result.astype(values.dtype, copy=False)
216216
return result
217217
else:
218-
return np.percentile(
218+
return np.quantile(
219219
values,
220220
qs,
221221
axis=1,

0 commit comments

Comments
 (0)