Skip to content

BUG: fix importing from astropy.visualization.wcsaxes.patches under Python's optimized mode - #17474

Merged
pllim merged 1 commit into
astropy:mainfrom
neutrinoceros:visualization.wcsaxes/fix_import_optimized_python
Dec 11, 2024
Merged

BUG: fix importing from astropy.visualization.wcsaxes.patches under Python's optimized mode#17474
pllim merged 1 commit into
astropy:mainfrom
neutrinoceros:visualization.wcsaxes/fix_import_optimized_python

Conversation

@neutrinoceros

@neutrinoceros neutrinoceros commented Nov 29, 2024

Copy link
Copy Markdown
Contributor

Description

ref #17472

  • 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.

@neutrinoceros neutrinoceros added this to the v7.1.0 milestone Nov 29, 2024
@neutrinoceros neutrinoceros mentioned this pull request Nov 29, 2024
Draft
1 task
@github-actions

github-actions Bot commented Nov 29, 2024

Copy link
Copy Markdown
Contributor

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?
  • 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.

@github-actions

github-actions Bot commented Nov 29, 2024

Copy link
Copy Markdown
Contributor

👋 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?

@neutrinoceros
neutrinoceros marked this pull request as ready for review November 29, 2024 09:31
@neutrinoceros

neutrinoceros commented Dec 10, 2024

Copy link
Copy Markdown
Contributor Author

This should be an easy review. It's also the last item on #17472 so let me ping @larrybradley and @astrofrog

@pllim
pllim requested a review from nstarman December 10, 2024 16:07
@pllim

pllim commented Dec 10, 2024

Copy link
Copy Markdown
Member

If I remember correctly, @nstarman added this a while back, so I also requested his review. Thanks!

@nstarman

nstarman commented Dec 10, 2024

Copy link
Copy Markdown
Member

Yeah, I aded this. Can we check that these lines are even needed with our minimum-supported matplotlib?

@neutrinoceros

neutrinoceros commented Dec 11, 2024

Copy link
Copy Markdown
Contributor Author

For context:
#11466
matplotlib/matplotlib#19839
This was also recently discussed over at #11458 and an attempt was made a cleaning it up in #16570
Our minimal requirement for matplotlib (3.6.0) hasn't been bumped since my last attempt so I think we can conclude we still need this code :/

pllim
pllim reviewed Dec 11, 2024
View reviewed changes
Comment thread astropy/visualization/wcsaxes/patches.py
Polygon.set_joinstyle.__doc__ = Polygon.set_joinstyle.__doc__.replace(
"`.JoinStyle`", "``matplotlib._enums.JoinStyle``"
)
if sys.flags.optimize < 2:

@pllim pllim Dec 11, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What does this mean? That doc build won't be happy if sys.flags.optimize >= 2 because this patch won't be run?

@pllim pllim Dec 11, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe we will never build doc in that mode anyway?

@neutrinoceros neutrinoceros Dec 11, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I wouldn't recommend using it to build docs since it implies dropping docstrings completely :)

pllim
pllim approved these changes Dec 11, 2024
View reviewed changes

@pllim pllim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

OK LGTM then since there is no concern from Nathaniel. Thanks!

@pllim
pllim merged commit abc83b4 into astropy:main Dec 11, 2024
@neutrinoceros
neutrinoceros deleted the visualization.wcsaxes/fix_import_optimized_python branch December 11, 2024 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pllim pllim pllim approved these changes
@astrofrog astrofrog Awaiting requested review from astrofrog astrofrog is a code owner
@larrybradley larrybradley Awaiting requested review from larrybradley larrybradley is a code owner
@nstarman nstarman Awaiting requested review from nstarman

Assignees

No one assigned

Labels

Bug no-changelog-entry-needed visualization.wcsaxes

Projects

None yet

Milestone

v7.1.0

Development

Successfully merging this pull request may close these issues.

3 participants

@neutrinoceros @pllim @nstarman