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.

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

DEPR: deprecate importing ErfaError and ErfaWarning from astropy.utils.exceptions #15777

Merged
merged 1 commit into from Dec 21, 2023

Conversation

neutrinoceros
Copy link
Contributor

Description

Follow up to #10329, and in response to #13821 (comment)

This feels a bit too easy, so perhaps I'm missing something ? I'm considering that maybe it wasn't done 3 years ago because PEP 562 wasn't usable yet. This reasoning seems plausible since #10329 went into astropy 4.1, which was the last version to support Python 3.6 (PEP 562 landed in 3.7)

ping @mhvk

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

@github-actions github-actions bot added the utils label Dec 20, 2023
Copy link

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • Is a milestone set? Milestone must be set but we cannot check for it on Actions; do not let the green checkmark fool you.
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

Copy link

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

Copy link
Contributor

@mhvk mhvk left a comment

Choose a reason for hiding this comment

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

I think you are right that it is simply that module-level __getattr__ didn't exist yet - it is a very nice addition!
Just one comment with a further simplification in-line.

stacklevel=1,
)

if name == "ErfaError":
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this can just be

import erfa
return getattr(erfa, name)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thank you ! I was initially going to use importlib to do this dynamically but thought a dumb implementation was just as good, I missed that I could use getattr (ironic given that I was implementing __getattr__...)

@neutrinoceros neutrinoceros marked this pull request as ready for review December 20, 2023 17:18
@@ -0,0 +1 @@
Deprecate importing ``ErfaError`` and ``ErfaWarning`` from ``astropy.utils.exceptions``.
Copy link
Member

Choose a reason for hiding this comment

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

Why not say in the change log entry where the error and warning should be imported from?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done !

Copy link
Contributor

@mhvk mhvk left a comment

Choose a reason for hiding this comment

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

Happy that worked, and good addition to the changelog entry.

@mhvk
Copy link
Contributor

mhvk commented Dec 20, 2023

p.s. Be sure to mention your improvements in #13821 - I like your approach of just removing minor pain points so we can avoid more major refactoring (or make it easier).

@mhvk
Copy link
Contributor

mhvk commented Dec 20, 2023

Ah, I see you already did add a note in #13821 (comment) - thanks!

"in version 6.1 and will stop working in a future version. "
f"Instead, please use\nfrom erfa import {name}\n\n",
category=AstropyDeprecationWarning,
stacklevel=1,
Copy link
Contributor

Choose a reason for hiding this comment

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

It's usually recommended to atleast use stacklevel=2 in these warnings (ref python/cpython#88462)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True, but in the context of a module level __getattr__, and from my quick experiments, it doesn't seem to make any difference.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is OK as is, so will merge now. Thanks, @neutrinoceros!

@mhvk mhvk merged commit 651ea27 into astropy:main Dec 21, 2023
25 of 26 checks passed
@neutrinoceros neutrinoceros deleted the depr/erfa_exceptions branch December 21, 2023 14:14
@pllim pllim added the API change PRs and issues that change an existing API, possibly requiring a deprecation period label Dec 21, 2023
@pllim pllim added this to the v6.1.0 milestone Dec 21, 2023
@pllim
Copy link
Member

pllim commented Dec 21, 2023

@mhvk , please don't forget the milestone next time. I have added it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API change PRs and issues that change an existing API, possibly requiring a deprecation period utils
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants