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

Maddogghoek · 2025-02-04T23:01:08Z

Closes Deprecate xr.cftime_range in favor of xr.date_range #9886
User visible changes (including notable bug fixes) are documented in whats-new.rst

No functional changes beyond a deprecation warning, so no test changes.

welcome · 2025-02-04T23:01:11Z

Thank you for opening this pull request! It may take us a few days to respond here, so thank you for being patient.
If you have questions, some answers may be found in our contributing guidelines.

- update other examples that call cftime_range to use date_range(use_cftime=True) instead Issue pydata#9886

…array into cftime_deprecation merging with head.

Fix typo in pull request number

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

xarray/coding/cftime_offsets.py

…array into cftime_deprecation merging what's new changes

- Fix bug in copy/paste bug in cftime_offsets.

Issue pydata#9886

type checking is enabled - change the example for cftime_range to use date_range(use_cftime) instead to get around deprecation warnings

…ftime_range

…mypy error

issue pydata#9886

per code review issue pydata#9886 Co-authored-by: Maximilian Roos <5635139+max-sixty@users.noreply.github.com>

kmuehlbauer

Great, @Maddogghoek! Small change, big impact, thanks for tackling this!

Just one question and one suggestion. Hope this attracts more reviewers.

doc/whats-new.rst

doc/saved_on_disk.h5

Fix typo in (s/true/True) in what's new for issue pydata#9886 change. Co-authored-by: Kai Mühlbauer <kmuehlbauer@wradlib.org>

spencerkclark

Thanks for taking this on @Maddogghoek! It took me a moment to follow the additional refactoring within _cftime_range, but generally I think those changes are incremental improvements, so I am OK to leave them in. I have a few nits and some documentation suggestions, but otherwise this is looking good.

xarray/coding/cftime_offsets.py

xarray/coding/cftimeindex.py

xarray/tests/test_cftime_offsets.py

doc/user-guide/weather-climate.rst

xarray/coding/cftime_offsets.py

doc/whats-new.rst

Update documentation to steer users to xarray.date_range rather than deprecated xarray.cftime_range. Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

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

listed under deprecations instead Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

…ls.emit_user_level_warning rather than warnings.warn

