Merge branch 'main' into ig/fix_extension_indexer

pydata · Feb 21, 2025 · 62f3892 · 62f3892
2 parents 1a7650c + 0caf096
commit 62f3892
Show file tree

Hide file tree

Showing 38 changed files with 1,835 additions and 255 deletions.
diff --git a/.github/workflows/ci-additional.yaml b/.github/workflows/ci-additional.yaml
@@ -116,7 +116,7 @@ jobs:
           python xarray/util/print_versions.py
       - name: Install mypy
         run: |
-          python -m pip install "mypy==1.13" --force-reinstall
+          python -m pip install "mypy==1.15" --force-reinstall
 
       - name: Run mypy
         run: |
@@ -167,7 +167,7 @@ jobs:
           python xarray/util/print_versions.py
       - name: Install mypy
         run: |
-          python -m pip install "mypy==1.13" --force-reinstall
+          python -m pip install "mypy==1.15" --force-reinstall
 
       - name: Run mypy
         run: |

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -47,7 +47,7 @@ jobs:
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
         # Bookend python versions
-        python-version: ["3.10", "3.12"]
+        python-version: ["3.10", "3.13"]
         env: [""]
         include:
           # Minimum python version:
@@ -59,14 +59,23 @@ jobs:
             os: ubuntu-latest
           # Latest python version:
           - env: "all-but-numba"
-            python-version: "3.12"
+            python-version: "3.13"
             os: ubuntu-latest
           - env: "all-but-dask"
-            # Not 3.12 because of pint
-            python-version: "3.11"
+            python-version: "3.12"
             os: ubuntu-latest
           - env: "flaky"
-            python-version: "3.12"
+            python-version: "3.13"
+            os: ubuntu-latest
+          # The mypy tests must be executed using only 1 process in order to guarantee
+          # predictable mypy output messages for comparison to expectations.
+          - env: "mypy"
+            python-version: "3.10"
+            numprocesses: 1
+            os: ubuntu-latest
+          - env: "mypy"
+            python-version: "3.13"
+            numprocesses: 1
             os: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -78,17 +87,21 @@ jobs:
 
           if [[ ${{ matrix.os }} == windows* ]] ;
           then
-            if [[ ${{ matrix.python-version }} != "3.13" ]]; then
+            if [[ ${{ matrix.python-version }} != "3.14" ]]; then
               echo "CONDA_ENV_FILE=ci/requirements/environment-windows.yml" >> $GITHUB_ENV
             else
-              echo "CONDA_ENV_FILE=ci/requirements/environment-windows-3.13.yml" >> $GITHUB_ENV
+              echo "CONDA_ENV_FILE=ci/requirements/environment-windows-3.14.yml" >> $GITHUB_ENV
             fi
           elif [[ "${{ matrix.env }}" != "" ]] ;
           then
             if [[ "${{ matrix.env }}" == "flaky" ]] ;
             then
               echo "CONDA_ENV_FILE=ci/requirements/environment.yml" >> $GITHUB_ENV
               echo "PYTEST_ADDOPTS=-m 'flaky or network' --run-flaky --run-network-tests -W default" >> $GITHUB_ENV
+            elif [[ "${{ matrix.env }}" == "mypy" ]] ;
+            then
+              echo "CONDA_ENV_FILE=ci/requirements/environment.yml" >> $GITHUB_ENV
+              echo "PYTEST_ADDOPTS=-n 1 -m 'mypy' --run-mypy -W default" >> $GITHUB_ENV
             else
               echo "CONDA_ENV_FILE=ci/requirements/${{ matrix.env }}.yml" >> $GITHUB_ENV
             fi
@@ -98,10 +111,10 @@ jobs:
               echo "PYTEST_ADDOPTS=-W default" >> $GITHUB_ENV
             fi
           else
-            if [[ ${{ matrix.python-version }} != "3.13" ]]; then
+            if [[ ${{ matrix.python-version }} != "3.14" ]]; then
               echo "CONDA_ENV_FILE=ci/requirements/environment.yml" >> $GITHUB_ENV
             else
