Merge branch 'main' into DOC/59592/fix-docstring-validation-errors

Author: mroeschke

.circleci/config.yml

@@ -32,7 +32,7 @@ jobs:
             if pip show pandas 1>/dev/null; then
                 pip uninstall -y pandas
             fi
-            python -m pip install --no-build-isolation -ve . --config-settings=setup-args="--werror"
+            python -m pip install --no-build-isolation -ve . -Csetup-args="--werror"
             PATH=$HOME/miniconda3/envs/pandas-dev/bin:$HOME/miniconda3/condabin:$PATH
             sudo apt-get update && sudo apt-get install -y libegl1 libopengl0
             ci/run_tests.sh
@@ -57,7 +57,7 @@ jobs:
             . ~/virtualenvs/pandas-dev/bin/activate
             python -m pip install --no-cache-dir -U pip wheel setuptools meson-python==0.13.1 meson[ninja]==1.2.1
             python -m pip install --no-cache-dir versioneer[toml] cython numpy python-dateutil pytest>=7.3.2 pytest-xdist>=3.4.0 hypothesis>=6.84.0
-            python -m pip install --no-cache-dir --no-build-isolation -e . --config-settings=setup-args="--werror"
+            python -m pip install --no-cache-dir --no-build-isolation -e . -Csetup-args="--werror"
             python -m pip list --no-cache-dir
             export PANDAS_CI=1
             python -m pytest -m 'not slow and not network and not clipboard and not single_cpu' pandas --junitxml=test-data.xml

.github/actions/build_pandas/action.yml

@@ -22,13 +22,20 @@ runs:
         fi
       shell: bash -el {0}
 
+    - name: Uninstall nomkl
+      run: |
+        if conda list nomkl | grep nomkl 1>/dev/null; then
+          conda remove nomkl -y
+        fi
+      shell: bash -el {0}
+
     - name: Build Pandas
       run: |
         if [[ ${{ inputs.editable }} == "true" ]]; then
           pip install -e . --no-build-isolation -v --no-deps \
-            --config-settings=setup-args="--werror"
+            -Csetup-args="--werror"
         else
           pip install . --no-build-isolation -v --no-deps \
-            --config-settings=setup-args="--werror"
+            -Csetup-args="--werror"
         fi
       shell: bash -el {0}

.github/workflows/unit-tests.yml

@@ -235,9 +235,9 @@ jobs:
           /opt/python/cp311-cp311/bin/python -m venv ~/virtualenvs/pandas-dev
           . ~/virtualenvs/pandas-dev/bin/activate
           python -m pip install --no-cache-dir -U pip wheel setuptools meson[ninja]==1.2.1 meson-python==0.13.1
-          python -m pip install numpy --config-settings=setup-args="-Dallow-noblas=true"
+          python -m pip install numpy -Csetup-args="-Dallow-noblas=true"
           python -m pip install --no-cache-dir versioneer[toml] cython python-dateutil pytest>=7.3.2 pytest-xdist>=3.4.0 hypothesis>=6.84.0
-          python -m pip install --no-cache-dir --no-build-isolation -e . --config-settings=setup-args="--werror"
+          python -m pip install --no-cache-dir --no-build-isolation -e . -Csetup-args="--werror"
           python -m pip list --no-cache-dir
           export PANDAS_CI=1
           python -m pytest -m 'not slow and not network and not clipboard and not single_cpu' pandas --junitxml=test-data.xml
@@ -275,7 +275,7 @@ jobs:
           . ~/virtualenvs/pandas-dev/bin/activate
           python -m pip install --no-cache-dir -U pip wheel setuptools meson-python==0.13.1 meson[ninja]==1.2.1
           python -m pip install --no-cache-dir versioneer[toml] cython numpy python-dateutil pytest>=7.3.2 pytest-xdist>=3.4.0 hypothesis>=6.84.0
