Merge branch 'main' into pylint-fixes

.github/workflows/main.yml

@@ -19,7 +19,7 @@ on:
       - submitted
 
 env:
-  XCLIM_TESTDATA_BRANCH: v2023.12.14
+  XCLIM_TESTDATA_BRANCH: v2024.8.23
 
 concurrency:
   # For a given workflow, if we push to the same branch, cancel all previous builds on that branch except on main.

CHANGELOG.rst

@@ -12,10 +12,19 @@ Bug fixes
 
 Breaking changes
 ^^^^^^^^^^^^^^^^
+* `platformdirs` is no longer a direct dependency of `xclim`, but `pooch` is required to use many of the new testing functions (installable via `pip install pooch` or `pip install 'xclim[dev]'`). (:pull:`1889`).
 * The following previously-deprecated functions have now been removed from `xclim`: ``xclim.core.calendar.convert_calendar``, ``xclim.core.calendar.date_range``, ``xclim.core.calendar.date_range_like``, ``xclim.core.calendar.interp_calendar``, ``xclim.core.calendar.days_in_year``, ``xclim.core.calendar.datetime_to_decimal_year``. For guidance on how to migrate to alternatives, see the `version 0.50.0 Breaking changes <#v0-50-0-2024-06-17>`_. (:issue:`1010`, :pull:`1845`).
 
 Internal changes
 ^^^^^^^^^^^^^^^^
+* The `Ouranosinc/xclim-testdata` repository has been restructured for better organization and to make better use of `pooch` and data registries for testing data fetching (see: `xclim-testdata PR/29 <https://github.com/Ouranosinc/xclim-testdata/pull/29>`_). (:pull:`1889`).
+* The ``xclim.testing`` module has been refactored to make use of `pooch` with file registries. Several testing functions have been removed as a result: (:pull:`1889`)
+    * ``xclim.testing.utils.open_dataset`` now uses a `pooch` instance to deliver locally-stored datasets. Its call signature has also changed.
+    * ``xclim`` now accepts more environment variables to control the behaviour of the testing setup functions. These include ``XCLIM_TESTDATA_BRANCH``, ``XCLIM_TESTDATA_REPO_URL``, and ``XCLIM_TESTDATA_CACHE_DIR``.
+    * ``xclim.testing.utils.get_file``, ``xclim.testing.utils.get_local_testdata``, ``xclim.testing.utils.list_datasets``, and ``xclim.testing.utils.file_md5_checksum`` have been removed.
+        * ``xclim.testing.utils.nimbus`` replaces much of this functionality. See the `xclim` documentation for more information.
+* Many tests focused on evaluating the normal operation of remote file access tools under ``xclim.testing`` have been removed. (:pull:`1889`).
+* Setup and teardown functions that were found under ``tests/conftest.py`` have been optimized to reduce redundant calls when running ``pytest xclim``. Some obsolete `pytest` fixtures have also been removed.(:pull:`1889`).
 * Many ``DeprecationWarning`` and ``FutureWarning`` messages emitted from `xarray` and `pint` have been addressed. (:issue:`1719`, :pull:`1881`).
 * The codebase has been adjusted to address many `pylint`-related warnings and errors. In some cases, `casting` was used to redefine some `numpy` and `xarray` objects. (:issue:`1719`, :pull:`1881`).
 

CONTRIBUTING.rst

@@ -269,21 +269,22 @@ Updating Testing Data
 
 If your code changes require changes to the testing data of `xclim` (i.e.: modifications to existing datasets or new datasets), these changes must be made via a Pull Request at the `xclim-testdata repository`_.
 
-`xclim` allows for developers to test specific branches/versions of `xclim-testdata` via the `XCLIM_TESTDATA_BRANCH` environment variable, either through export, e.g.::
+`xclim` allows for developers to test specific branches/versions or forks of the `xclim-testdata` repository via the `XCLIM_TESTDATA_BRANCH` and `XCLIM_TESTDATA_REPO` environment variables, respectively, either through export, e.g.::
 
     $ export XCLIM_TESTDATA_BRANCH="my_new_branch_of_testing_data"
+    $ export XCLIM_TESTDATA_REPO="https://github.com/my_username/xclim-testdata"
 
     $ pytest
     # or, alternatively:
     $ tox
 
 or by setting the variable at runtime::
 
-    $ env XCLIM_TESTDATA_BRANCH="my_new_branch_of_testing_data" pytest
+    $ env XCLIM_TESTDATA_BRANCH="my_new_branch_of_testing_data" XCLIM_TESTDATA_REPO="https://github.com/my_username/xclim-testdata" pytest
     # or, alternatively:
