Skip to content

BUG: fix astropy.utils.decorators compatibility with Python's optimized mode (classproperty and format_doc) - #17549

Merged
pllim merged 2 commits into
astropy:mainfrom
neutrinoceros:utils/bug/fix_decorator_compat_optimized_mode
Dec 18, 2024
Merged

BUG: fix astropy.utils.decorators compatibility with Python's optimized mode (classproperty and format_doc)#17549
pllim merged 2 commits into
astropy:mainfrom
neutrinoceros:utils/bug/fix_decorator_compat_optimized_mode

Conversation

@neutrinoceros

@neutrinoceros neutrinoceros commented Dec 17, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

ref #17472

fix running pytest astropy/utils/tests/test_decorators.py with PYTHONOPTIMIZE=2.
For this one I needed to update tests, which is almost never a good sign; I figure we can still run most of our tests with PYTHONOPTIMIZE=2 (checking that the behavior aligns with non-decorated functions, namely that docstrings are None at runtime), however there's one part of format_doc that I don't think we should be testing under this setup: the runtime checking of its arguments (e.g., exceptions being raised). This remains up for discussion of course.

Note to reviewers: the first commit from #17472 is needed to get passed pytest's initialization. Alternatively, you may turn off warnings as errors.

  • 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 Dec 17, 2024
@neutrinoceros neutrinoceros mentioned this pull request Dec 17, 2024
Draft
1 task
@github-actions github-actions Bot added the utils label Dec 17, 2024
@github-actions

github-actions Bot commented Dec 17, 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 Dec 17, 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 December 17, 2024 14:50
@pllim pllim added the Extra CI Run cron CI as part of PR label Dec 17, 2024
@pllim

pllim commented Dec 17, 2024

Copy link
Copy Markdown
Member

Since this is deep down in utils, I am triggering Extra CI, just to be sure. FYI.

mhvk
mhvk approved these changes Dec 17, 2024
View reviewed changes

@mhvk mhvk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks OK, though I wonder if it woudn't be easier to skip the whole test suite if optimization is on. But since the work is already done, maybe best to just stick with what you have...

@neutrinoceros

neutrinoceros commented Dec 17, 2024

Copy link
Copy Markdown
Contributor Author

I want to keep this approach as a last resort so I can get as many things actually working as expected first, but maybe I'll need to skip a couple tests in a further PR indeed.

neutrinoceros
neutrinoceros commented Dec 17, 2024
View reviewed changes
Comment thread astropy/utils/tests/test_decorators.py Resolved
pllim
pllim reviewed Dec 17, 2024
View reviewed changes
Comment thread astropy/utils/tests/test_decorators.py Outdated

# Raises an valueerror if input is empty
with pytest.raises(ValueError):
if sys.flags.optimize < 2:

@pllim pllim Dec 17, 2024 •
edited
Loading

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.

Might be less confusing if you move this one out into a different test function and use @pytest.mark.skipif(sys.flags.optimize >= 2, reason="NA for Python optimized mode")

@neutrinoceros neutrinoceros Dec 18, 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.

done !

pllim
pllim reviewed Dec 17, 2024
View reviewed changes
Comment thread astropy/utils/tests/test_decorators.py Resolved
pllim
pllim reviewed Dec 17, 2024
View reviewed changes
Comment thread astropy/utils/tests/test_decorators.py Resolved
pllim
pllim reviewed Dec 17, 2024
View reviewed changes
Comment thread astropy/utils/tests/test_decorators.py Resolved
pllim
pllim reviewed Dec 17, 2024
View reviewed changes
Comment thread astropy/utils/tests/test_decorators.py Resolved
pllim
pllim reviewed Dec 17, 2024
View reviewed changes
Comment thread astropy/utils/tests/test_decorators.py Resolved
@neutrinoceros
neutrinoceros force-pushed the utils/bug/fix_decorator_compat_optimized_mode branch from 1e77e91 to 56b239f Compare December 18, 2024 07:30
@neutrinoceros
neutrinoceros force-pushed the utils/bug/fix_decorator_compat_optimized_mode branch from 56b239f to e81222d Compare December 18, 2024 07:32
@neutrinoceros neutrinoceros changed the title BUG: fix astropy.utils.decorators compatibility with Python's optimized mode (classproperty and format_doc) BUG: fix astropy.utils.decorators compatibility with Python's optimized mode (classproperty and format_doc) Dec 18, 2024
pllim
pllim approved these changes Dec 18, 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.

Thanks!

@pllim
pllim merged commit 410d826 into astropy:main Dec 18, 2024
@neutrinoceros
neutrinoceros deleted the utils/bug/fix_decorator_compat_optimized_mode branch December 18, 2024 21:03
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
@mhvk mhvk mhvk approved these changes

Assignees

No one assigned

Labels

Bug Extra CI Run cron CI as part of PR no-changelog-entry-needed utils

Projects

None yet

Milestone

v7.1.0

Development

Successfully merging this pull request may close these issues.

3 participants

@neutrinoceros @pllim @mhvk