-          python -m pip install --no-cache-dir --no-build-isolation -e . --config-settings=setup-args="--werror"
+          python -m pip install --no-cache-dir --no-build-isolation -e . -Csetup-args="--werror"
           python -m pip list --no-cache-dir
 
       - name: Run Tests
@@ -349,7 +349,7 @@ jobs:
           python -m pip install --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple numpy
           python -m pip install versioneer[toml]
           python -m pip install python-dateutil tzdata cython hypothesis>=6.84.0 pytest>=7.3.2 pytest-xdist>=3.4.0 pytest-cov
-          python -m pip install -ve . --no-build-isolation --no-index --no-deps --config-settings=setup-args="--werror"
+          python -m pip install -ve . --no-build-isolation --no-index --no-deps -Csetup-args="--werror"
           python -m pip list
 
       - name: Run Tests
@@ -392,7 +392,7 @@ jobs:
           python -m pip install --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple numpy cython
           python -m pip install versioneer[toml]
           python -m pip install python-dateutil pytz tzdata hypothesis>=6.84.0 pytest>=7.3.2 pytest-xdist>=3.4.0 pytest-cov
-          python -m pip install -ve . --no-build-isolation --no-index --no-deps --config-settings=setup-args="--werror"
+          python -m pip install -ve . --no-build-isolation --no-index --no-deps -Csetup-args="--werror"
           python -m pip list
 
       - name: Run Tests

.gitpod.yml

@@ -13,10 +13,10 @@ tasks:
       mkdir -p .vscode
       cp gitpod/settings.json .vscode/settings.json
       git fetch --tags
-      python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true
+      python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true
       pre-commit install --install-hooks
     command: |
-      python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true
+      python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true
       echo "✨ Pre-build complete! You can close this terminal ✨ "
 
 # --------------------------------------------------------

.pre-commit-config.yaml

@@ -23,6 +23,7 @@ repos:
     hooks:
     -   id: ruff
         args: [--exit-non-zero-on-fix]
+        exclude: ^pandas/tests/frame/test_query_eval.py
     -   id: ruff
         # TODO: remove autofixe-only rules when they are checked by ruff
         name: ruff-selected-autofixes
@@ -31,7 +32,7 @@ repos:
         exclude: ^pandas/tests
         args: [--select, "ANN001,ANN2", --fix-only, --exit-non-zero-on-fix]
     -   id: ruff-format
-        exclude: ^scripts
+        exclude: ^scripts|^pandas/tests/frame/test_query_eval.py
 -   repo: https://github.com/jendrikseipp/vulture
     rev: 'v2.11'
     hooks:
@@ -85,6 +86,7 @@ repos:
         types: [text]  # overwrite types: [rst]
         types_or: [python, rst]
       - id: rst-inline-touching-normal
+        exclude: ^pandas/tests/frame/test_query_eval.py
         types: [text]  # overwrite types: [rst]
         types_or: [python, rst]
 -   repo: https://github.com/sphinx-contrib/sphinx-lint

README.md