-              echo "CONDA_ENV_FILE=ci/requirements/environment-3.13.yml" >> $GITHUB_ENV
+              echo "CONDA_ENV_FILE=ci/requirements/environment-3.14.yml" >> $GITHUB_ENV
             fi
           fi
 
@@ -145,7 +158,7 @@ jobs:
           save-always: true
 
       - name: Run tests
-        run: python -m pytest -n 4
+        run: python -m pytest -n ${{ matrix.numprocesses || 4 }}
           --timeout 180
           --cov=xarray
           --cov-report=xml

diff --git a/ci/minimum_versions.py b/ci/minimum_versions.py
@@ -26,8 +26,9 @@
     "pytest",
     "pytest-cov",
     "pytest-env",
-    "pytest-xdist",
+    "pytest-mypy-plugins",
     "pytest-timeout",
+    "pytest-xdist",
     "hypothesis",
 ]
 

diff --git a/ci/requirements/all-but-dask.yml b/ci/requirements/all-but-dask.yml
@@ -30,8 +30,9 @@ dependencies:
   - pytest
   - pytest-cov
   - pytest-env
-  - pytest-xdist
+  - pytest-mypy-plugins
   - pytest-timeout
+  - pytest-xdist
   - rasterio
   - scipy
   - seaborn

diff --git a/ci/requirements/all-but-numba.yml b/ci/requirements/all-but-numba.yml
@@ -43,8 +43,9 @@ dependencies:
   - pytest
   - pytest-cov
   - pytest-env
-  - pytest-xdist
+  - pytest-mypy-plugins
   - pytest-timeout
+  - pytest-xdist
   - rasterio
   - scipy
   - seaborn

diff --git a/ci/requirements/bare-minimum.yml b/ci/requirements/bare-minimum.yml
@@ -9,8 +9,9 @@ dependencies:
   - pytest
   - pytest-cov
   - pytest-env
-  - pytest-xdist
+  - pytest-mypy-plugins
   - pytest-timeout
+  - pytest-xdist
   - numpy=1.24
   - packaging=23.1
   - pandas=2.1
diff --git a/ci/requirements/environment-3.13.yml → ci/requirements/environment-3.14.yml b/ci/requirements/environment-3.13.yml → ci/requirements/environment-3.14.yml
@@ -29,22 +29,35 @@ dependencies:
   - opt_einsum
   - packaging
   - pandas
+  - pandas-stubs
   # - pint>=0.22
   - pip
   - pooch
   - pre-commit
+  - pyarrow # pandas raises a deprecation warning without this, breaking doctests
   - pydap
   - pytest
   - pytest-cov
   - pytest-env
-  - pytest-xdist
+  - pytest-mypy-plugins
   - pytest-timeout
+  - pytest-xdist
   - rasterio
   - scipy
   - seaborn
   # - sparse
   - toolz
+  - types-colorama
+  - types-docutils
+  - types-psutil
+  - types-Pygments
+  - types-python-dateutil
+  - types-pytz
+  - types-PyYAML
+  - types-setuptools
   - typing_extensions
   - zarr
   - pip:
       - jax # no way to get cpu-only jaxlib from conda if gpu is present
+      - types-defusedxml
+      - types-pexpect
diff --git a/ci/requirements/environment-windows-3.13.yml → ci/requirements/environment-windows-3.14.yml b/ci/requirements/environment-windows-3.13.yml → ci/requirements/environment-windows-3.14.yml
@@ -25,6 +25,7 @@ dependencies:
   - numpy
   - packaging
   - pandas
+  - pandas-stubs
   # - pint>=0.22
   - pip
   - pre-commit
@@ -33,12 +34,24 @@ dependencies:
   - pytest
   - pytest-cov
   - pytest-env
-  - pytest-xdist
+  - pytest-mypy-plugins
   - pytest-timeout
+  - pytest-xdist
   - rasterio
   - scipy
   - seaborn
   # - sparse
   - toolz
+  - types-colorama
+  - types-docutils
+  - types-psutil
+  - types-Pygments
+  - types-python-dateutil
+  - types-pytz
+  - types-PyYAML
+  - types-setuptools
   - typing_extensions
   - zarr
