add a __dict__ to ufunc objects and use it to allow overriding __doc__ #27383
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhvk
reviewed
Sep 13, 2024
| with pytest.raises(AttributeError, match=msg): | ||
| np.add.__doc__ = "hello" | ||
|
|
||
| # you can add a "__doc__" key to __dict__ but it doesn't do anything |
| @@ -6411,6 +6412,19 @@ ufunc_get_doc(PyUFuncObject *ufunc, void *NPY_UNUSED(ignored)) | ||
| { | ||
| PyObject *doc; | ||
|
|
||
| // if there is a __doc__ in the instance __dict__, use that, but only if | ||
| // __doc__ is NULL | ||
| if (ufunc->doc == NULL) { |
There was a problem hiding this comment.
I think I might reverse the logic: if __doc__ is present in ufunc->dict return that. If not, use ufunc->doc as now to calculate the final docstring, and then store the result in __doc__ (so that it gets re-used any further times, unless it is overwritten; and if one does del ufunc.__doc__, one will automatically get the original docstring back).
EDIT: actually, storing the result of the normal calculation is not really necessary - it just uses extra space that can otherwise be freed.
| static int | ||
| ufunc_set_doc(PyUFuncObject *ufunc, PyObject *doc, void *NPY_UNUSED(ignored)) | ||
| { | ||
| if (ufunc->doc != NULL) { |
There was a problem hiding this comment.
With my suggestion, this check would not be necessary.
| @@ -6564,10 +6598,16 @@ NPY_NO_EXPORT PyTypeObject PyUFunc_Type = { | ||
| .tp_str = (reprfunc)ufunc_repr, | ||
| .tp_flags = Py_TPFLAGS_DEFAULT | | ||
| _Py_TPFLAGS_HAVE_VECTORCALL | | ||
| Py_TPFLAGS_HAVE_GC, | ||
| Py_TPFLAGS_HAVE_GC, |
|
Closing in favor of #27735 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #26233
Marked as draft because I have a couple questions:
void *reserved2field I can re-use for this. Any reason not to?Is that a thing we want? This adds a new way to monkeypatch numpy. People probably already do that in other pure python bits, but now they can do it with ufuncs too. I guess the consenting adults principle applies though and I'd be inclined to allow it.