@@ -138,7 +138,7 @@ or for installing in [development mode](https://pip.pypa.io/en/latest/cli/pip_in
 
 
 ```sh
-python -m pip install -ve . --no-build-isolation --config-settings=editable-verbose=true
+python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true
 ```
 
 See the full instructions for [installing from source](https://pandas.pydata.org/docs/dev/development/contributing_environment.html).

ci/code_checks.sh

@@ -132,35 +132,13 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.Series.dt.tz_convert PR01,PR02" \
         -i "pandas.Series.dt.tz_localize PR01,PR02" \
         -i "pandas.Series.dt.unit GL08" \
-        -i "pandas.Series.gt SA01" \
-        -i "pandas.Series.list.__getitem__ SA01" \
-        -i "pandas.Series.list.flatten SA01" \
-        -i "pandas.Series.list.len SA01" \
-        -i "pandas.Series.lt SA01" \
-        -i "pandas.Series.ne SA01" \
         -i "pandas.Series.pad PR01,SA01" \
-        -i "pandas.Series.pop SA01" \
-        -i "pandas.Series.prod RT03" \
-        -i "pandas.Series.product RT03" \
-        -i "pandas.Series.reorder_levels RT03,SA01" \
-        -i "pandas.Series.sem PR01,RT03,SA01" \
         -i "pandas.Series.sparse PR01,SA01" \
-        -i "pandas.Series.sparse.density SA01" \
         -i "pandas.Series.sparse.fill_value SA01" \
         -i "pandas.Series.sparse.from_coo PR07,SA01" \
         -i "pandas.Series.sparse.npoints SA01" \
         -i "pandas.Series.sparse.sp_values SA01" \
         -i "pandas.Series.sparse.to_coo PR07,RT03,SA01" \
-        -i "pandas.Series.std PR01,RT03,SA01" \
-        -i "pandas.Series.str.match RT03" \
-        -i "pandas.Series.str.normalize RT03,SA01" \
-        -i "pandas.Series.str.repeat SA01" \
-        -i "pandas.Series.str.replace SA01" \
-        -i "pandas.Series.str.wrap RT03,SA01" \
-        -i "pandas.Series.str.zfill RT03" \
-        -i "pandas.Series.struct.dtypes SA01" \
-        -i "pandas.Series.to_markdown SA01" \
-        -i "pandas.Series.update PR07,SA01" \
         -i "pandas.Timedelta.asm8 SA01" \
         -i "pandas.Timedelta.ceil SA01" \
         -i "pandas.Timedelta.components SA01" \
@@ -178,37 +156,15 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.TimedeltaIndex.nanoseconds SA01" \
         -i "pandas.TimedeltaIndex.seconds SA01" \
         -i "pandas.TimedeltaIndex.to_pytimedelta RT03,SA01" \
-        -i "pandas.Timestamp.day GL08" \
         -i "pandas.Timestamp.fold GL08" \
-        -i "pandas.Timestamp.hour GL08" \
         -i "pandas.Timestamp.max PR02" \
-        -i "pandas.Timestamp.microsecond GL08" \
         -i "pandas.Timestamp.min PR02" \
-        -i "pandas.Timestamp.minute GL08" \
-        -i "pandas.Timestamp.month GL08" \
         -i "pandas.Timestamp.nanosecond GL08" \
         -i "pandas.Timestamp.resolution PR02" \
-        -i "pandas.Timestamp.second GL08" \
-        -i "pandas.Timestamp.strptime PR01,SA01" \
-        -i "pandas.Timestamp.timetz SA01" \
-        -i "pandas.Timestamp.to_datetime64 SA01" \
         -i "pandas.Timestamp.tzinfo GL08" \
         -i "pandas.Timestamp.value GL08" \
         -i "pandas.Timestamp.year GL08" \
-        -i "pandas.api.extensions.ExtensionArray._pad_or_backfill PR01,RT03,SA01" \
-        -i "pandas.api.extensions.ExtensionArray._reduce RT03,SA01" \
-        -i "pandas.api.extensions.ExtensionArray._values_for_factorize SA01" \
-        -i "pandas.api.extensions.ExtensionArray.astype SA01" \
-        -i "pandas.api.extensions.ExtensionArray.dropna RT03,SA01" \
-        -i "pandas.api.extensions.ExtensionArray.dtype SA01" \
-        -i "pandas.api.extensions.ExtensionArray.duplicated RT03,SA01" \
-        -i "pandas.api.extensions.ExtensionArray.fillna SA01" \
-        -i "pandas.api.extensions.ExtensionArray.insert PR07,RT03,SA01" \
         -i "pandas.api.extensions.ExtensionArray.interpolate PR01,SA01" \
-        -i "pandas.api.extensions.ExtensionArray.isin PR07,RT03,SA01" \
-        -i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \
-        -i "pandas.api.extensions.ExtensionArray.unique RT03,SA01" \
-        -i "pandas.api.extensions.ExtensionArray.view SA01" \
         -i "pandas.api.interchange.from_dataframe RT03,SA01" \
         -i "pandas.api.types.is_bool PR01,SA01" \
         -i "pandas.api.types.is_categorical_dtype SA01" \
@@ -261,7 +217,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \
         -i "pandas.core.groupby.DataFrameGroupBy.ohlc SA01" \
         -i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
-        -i "pandas.core.groupby.DataFrameGroupBy.prod SA01" \
         -i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \
         -i "pandas.core.groupby.DataFrameGroupBy.sum SA01" \
         -i "pandas.core.groupby.SeriesGroupBy.__iter__ RT03,SA01" \
@@ -278,7 +233,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.core.groupby.SeriesGroupBy.nth PR02" \
         -i "pandas.core.groupby.SeriesGroupBy.ohlc SA01" \
         -i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
-        -i "pandas.core.groupby.SeriesGroupBy.prod SA01" \
         -i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
         -i "pandas.core.groupby.SeriesGroupBy.sum SA01" \
         -i "pandas.core.resample.Resampler.__iter__ RT03,SA01" \
@@ -331,34 +285,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.errors.UnsupportedFunctionCall SA01" \
         -i "pandas.errors.ValueLabelTypeMismatch SA01" \
         -i "pandas.infer_freq SA01" \
-        -i "pandas.io.formats.style.Styler.apply RT03" \
-        -i "pandas.io.formats.style.Styler.apply_index RT03" \
-        -i "pandas.io.formats.style.Styler.background_gradient RT03" \
-        -i "pandas.io.formats.style.Styler.bar RT03,SA01" \
-        -i "pandas.io.formats.style.Styler.clear SA01" \
-        -i "pandas.io.formats.style.Styler.concat RT03,SA01" \
-        -i "pandas.io.formats.style.Styler.export RT03" \
-        -i "pandas.io.formats.style.Styler.from_custom_template SA01" \
-        -i "pandas.io.formats.style.Styler.hide RT03,SA01" \
-        -i "pandas.io.formats.style.Styler.highlight_between RT03" \
-        -i "pandas.io.formats.style.Styler.highlight_max RT03" \
-        -i "pandas.io.formats.style.Styler.highlight_min RT03" \
-        -i "pandas.io.formats.style.Styler.highlight_null RT03" \
-        -i "pandas.io.formats.style.Styler.highlight_quantile RT03" \
-        -i "pandas.io.formats.style.Styler.map RT03" \
-        -i "pandas.io.formats.style.Styler.map_index RT03" \
-        -i "pandas.io.formats.style.Styler.set_caption RT03,SA01" \
-        -i "pandas.io.formats.style.Styler.set_properties RT03,SA01" \
-        -i "pandas.io.formats.style.Styler.set_sticky RT03,SA01" \
-        -i "pandas.io.formats.style.Styler.set_table_attributes PR07,RT03" \
-        -i "pandas.io.formats.style.Styler.set_table_styles RT03" \
-        -i "pandas.io.formats.style.Styler.set_td_classes RT03" \
-        -i "pandas.io.formats.style.Styler.set_tooltips RT03,SA01" \
-        -i "pandas.io.formats.style.Styler.set_uuid PR07,RT03,SA01" \
-        -i "pandas.io.formats.style.Styler.text_gradient RT03" \
-        -i "pandas.io.formats.style.Styler.to_excel PR01" \
-        -i "pandas.io.formats.style.Styler.to_string SA01" \
-        -i "pandas.io.formats.style.Styler.use RT03" \
         -i "pandas.io.json.build_table_schema PR07,RT03,SA01" \
         -i "pandas.io.stata.StataReader.data_label SA01" \
         -i "pandas.io.stata.StataReader.value_labels RT03,SA01" \

doc/source/development/contributing_environment.rst

@@ -227,7 +227,7 @@ To compile pandas with meson, run::
    # By default, this will print verbose output
    # showing the "rebuild" taking place on import (see section below for explanation)
    # If you do not want to see this, omit everything after --no-build-isolation
-   python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true
+   python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true
 
 .. note::
    The version number is pulled from the latest repository tag. Be sure to fetch the latest tags from upstream
@@ -242,15 +242,15 @@ To compile pandas with meson, run::
 It is possible to pass options from the pip frontend to the meson backend if you would like to configure your
 install. Occasionally, you'll want to use this to adjust the build directory, and/or toggle debug/optimization levels.
 
-You can pass a build directory to pandas by appending ``--config-settings builddir="your builddir here"`` to your pip command.
+You can pass a build directory to pandas by appending ``-Cbuilddir="your builddir here"`` to your pip command.
 This option allows you to configure where meson stores your built C extensions, and allows for fast rebuilds.
 
 Sometimes, it might be useful to compile pandas with debugging symbols, when debugging C extensions.
-Appending ``--config-settings setup-args="-Ddebug=true"`` will do the trick.
+Appending ``-Csetup-args="-Ddebug=true"`` will do the trick.
 
 With pip, it is possible to chain together multiple config settings (for example specifying both a build directory
 and building with debug symbols would look like
-``--config-settings builddir="your builddir here" --config-settings=setup-args="-Dbuildtype=debug"``.
+``-Cbuilddir="your builddir here" -Csetup-args="-Dbuildtype=debug"``.
 
 **Compiling pandas with setup.py**
 
@@ -291,7 +291,7 @@ At this point you may want to try
 
 When building pandas with meson, importing pandas will automatically trigger a rebuild, even when C/Cython files are modified.
 By default, no output will be produced by this rebuild (the import will just take longer). If you would like to see meson's
-output when importing pandas, you can set the environment variable ``MESONPY_EDTIABLE_VERBOSE``. For example, this would be::
+output when importing pandas, you can set the environment variable ``MESONPY_EDITABLE_VERBOSE``. For example, this would be::
 
    # On Linux/macOS
    MESONPY_EDITABLE_VERBOSE=1 python
@@ -302,7 +302,7 @@ output when importing pandas, you can set the environment variable ``MESONPY_EDT
 
 If you would like to see this verbose output every time, you can set the ``editable-verbose`` config setting to ``true`` like so::
 
-   python -m pip install -ve . --config-settings editable-verbose=true
+   python -m pip install -ve . -Ceditable-verbose=true
 
 .. tip::
    If you ever find yourself wondering whether setuptools or meson was used to build your pandas,

doc/source/development/debugging_extensions.rst

@@ -19,7 +19,7 @@ Debugging locally
 
 By default building pandas from source will generate a release build. To generate a development build you can type::
 
-    pip install -ve . --no-build-isolation --config-settings=builddir="debug" --config-settings=setup-args="-Dbuildtype=debug"
+    pip install -ve . --no-build-isolation -Cbuilddir="debug" -Csetup-args="-Dbuildtype=debug"
 
 .. note::
 
@@ -42,7 +42,7 @@ Inside the image, you can use meson to build/install pandas and place the build
 
 .. code-block:: sh
 
-    python -m pip install -ve . --no-build-isolation --config-settings=builddir="debug" --config-settings=setup-args="-Dbuildtype=debug"
+    python -m pip install -ve . --no-build-isolation -Cbuilddir="debug" -Csetup-args="-Dbuildtype=debug"
 
 If planning to use cygdb, the files required by that application are placed within the build folder. So you have to first ``cd`` to the build folder, then start that application.
 

doc/source/development/maintaining.rst

@@ -157,15 +157,15 @@ and then run::
     git bisect start
     git bisect good v1.4.0
     git bisect bad v1.5.0
-    git bisect run bash -c "python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true; python t.py"
+    git bisect run bash -c "python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true; python t.py"
 
 This finds the first commit that changed the behavior. The C extensions have to be
 rebuilt at every step, so the search can take a while.
 
 Exit bisect and rebuild the current version::
 
     git bisect reset
-    python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true
+    python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true
 
 Report your findings under the corresponding issue and ping the commit author to get
 their input.