Skip to content

ENH: Add a __dict__ to ufunc objects and allow overriding __doc__#27735

Merged
ngoldbaum merged 7 commits into
numpy:mainfrom
mtsokol:ufunc-object-dict
Nov 13, 2024
Merged

ENH: Add a __dict__ to ufunc objects and allow overriding __doc__#27735
ngoldbaum merged 7 commits into
numpy:mainfrom
mtsokol:ufunc-object-dict

Conversation

@mtsokol
Copy link
Copy Markdown
Member

@mtsokol mtsokol commented Nov 11, 2024

Hi @ngoldbaum, @mhvk,

This PR fixes #26233 and replaces #27383 (with existing review comments applied).

@mtsokol mtsokol self-assigned this Nov 11, 2024
@ngoldbaum ngoldbaum mentioned this pull request Nov 11, 2024
Closed
@mtsokol @ngoldbaum
ENH: Add a __dict__ to ufunc objects and use it to allow overriding…
3eafa3f 
… `__doc__`

Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
mhvk
mhvk approved these changes Nov 11, 2024
View reviewed changes
Copy link
Copy Markdown
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.

Apart from the nitpick on the tests, this looks great!

Comment thread numpy/_core/tests/test_umath.py
seberg
seberg reviewed Nov 11, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@seberg seberg left a comment

Choose a reason for hiding this comment

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

FWIW, looks fine to me as well, but also some comments. I mostly still think that we should also note other things like module and qualname (which have very clear use-cases as well).

Comment thread numpy/_core/src/umath/ufunc_object.c
Comment thread doc/release/upcoming_changes/27735.new_feature.rst Outdated
Comment thread numpy/_core/src/umath/ufunc_object.c Outdated
seberg
seberg reviewed Nov 12, 2024
View reviewed changes
Comment thread numpy/_core/src/umath/ufunc_object.c
@mtsokol mtsokol force-pushed the ufunc-object-dict branch 3 times, most recently from ccdeffb to 1aae07d Compare November 12, 2024 13:37
mhvk
mhvk reviewed Nov 12, 2024
View reviewed changes
Comment thread numpy/_core/src/umath/ufunc_object.c Outdated
@ngoldbaum
Copy link
Copy Markdown
Member

ngoldbaum commented Nov 12, 2024

As a followup we should probably set __module__ on all of NumPy's built-in ufuncs so they show up where they're supposed to be in the public API instead of _multiarray_umath

@ngoldbaum
Copy link
Copy Markdown
Member

ngoldbaum commented Nov 12, 2024

Maybe we can sneak in a deprecation warning into _add_newdoc_ufunc in this PR? It’s in np._core but we told people to continue using it because of the issue fixed by this PR.

@ngoldbaum ngoldbaum added this to the 2.2.0 release milestone Nov 12, 2024
@mtsokol
Copy link
Copy Markdown
Member Author

mtsokol commented Nov 12, 2024

Maybe we can sneak in a deprecation warning into _add_newdoc_ufunc in this PR?

@ngoldbaum Done!

I think all is ready now.

seberg
seberg reviewed Nov 12, 2024
View reviewed changes
Comment thread doc/release/upcoming_changes/27735.new_feature.rst Outdated
``__qualname__``.

* ``_add_newdoc_ufunc`` is now deprecated. ``ufunc.__doc__ = newdoc`` should
be used instead. No newline at end of file
Copy link
Copy Markdown
Member

@seberg seberg Nov 12, 2024

Choose a reason for hiding this comment

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

Nit, but it should be split into two files (different categories).

Copy link
Copy Markdown
Member Author

@mtsokol mtsokol Nov 12, 2024

Choose a reason for hiding this comment

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

Ah right, done!

@mattip
Copy link
Copy Markdown
Member

mattip commented Nov 13, 2024

We discussed this at the triage meeting and would like to see it merged in.

@ngoldbaum
Copy link
Copy Markdown
Member

ngoldbaum commented Nov 13, 2024

I gave the C code another once-over and I think this is correct. I'll merge now. We should definitely update the way we set docstrings internally to make use of this as a followup, fixing #10167 too.

@ngoldbaum ngoldbaum merged commit 4df0561 into numpy:main Nov 13, 2024
@mtsokol mtsokol deleted the ufunc-object-dict branch November 13, 2024 18:42
@mtsokol mtsokol mentioned this pull request Nov 14, 2024
Merged
@rgommers rgommers mentioned this pull request Nov 15, 2024
Closed
@ngoldbaum ngoldbaum mentioned this pull request Feb 27, 2025
Open
@steppi steppi mentioned this pull request May 15, 2025
Merged
@steppi steppi mentioned this pull request Jan 3, 2026
Merged
@ngoldbaum ngoldbaum mentioned this pull request Feb 27, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seberg seberg seberg left review comments

@mhvk mhvk mhvk approved these changes

Assignees

@mtsokol mtsokol

Labels

01 - Enhancement component: numpy.ufunc

Projects

None yet

Milestone

2.2.0 release

Development

Successfully merging this pull request may close these issues.

ENH: add __dict__ to the ufunc object

5 participants

@mtsokol @ngoldbaum @mattip @seberg @mhvk