Skip to content

add deprecation warning to resample function #180

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

Closed
alisnwu wants to merge 3 commits into from
Closed

add deprecation warning to resample function #180

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af7ffd4
add deprecation warning to resample function
Nov 24, 2024
fbf761d
@deprecated and better message wording
Dec 6, 2024
02a2c70
fixed version number in dep message
Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions src/diffpy/utils/resampler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

"""Various utilities related to data parsing and manipulation."""

import warnings
from warnings import deprecated

import numpy

Expand Down Expand Up @@ -79,6 +79,11 @@ def wsinterp(x, xp, fp, left=None, right=None):
return fp_at_x


@deprecated(
"The 'resample' function is deprecated and will be removed in a future release 3.6.3. \n"
"'resample' has been renamed 'wsinterp' to better reflect functionality. \n"
"Please use 'wsinterp' instead."
)
Copy link
Contributor

@bobleesj bobleesj Dec 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good. Does this decorator also work in Python 3.12 and 3.11 without failing the test?

Copy link
Author

@alisnwu alisnwu Dec 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll test on that and make a new PR based on the new structure

Copy link
Author

@alisnwu alisnwu Dec 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bobleesj this deprecated decorator actually is only released for 3.13 so should I use warnings.warn instead? @Sparks29032

Copy link
Contributor

@bobleesj bobleesj Dec 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it's a new feature for 3.13.

If it doesn't work for 3.11 and 3.12, then I suggest we should not use this decorator since then 3.11 and 3.12 users won't be able to read this warning msg. tagging @sbillinge for his opinion too.

def resample(r, s, dr):
"""Resample a PDF on a new grid.

Expand All @@ -99,13 +104,6 @@ def resample(r, s, dr):
Returns resampled (r, s).
"""

warnings.warn(
"The 'resample' function is deprecated and will be removed in a future release. \n"
"Please use 'wsinterp' instead.",
DeprecationWarning,
stacklevel=2,
)

dr0 = r[1] - r[0] # Constant timestep

if dr0 < dr:
Expand Down
Loading