Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecate xr.cftime_range in favor of xr.date_range #9886

Closed
dcherian opened this issue Dec 13, 2024 · 3 comments · Fixed by #10024
Closed

Deprecate xr.cftime_range in favor of xr.date_range #9886

dcherian opened this issue Dec 13, 2024 · 3 comments · Fixed by #10024
Labels
contrib-good-first-issue

Comments

@dcherian
Copy link
Contributor

dcherian commented Dec 13, 2024 •
edited
Loading

What is your issue?

xr.date_range automatically chooses a return type based on calendar and can take use_cftime=True to always return CFTimeIndex, so I don't see why we need xr.cftime_range any more
@dcherian dcherian added needs triage Issue that has not been reviewed by xarray team member contrib-good-first-issue and removed needs triage Issue that has not been reviewed by xarray team member labels Dec 13, 2024
@spencerkclark
Copy link
Member

+1, indeed we can make cftime_range private.

Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 4, 2025
Add deprecation warning to cftime_range()
87f0cde 
Issue pydata#9886
@Maddogghoek Maddogghoek mentioned this issue Feb 4, 2025
Merged
2 tasks
@Maddogghoek
Copy link
Contributor

doubt anyone is waiting on this, but a quick status update, I need to add the expectation for the warning the doctest and replace the internal calls to cftime_range. Should have time tomorrow.

Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 7, 2025
- 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
Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 7, 2025
- Update cftime_range doctest to ignore deprecation warning.
7fbff45 
Issue pydata#9886
Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 8, 2025
skip invalid inclusion value if type checking is turned on
9b45bc8 
issue pydata#9886
Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 8, 2025
remove unneeded ignore arg type comments
f68277e 
issue pydata#9886
@Maddogghoek
Copy link
Contributor

finally got all the tests passing and the pull request is ready to go.

Maddogghoek added a commit to Maddogghoek/xarray that referenced this issue Feb 11, 2025
@Maddogghoek @max-sixty
s/Illegal/Invalid/ in error message for cftime_range
2fa10f6 
per code review

issue pydata#9886

Co-authored-by: Maximilian Roos <[email protected]>
Maddogghoek added a commit to Maddogghoek/xarray that referenced this issue Feb 14, 2025
@Maddogghoek @kmuehlbauer
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 <[email protected]>
Maddogghoek added a commit to Maddogghoek/xarray that referenced this issue Feb 18, 2025
@Maddogghoek @spencerkclark
remove "bug fix" for pydata#9886
899f123 
listed under deprecations instead

Co-authored-by: Spencer Clark <[email protected]>
Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 18, 2025
update cftime_range deprecation warning to use emit_user_level_warnin…
3adf065 
…g (issue pydata#9886)"
Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 18, 2025
add "linear" to internal generate_date_range* function names per code…
40222b8 
… review (issue pydata#9886)
Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 18, 2025
replace deprecated cftime_range with date_range(use_cftime=True) for …
0004584 
…most unit tests (pydata#9886)
Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 18, 2025
copy and update cftime_range() documentation notes to date_range() (p…
fec6a99 
…ydata#9886)
Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 18, 2025
remove erroneous "stacklevel" argument from emit_user_level_warning c…
d611fbc 
…all (pydata#9886)
Maddogghoek pushed a commit to Maddogghoek/xarray that referenced this issue Feb 19, 2025
fix test_invalid_date_range_cftime_inputs to catch expected exception (…
acfcaf7 
…pydata#9886)
Maddogghoek added a commit to Maddogghoek/xarray that referenced this issue Feb 21, 2025
@Maddogghoek @spencerkclark
reformat deprecation note
773a7b2 
(pydata#9886)

Co-authored-by: Spencer Clark <[email protected]>
Maddogghoek added a commit to Maddogghoek/xarray that referenced this issue Feb 21, 2025
@Maddogghoek @spencerkclark
Minor documentation improvement for date_range()
3971ce0 
(pydata#9886)

Co-authored-by: Spencer Clark <[email protected]>
Maddogghoek added a commit to Maddogghoek/xarray that referenced this issue Feb 21, 2025
@Maddogghoek @kmuehlbauer
remove long url from date_range() documentation
4d75b40 
pydata#9886

Co-authored-by: Kai Mühlbauer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
contrib-good-first-issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

deprecate cftime_range() in favor of date_range(use_cftime=True) Maddogghoek/xarray
3 participants
@dcherian @spencerkclark @Maddogghoek