New issue

deprecate cftime_range() in favor of date_range(use_cftime=True) #10024

Merged

dcherian merged 47 commits into pydata:main from Maddogghoek:cftime_deprecation

Feb 27, 2025

+467 −204

[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

pre-commit-ci[bot] committed Feb 18, 2025

commit eb87222823b2df8d171e3e4d7ba01b4a48a8be20

doc/user-guide/weather-climate.rst

-Original file line number
+Diff line change
@@ @@ -101,7 +101,7 @@ coordinate with dates from a no-leap calendar and a @@
     Xarray also includes a :py:func:`~xarray.date_range` function, which enables
     creating a :py:class:`~xarray.CFTimeIndex` with regularly-spaced dates.  For
     instance, we can create the same dates and DataArray we created above using
-    (note that ``use_cftime=True`` is not mandatory to return a
+    (note that ``use_cftime=True`` is not mandatory to return a
     :py:class:`~xarray.CFTimeIndex` for non-standard calendars, but can be nice
     to use to be explicit):

Unchanged files with check annotations Beta

xarray/namedarray/core.py

	attrs: _AttrsLike = None,
	):
	self._data = data
	self._dims = self._parse_dimensions(dims)
Check warning on line 264 in xarray/namedarray/core.py GitHub Actions / ubuntu-latest py3.10 bare-minimum Duplicate dimension names present: dimensions {'x'} appear more than once in dims=('x', 'x'). We do not yet support duplicate dimension names, but we do allow initial construction of the object. We recommend you rename the dims immediately to become distinct, as most xarray functionality is likely to fail silently if you do not. To rename the dimensions you will need to set the ``.dims`` attribute of each variable, ``e.g. var.dims=('x0', 'x1')``. Check warning on line 264 in xarray/namedarray/core.py GitHub Actions / ubuntu-latest py3.10 bare-minimum Duplicate dimension names present: dimensions {'x'} appear more than once in dims=('x', 'x'). We do not yet support duplicate dimension names, but we do allow initial construction of the object. We recommend you rename the dims immediately to become distinct, as most xarray functionality is likely to fail silently if you do not. To rename the dimensions you will need to set the ``.dims`` attribute of each variable, ``e.g. var.dims=('x0', 'x1')``. Check warning on line 264 in xarray/namedarray/core.py GitHub Actions / ubuntu-latest py3.13 Duplicate dimension names present: dimensions {'x'} appear more than once in dims=('x', 'x'). We do not yet support duplicate dimension names, but we do allow initial construction of the object. We recommend you rename the dims immediately to become distinct, as most xarray functionality is likely to fail silently if you do not. To rename the dimensions you will need to set the ``.dims`` attribute of each variable, ``e.g. var.dims=('x0', 'x1')``. Check warning on line 264 in xarray/namedarray/core.py GitHub Actions / ubuntu-latest py3.13 Duplicate dimension names present: dimensions {'x'} appear more than once in dims=('x', 'x'). We do not yet support duplicate dimension names, but we do allow initial construction of the object. We recommend you rename the dims immediately to become distinct, as most xarray functionality is likely to fail silently if you do not. To rename the dimensions you will need to set the ``.dims`` attribute of each variable, ``e.g. var.dims=('x0', 'x1')``. Check warning on line 264 in xarray/namedarray/core.py GitHub Actions / macos-latest py3.10 Duplicate dimension names present: dimensions {'x'} appear more than once in dims=('x', 'x'). We do not yet support duplicate dimension names, but we do allow initial construction of the object. We recommend you rename the dims immediately to become distinct, as most xarray functionality is likely to fail silently if you do not. To rename the dimensions you will need to set the ``.dims`` attribute of each variable, ``e.g. var.dims=('x0', 'x1')``. Check warning on line 264 in xarray/namedarray/core.py GitHub Actions / macos-latest py3.10 Duplicate dimension names present: dimensions {'x'} appear more than once in dims=('x', 'x'). We do not yet support duplicate dimension names, but we do allow initial construction of the object. We recommend you rename the dims immediately to become distinct, as most xarray functionality is likely to fail silently if you do not. To rename the dimensions you will need to set the ``.dims`` attribute of each variable, ``e.g. var.dims=('x0', 'x1')``.
	self._attrs = dict(attrs) if attrs else None

	def __init_subclass__(cls, **kwargs: Any) -> None:

xarray/coding/variables.py

	# otherwise numpy unsigned ints will silently cast to the signed counterpart
	fill_value = fill_value.item()
	# passes if provided fill value fits in encoded on-disk type
	new_fill = encoded_dtype.type(fill_value)
Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows). Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows). Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows). Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows). Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows). Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows). Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows). Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows). Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows). Check warning on line 348 in xarray/coding/variables.py GitHub Actions / ubuntu-latest py3.10 min-all-deps NumPy will stop allowing conversion of out-of-bound Python integers to integer arrays. The conversion of 255 to int8 will fail in the future. For the old behavior, usually: np.array(value).astype(dtype)` will give the desired result (the cast overflows).
	except OverflowError:
	encoded_kind_str = "signed" if encoded_dtype.kind == "i" else "unsigned"
	warnings.warn(

xarray/core/duck_array_ops.py

	xp = get_array_namespace(data)
	if xp == np:
	# numpy currently doesn't have a astype:
	return data.astype(dtype, **kwargs)
Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / ubuntu-latest py3.13 `invalid value encountered in cast` Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / ubuntu-latest py3.13 `invalid value encountered in cast` Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / ubuntu-latest py3.13 `invalid value encountered in cast` Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / ubuntu-latest py3.13 `invalid value encountered in cast` Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / ubuntu-latest py3.13 all-but-numba `invalid value encountered in cast` Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / ubuntu-latest py3.13 all-but-numba `invalid value encountered in cast` Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / macos-latest py3.10 `invalid value encountered in cast` Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / macos-latest py3.10 `invalid value encountered in cast` Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / ubuntu-latest py3.10 `invalid value encountered in cast` Check warning on line 232 in xarray/core/duck_array_ops.py GitHub Actions / ubuntu-latest py3.10 `invalid value encountered in cast`
	return xp.astype(data, dtype, **kwargs)
	return data.astype(dtype, **kwargs)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Sponsors

deprecate cftime_range() in favor of date_range(use_cftime=True) #10024

Diff view

Diff view

There are no files selected for viewing

Unchanged files with check annotations Beta

GitHub Actions / ubuntu-latest py3.10 bare-minimum

GitHub Actions / ubuntu-latest py3.10 bare-minimum

GitHub Actions / ubuntu-latest py3.13

GitHub Actions / ubuntu-latest py3.13

GitHub Actions / macos-latest py3.10

GitHub Actions / macos-latest py3.10

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.10 min-all-deps

GitHub Actions / ubuntu-latest py3.13

GitHub Actions / ubuntu-latest py3.13

GitHub Actions / ubuntu-latest py3.13

GitHub Actions / ubuntu-latest py3.13

GitHub Actions / ubuntu-latest py3.13 all-but-numba

GitHub Actions / ubuntu-latest py3.13 all-but-numba

GitHub Actions / macos-latest py3.10

GitHub Actions / macos-latest py3.10

GitHub Actions / ubuntu-latest py3.10

GitHub Actions / ubuntu-latest py3.10