-    $ env XCLIM_TESTDATA_BRANCH="my_new_branch_of_testing_data" tox
+    $ env XCLIM_TESTDATA_BRANCH="my_new_branch_of_testing_data" XCLIM_TESTDATA_REPO="https://github.com/my_username/xclim-testdata" tox
 
-This will ensure that tests load the testing data from this branch before running.
+This will ensure that tests load the appropriate testing data from this branch or repository before running.
 
 If you anticipate not having internet access, we suggest prefetching the testing data from `xclim-testdata repository`_ and storing it in your local cache. This can be done by running the following console command::
 
@@ -296,7 +297,7 @@ If your development branch relies on a specific branch of `Ouranosinc/xclim-test
 
 or, alternatively, with the `--branch` option::
 
-    $ xclim prefetch_testing_data --branch my_new_branch_of_testing_data
+    $ xclim prefetch_testing_data --branch my_new_branch_of_testing_data --repo "https://github.com/my_username/xclim-testdata"
 
 If you wish to test a specific branch using GitHub CI, this can be set in `.github/workflows/main.yml`:
 
@@ -306,7 +307,7 @@ If you wish to test a specific branch using GitHub CI, this can be set in `.gith
       XCLIM_TESTDATA_BRANCH: my_new_branch_of_testing_data
 
 .. warning::
-    In order for a Pull Request to be allowed to merge to main development branch, this variable must match the latest tagged commit name on `xclim-testdata repository`_.
+    In order for a Pull Request to be allowed to merge to the `main` development branch, this variable must match the latest tagged commit name on `xclim-testdata repository`_.
     We suggest merging changed testing data first, tagging a new version of `xclim-testdata`, then re-running tests on your Pull Request at `Ouranosinc/xclim` with the newest tag.
 
 Running Tests in Offline Mode
@@ -323,8 +324,8 @@ or, alternatively, using `tox` ::
 
     $ tox -e offline
 
-These options will disable all network calls and skip tests marked with the `requires_internet` marker.
-The `--allow-unix-socket` option is required to allow the `pytest-xdist`_ plugin to function properly.
+These options will disable all network calls and skip tests marked with the ``requires_internet`` marker.
+The ``--allow-unix-socket`` option is required to allow the `pytest-xdist`_ plugin to function properly.
 
 Tips
 ----

docs/notebooks/analogs.ipynb

@@ -24,9 +24,9 @@
     "from __future__ import annotations\n",
     "\n",
     "import matplotlib.pyplot as plt\n",
+    "from xarray.coding.calendar_ops import convert_calendar\n",
     "\n",
     "from xclim import analog\n",
-    "from xclim.core.calendar import convert_calendar\n",
     "from xclim.testing import open_dataset"
    ]
   },
@@ -105,7 +105,7 @@
    "outputs": [],
    "source": [
     "fig, axs = plt.subplots(nrows=3, figsize=(6, 6), sharex=True)\n",
-    "sim_std = convert_calendar(sim, \"default\")\n",
+    "sim_std = convert_calendar(sim, \"standard\")\n",
     "obs_chibou = obs.sel(lat=sim.lat, lon=sim.lon, method=\"nearest\")\n",
     "\n",
     "for ax, var in zip(axs, obs_chibou.data_vars.keys()):\n",
@@ -258,7 +258,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.12.5"
   }
  },
  "nbformat": 4,

docs/notebooks/cli.ipynb

@@ -90,8 +90,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from __future__ import annotations\n",
-    "\n",
     "import warnings\n",
     "\n",
     "import numpy as np\n",

docs/notebooks/customize.ipynb

@@ -19,8 +19,7 @@
     "\n",
     "import xarray as xr\n",
     "\n",
-    "import xclim\n",
-    "from xclim.testing import open_dataset"
+    "import xclim"
    ]
   },
   {

docs/notebooks/ensembles.ipynb

@@ -155,8 +155,6 @@
    },
    "outputs": [],
    "source": [
-    "from pathlib import Path\n",
-    "\n",
     "import xarray as xr\n",
     "\n",
     "# Set display to HTML style (for fancy output)\n",
@@ -165,10 +163,10 @@
     "import matplotlib as mpl\n",
     "import matplotlib.pyplot as plt\n",
     "\n",
-    "%matplotlib inline\n",
-    "\n",
     "from xclim import ensembles\n",
     "\n",
+    "%matplotlib inline\n",
+    "\n",
     "ens = ensembles.create_ensemble(data_folder.glob(\"ens_tas_m*.nc\")).load()\n",
     "ens.close()"
    ]

