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.

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

Jump to bottom

BUG: avoid a segfault when calling astropy.convolution.convolve on an empty array #15840

Merged
merged 3 commits into from Jan 22, 2024
Merged

BUG: avoid a segfault when calling astropy.convolution.convolve on an empty array #15840

merged 3 commits into from Jan 22, 2024

Conversation

neutrinoceros
Copy link
Contributor

Description

Fixes #10048

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

@github-actions GitHub Actions
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?

@neutrinoceros neutrinoceros force-pushed the convolution/bug/convolve_empty_array branch from 81f5871 to 11dd8d0 Compare January 10, 2024 08:29
neutrinoceros
neutrinoceros commented Jan 10, 2024
View reviewed changes
astropy/convolution/convolve.py Outdated
@@ -296,6 +296,8 @@ def convolve(
)
elif array_internal.ndim != kernel_internal.ndim:
raise Exception("array and kernel have differing number of dimensions.")
elif array_internal.size == 0:
raise Exception("cannot convolve empty array")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

raising the base Exception type isn't recommended (ValueError would be more appropriate here I think). It should be possible to refine these exceptions to a more specialised type without breaking user code that might rely on current behaviour since ValueError is a subclass of Exception, so any code that would already catch Exception would also catch ValueError.
I'll leave it to reviewers to decide whether such a change is desirable or not and wether it's in scope to this PR or better left as a follow up.

Copy link
Contributor

Choose a reason for hiding this comment

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

👍 on replacing with a ValueError in both cases here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks for your feedback ! I'll give it a couple days to see if it raises any eyebrows and if not, I'll push the change !

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no complaints in 2 days -> pushed !

@neutrinoceros neutrinoceros marked this pull request as ready for review January 10, 2024 09:13
@pllim pllim requested a review from keflavich January 10, 2024 15:11
@pllim pllim added this to the v6.0.1 milestone Jan 10, 2024
@pllim pllim added Bug backport-v6.0.x on-merge: backport to v6.0.x labels Jan 10, 2024
@pllim pllim requested a review from astrofrog January 10, 2024 15:11
keflavich
keflavich approved these changes Jan 10, 2024
View reviewed changes
astropy/convolution/convolve.py Outdated
@@ -296,6 +296,8 @@ def convolve(
)
elif array_internal.ndim != kernel_internal.ndim:
raise Exception("array and kernel have differing number of dimensions.")
elif array_internal.size == 0:
raise Exception("cannot convolve empty array")
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 on replacing with a ValueError in both cases here.

@pllim
Copy link
Member

pllim commented Jan 12, 2024

Going to wait a bit in case @astrofrog has comments. Thanks!

pllim
pllim reviewed Jan 22, 2024
View reviewed changes
astropy/convolution/convolve.py
@@ -289,13 +289,15 @@ def convolve(

# Check dimensionality
if array_internal.ndim == 0:
raise Exception("cannot convolve 0-dimensional arrays")
raise ValueError("cannot convolve 0-dimensional arrays")
Copy link
Member

Choose a reason for hiding this comment

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

Does change the exception type, so maybe better not backport.

Other than that, since I haven't heard from Tom R but there is an approval, I am just going to merge.

Thanks!

@pllim pllim removed the backport-v6.0.x on-merge: backport to v6.0.x label Jan 22, 2024
@pllim pllim modified the milestones: v6.0.1, v6.1.0 Jan 22, 2024
@pllim pllim merged commit d8d595c into astropy:main Jan 22, 2024
27 of 28 checks passed
@neutrinoceros neutrinoceros deleted the convolution/bug/convolve_empty_array branch January 22, 2024 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pllim pllim pllim left review comments

@keflavich keflavich keflavich approved these changes

@larrybradley larrybradley larrybradley approved these changes

@astrofrog astrofrog Awaiting requested review from astrofrog

Assignees
No one assigned
Labels
Bug convolution
Projects
None yet
Milestone
v6.1.0
Development

Successfully merging this pull request may close these issues.

Abort error when convolving an empty array
4 participants
@neutrinoceros @pllim @keflavich @larrybradley