Skip to content

Fix Ruff rule RET504 violations in astropy/visualization - #17818

Merged
astrofrog merged 2 commits into
astropy:mainfrom
IamPhytan:ruff-rule-RET504-vis
Apr 28, 2025
Merged

Fix Ruff rule RET504 violations in astropy/visualization#17818
astrofrog merged 2 commits into
astropy:mainfrom
IamPhytan:ruff-rule-RET504-vis

Conversation

@IamPhytan

@IamPhytan IamPhytan commented Feb 25, 2025

Copy link
Copy Markdown
Contributor

Description

This pull request address the violations of Ruff rule RET504 in astropy/visualization.

Partially addresses #14818

  • 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 commented Feb 25, 2025

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.

@pllim pllim added this to the v7.1.0 milestone Feb 25, 2025
@pllim
pllim requested review from eerovaher and nstarman February 25, 2025 17:17
nstarman
nstarman approved these changes Feb 25, 2025
View reviewed changes

@nstarman nstarman 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 @IamPhytan for the PR!

eerovaher
eerovaher reviewed Feb 25, 2025
View reviewed changes

@eerovaher eerovaher 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.

If .ruff.toml is not updated then Ruff will not guard against RET504 violations being reintroduced to visualization.

Comment thread astropy/visualization/wcsaxes/core.py Outdated
Comment on lines 789 to 793

if bb:
_bbox = Bbox.union(bb)
return _bbox
return Bbox.union(bb)
else:
return self.get_window_extent(renderer)

@eerovaher eerovaher Feb 25, 2025

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.

It is clear that bb cannot be falsy, so this will always return Bbox.union(bb).

@IamPhytan IamPhytan Feb 25, 2025

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.

Fixed

@IamPhytan
IamPhytan force-pushed the ruff-rule-RET504-vis branch from df6ccca to ae4b5a3 Compare February 25, 2025 19:25
@IamPhytan

IamPhytan commented Feb 25, 2025

Copy link
Copy Markdown
Contributor Author

If .ruff.toml is not updated then Ruff will not guard against RET504 violations being reintroduced to visualization.

Fixed it with an amendment on the original commit

eerovaher
eerovaher approved these changes Feb 25, 2025
View reviewed changes

@eerovaher eerovaher 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.

I will let the sub-package maintainers do the final review.

@eerovaher eerovaher mentioned this pull request Feb 28, 2025
Closed
3 of 6 tasks
astrofrog
astrofrog reviewed Apr 28, 2025
View reviewed changes
Comment thread astropy/visualization/wcsaxes/core.py
return _bbox
else:
return self.get_window_extent(renderer)
return Bbox.union(bb)

@astrofrog astrofrog Apr 28, 2025

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.

I think this is fine even though non-trivial because the append above ensures there will always be one element in the list even if it is None for instance, so the list will never be empty

@astrofrog
astrofrog merged commit 12f9944 into astropy:main Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@astrofrog astrofrog astrofrog left review comments
@nstarman nstarman nstarman approved these changes
@eerovaher eerovaher eerovaher approved these changes
@larrybradley larrybradley Awaiting requested review from larrybradley larrybradley is a code owner
@WilliamJamieson WilliamJamieson Awaiting requested review from WilliamJamieson WilliamJamieson is a code owner

Assignees

No one assigned

Labels

dev-automation no-changelog-entry-needed visualization.wcsaxes visualization

Projects

None yet

Milestone

v7.1.0

Development

Successfully merging this pull request may close these issues.

5 participants

@IamPhytan @astrofrog @nstarman @eerovaher @pllim