…g (issue pydata#9886)"

… review (issue pydata#9886)

Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

…most unit tests (pydata#9886)

…array into cftime_deprecation

…ydata#9886)

…all (pydata#9886)

…pydata#9886)

spencerkclark

Thanks @Maddogghoek! I appreciate your careful attention to detail on this. A couple more minor suggestions, but otherwise this looks good to me.

doc/whats-new.rst

xarray/coding/cftime_offsets.py

spencerkclark · 2025-02-21T01:46:34Z

doc/contributing.rst


-            warn(
+            emit_user_level_warning(


Nice, thanks for updating this in the contributing guide!

Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

(pydata#9886) Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

be more explicit about the valid combinations of start, end, periods, and freq. Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

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

kmuehlbauer

@Maddogghoek 🎉 Only one minor nit.

xarray/coding/cftime_offsets.py

pydata#9886 Co-authored-by: Kai Mühlbauer <kmuehlbauer@wradlib.org>

maddogghoek added 3 commits February 4, 2025 15:13

Deprecate cftime_range() and some refactoring

fc954de

updated whats-new.rst

7affcc6

Add deprecation warning to cftime_range()

87f0cde

Issue pydata#9886

Maddogghoek and others added 5 commits February 4, 2025 16:03

Merge branch 'main' into cftime_deprecation

635aa2c

- Update cftime_range example to expect deprecation warning.

392c092

- update other examples that call cftime_range to use date_range(use_cftime=True) instead Issue pydata#9886

Merge branch 'cftime_deprecation' of https://github.com/maddogghoek/x…

f6677eb

…array into cftime_deprecation merging with head.

Merge branch 'main' into cftime_deprecation

5b162fc

Update whats-new.rst

dec7df5

Fix typo in pull request number

dcherian requested a review from spencerkclark February 7, 2025 18:55

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

003edc8

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

max-sixty reviewed Feb 7, 2025

View reviewed changes

xarray/coding/cftime_offsets.py Outdated Show resolved Hide resolved

max-sixty reviewed Feb 7, 2025

View reviewed changes

xarray/coding/cftime_offsets.py Outdated Show resolved Hide resolved

maddogghoek and others added 14 commits February 7, 2025 12:31

always import core.types.InclusionOptions

a072f1b

Merge branch 'cftime_deprecation' of https://github.com/maddogghoek/x…

e0cfdaa

…array into cftime_deprecation merging what's new changes

fix check of InclusiveOptions Literal check

9bf05e2

remove dead code

49a249f

- Replace calls to cftime_range in core and unit tests

62df181

- Fix bug in copy/paste bug in cftime_offsets.

ignore deprecation warnings in test_cftime_offsets.py

7938bb7

- Update cftime_range doctest to ignore deprecation warning.

7fbff45

Issue pydata#9886

- Fix test_cftime_or_date_range_invalid_inclusive_value for cases where

7324f25

type checking is enabled - change the example for cftime_range to use date_range(use_cftime) instead to get around deprecation warnings

update weather-climate.rst to use date_range rather than deprecated c…

da4d9f5

…ftime_range

only check inclusive argument when not already type checked to avoid …

d500e79

…mypy error

skip invalid inclusion value if type checking is turned on

9b45bc8

issue pydata#9886

remove unneeded ignore arg type comments

f68277e

issue pydata#9886

s/Illegal/Invalid/ in error message for cftime_range

2fa10f6

per code review issue pydata#9886 Co-authored-by: Maximilian Roos <5635139+max-sixty@users.noreply.github.com>

Merge branch 'main' into cftime_deprecation

7c4f77b

kmuehlbauer requested changes Feb 14, 2025

View reviewed changes

doc/whats-new.rst Outdated Show resolved Hide resolved

doc/saved_on_disk.h5 Outdated Show resolved Hide resolved

Maddogghoek and others added 2 commits February 14, 2025 10:14

Update doc/whats-new.rst

0e5ee06

Fix typo in (s/true/True) in what's new for issue pydata#9886 change. Co-authored-by: Kai Mühlbauer <kmuehlbauer@wradlib.org>

remove accidentally included documenation artifact

7409c1b

Merge branch 'main' into cftime_deprecation

882c53e

spencerkclark reviewed Feb 16, 2025

View reviewed changes

Maddogghoek and others added 14 commits February 18, 2025 14:57

update to use data_range instead of cftime_range

7765d91

Update documentation to steer users to xarray.date_range rather than deprecated xarray.cftime_range. Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

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

eb87222

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

remove "bug fix" for pydata#9886

899f123

listed under deprecations instead Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

fix documentation typo

12a5c65

Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

update backwards compatibility section example to use xarray.core.uti…

6e7444a

…ls.emit_user_level_warning rather than warnings.warn

update cftime_range deprecation warning to use emit_user_level_warnin…

3adf065

…g (issue pydata#9886)"

add "linear" to internal generate_date_range* function names per code…

40222b8

… review (issue pydata#9886)

clean up cftime_range docum

16ca397

Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

replace deprecated cftime_range with date_range(use_cftime=True) for …

0004584

…most unit tests (pydata#9886)

Merge branch 'cftime_deprecation' of https://github.com/maddogghoek/x…

1076dab

…array into cftime_deprecation

copy and update cftime_range() documentation notes to date_range() (p…

fec6a99

…ydata#9886)

remove erroneous "stacklevel" argument from emit_user_level_warning c…

d611fbc

…all (pydata#9886)

fix test_invalid_date_range_cftime_inputs to catch expected exception (…

acfcaf7

…pydata#9886)

Merge branch 'main' into cftime_deprecation

a0acfd3

Maddogghoek requested a review from kmuehlbauer February 20, 2025 18:19

spencerkclark approved these changes Feb 21, 2025

View reviewed changes

Maddogghoek and others added 5 commits February 20, 2025 23:40

improve invalid input error message for date_range()

8bf8160

Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

reformat deprecation note

773a7b2

(pydata#9886) Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

Minor documentation improvement for date_range()

3971ce0

(pydata#9886) Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

Fix date_range() documentation

8e43215

be more explicit about the valid combinations of start, end, periods, and freq. Co-authored-by: Spencer Clark <spencerkclark@gmail.com>

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

5043c85

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

kmuehlbauer approved these changes Feb 21, 2025

View reviewed changes

xarray/coding/cftime_offsets.py Outdated Show resolved Hide resolved

remove long url from date_range() documentation

4d75b40

pydata#9886 Co-authored-by: Kai Mühlbauer <kmuehlbauer@wradlib.org>

dcherian added the plan to merge Final call for comments label Feb 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Maddogghoek commented Feb 4, 2025 •

edited

Loading

welcome bot commented Feb 4, 2025

kmuehlbauer left a comment

spencerkclark left a comment

spencerkclark left a comment

spencerkclark Feb 21, 2025

kmuehlbauer left a comment

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

Are you sure you want to change the base?

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

Conversation

Maddogghoek commented Feb 4, 2025 • edited Loading

welcome bot commented Feb 4, 2025

kmuehlbauer left a comment

Choose a reason for hiding this comment

spencerkclark left a comment

Choose a reason for hiding this comment

spencerkclark left a comment

Choose a reason for hiding this comment

spencerkclark Feb 21, 2025

Choose a reason for hiding this comment

kmuehlbauer left a comment

Choose a reason for hiding this comment

Maddogghoek commented Feb 4, 2025 •

edited

Loading