docs/notebooks/extendxclim.ipynb

@@ -599,7 +599,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.4"
+   "version": "3.12.5"
   },
   "toc": {
    "base_numbering": 1,

docs/notebooks/sdba-advanced.ipynb

@@ -54,7 +54,6 @@
     "from __future__ import annotations\n",
     "\n",
     "import matplotlib.pyplot as plt\n",
-    "import nc_time_axis\n",
     "import numpy as np\n",
     "import xarray as xr\n",
     "\n",
@@ -429,8 +428,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "from xarray.coding.calendar_ops import convert_calendar\n",
+    "\n",
     "import xclim.sdba as sdba\n",
-    "from xclim.core.calendar import convert_calendar\n",
     "from xclim.core.units import convert_units_to\n",
     "from xclim.testing import open_dataset\n",
     "\n",
@@ -751,7 +751,6 @@
    "source": [
     "from matplotlib import pyplot as plt\n",
     "\n",
-    "import xclim as xc\n",
     "from xclim import sdba\n",
     "from xclim.testing import open_dataset\n",
     "\n",
@@ -880,7 +879,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.4"
+   "version": "3.12.5"
   },
   "toc": {
    "base_numbering": 1,

docs/notebooks/sdba.ipynb

@@ -808,7 +808,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.4"
+   "version": "3.12.5"
   },
   "toc": {
    "base_numbering": 1,

docs/notebooks/units.ipynb

@@ -18,7 +18,6 @@
     "import xarray as xr\n",
     "\n",
     "import xclim\n",
-    "from xclim import indices\n",
     "from xclim.core import units\n",
     "from xclim.testing import open_dataset\n",
     "\n",

docs/notebooks/usage.ipynb

@@ -26,7 +26,7 @@
     "import xarray as xr\n",
     "\n",
     "import xclim.indices\n",
-    "from xclim import testing"
+    "from xclim.testing import open_dataset"
    ]
   },
   {
@@ -48,7 +48,7 @@
     "# ds = xr.open_dataset(\"your_file.nc\")\n",
     "\n",
     "# For this example, let's use a test dataset from xclim:\n",
-    "ds = testing.open_dataset(\"ERA5/daily_surface_cancities_1990-1993.nc\")\n",
+    "ds = open_dataset(\"ERA5/daily_surface_cancities_1990-1993.nc\")\n",
     "ds.tas"
    ]
   },
@@ -164,11 +164,6 @@
     "Resampling to a daily frequency and running the same indicator succeeds, but we will still get warnings from the CF metadata checks."
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": []
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -387,7 +382,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.7"
+   "version": "3.12.5"
   }
  },
  "nbformat": 4,

environment.yml

@@ -28,9 +28,9 @@ dependencies:
   - flox
   - lmoments3  # Required for some Jupyter notebooks
   # Testing and development dependencies
-  - black ==24.4.2
+  - black ==24.8.0
   - blackdoc ==0.3.9
-  - bump-my-version >=0.24.3
+  - bump-my-version >=0.25.4
   - cairosvg
   - codespell ==2.3.0
   - coverage >=7.5.0
@@ -54,7 +54,6 @@ dependencies:
   - nc-time-axis >=1.4.1
   - notebook
   - pandas-stubs >=2.2
-  - platformdirs >=3.2
   - pooch >=1.8.0
   - pre-commit >=3.7
   - pybtex >=0.24.0

pyproject.toml

@@ -48,7 +48,6 @@ dependencies = [
   "packaging >=24.0",
   "pandas >=2.2",
   "pint >=0.18",
-  "platformdirs >=3.2",
   "pyarrow >=15.0.0", # Strongly encouraged for pandas v2.2.0+
   "pyyaml >=6.0.1",
   "scikit-learn >=0.21.3",
@@ -79,7 +78,6 @@ dev = [
   "nbval >=0.11.0",
   "pandas-stubs >=2.2",
   "pip >=24.0",
-  "platformdirs >=3.2",
   "pooch >=1.8.0",
   "pre-commit >=3.7",
   "pylint >=3.2.4",
@@ -138,7 +136,7 @@ target-version = [
 ]
 
 [tool.bumpversion]
-current_version = "0.52.1-dev.0"
+current_version = "0.52.1-dev.1"
 commit = true
 commit_args = "--no-verify"
 tag = false