+  - pip:
+      - types-defusedxml
+      - types-pexpect
diff --git a/ci/requirements/environment-windows.yml b/ci/requirements/environment-windows.yml
@@ -25,6 +25,7 @@ dependencies:
   - numpy
   - packaging
   - pandas
+  - pandas-stubs
   # - pint>=0.22
   - pip
   - pre-commit
@@ -33,12 +34,24 @@ dependencies:
   - pytest
   - pytest-cov
   - pytest-env
-  - pytest-xdist
+  - pytest-mypy-plugins
   - pytest-timeout
+  - pytest-xdist
   - rasterio
   - scipy
   - seaborn
   - sparse
   - toolz
+  - types-colorama
+  - types-docutils
+  - types-psutil
+  - types-Pygments
+  - types-python-dateutil
+  - types-pytz
+  - types-PyYAML
+  - types-setuptools
   - typing_extensions
   - zarr
+  - pip:
+      - types-defusedxml
+      - types-pexpect
diff --git a/ci/requirements/environment.yml b/ci/requirements/environment.yml
@@ -29,6 +29,7 @@ dependencies:
   - opt_einsum
   - packaging
   - pandas
+  - pandas-stubs
   # - pint>=0.22
   - pip
   - pooch
@@ -39,14 +40,25 @@ dependencies:
   - pytest
   - pytest-cov
   - pytest-env
-  - pytest-xdist
+  - pytest-mypy-plugins
   - pytest-timeout
+  - pytest-xdist
   - rasterio
   - scipy
   - seaborn
   - sparse
   - toolz
+  - types-colorama
+  - types-docutils
+  - types-psutil
+  - types-Pygments
+  - types-python-dateutil
+  - types-pytz
+  - types-PyYAML
+  - types-setuptools
   - typing_extensions
   - zarr
   - pip:
       - jax # no way to get cpu-only jaxlib from conda if gpu is present
+      - types-defusedxml
+      - types-pexpect
diff --git a/ci/requirements/min-all-deps.yml b/ci/requirements/min-all-deps.yml
@@ -46,8 +46,9 @@ dependencies:
   - pytest
   - pytest-cov
   - pytest-env
-  - pytest-xdist
+  - pytest-mypy-plugins
   - pytest-timeout
+  - pytest-xdist
   - rasterio=1.3
   - scipy=1.11
   - seaborn=0.13

diff --git a/conftest.py b/conftest.py
@@ -3,14 +3,15 @@
 import pytest
 
 
-def pytest_addoption(parser):
+def pytest_addoption(parser: pytest.Parser):
     """Add command-line flags for pytest."""
     parser.addoption("--run-flaky", action="store_true", help="runs flaky tests")
     parser.addoption(
         "--run-network-tests",
         action="store_true",
         help="runs tests requiring a network connection",
     )
+    parser.addoption("--run-mypy", action="store_true", help="runs mypy tests")
 
 
 def pytest_runtest_setup(item):
@@ -21,6 +22,21 @@ def pytest_runtest_setup(item):
         pytest.skip(
             "set --run-network-tests to run test requiring an internet connection"
         )
+    if "mypy" in item.keywords and not item.config.getoption("--run-mypy"):
+        pytest.skip("set --run-mypy option to run mypy tests")
+
+
+# See https://docs.pytest.org/en/stable/example/markers.html#automatically-adding-markers-based-on-test-names
+def pytest_collection_modifyitems(items):
+    for item in items:
+        if "mypy" in item.nodeid:
+            # IMPORTANT: mypy type annotation tests leverage the pytest-mypy-plugins
+            # plugin, and are thus written in test_*.yml files.  As such, there are
+            # no explicit test functions on which we can apply a pytest.mark.mypy
+            # decorator.  Therefore, we mark them via this name-based, automatic
+            # marking approach, meaning that each test case must contain "mypy" in the
+            # name.
+            item.add_marker(pytest.mark.mypy)
 
 
 @pytest.fixture(autouse=True)