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.

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

gh-115231: fill __module__ for built-in class/staticmethods #115232

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

skirpichev
Copy link
Member

@skirpichev skirpichev commented Feb 10, 2024

@@ -6653,7 +6653,9 @@ type_add_method(PyTypeObject *type, PyMethodDef *meth)
descr = PyDescr_NewClassMethod(type, meth);
}
else if (meth->ml_flags & METH_STATIC) {
PyObject *cfunc = PyCFunction_NewEx(meth, (PyObject*)type, NULL);
PyObject *mod = PyObject_GetAttr((PyObject*)type, &_Py_ID(__module__));
Copy link
Member

Choose a reason for hiding this comment

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

This might theoretically return NULL and raise AttributeError.

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm, thanks. Probably we could just clear the error indicator on mod == NULL.

Copy link
Member

Choose a reason for hiding this comment

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

Also take a look at GetOptionalAttr

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we want ignore here not just AttributeError's. I did similar fix for class methods and got a failure in the test.test_types.UnionTests.test_or_type_operator_with_bad_module().

Copy link
Member

Choose a reason for hiding this comment

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

It is better to use type_module() for consistency with the rest of this file. It will not give a surprise if Exceptions other than AttributeError should not be ignored.

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@skirpichev skirpichev force-pushed the static-bltin-__module__-115231 branch from 8d2f05d to be1c7ef Compare February 10, 2024 13:40

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@Eclips4 Eclips4 mentioned this pull request Feb 10, 2024
@skirpichev skirpichev changed the title gh-115231: fill __module__ attribute for built-in staticmethods gh-115231: fill __module__ for built-in class/staticmethods Feb 11, 2024
@skirpichev skirpichev requested a review from sobolevn February 11, 2024 03:02
@skirpichev skirpichev force-pushed the static-bltin-__module__-115231 branch from 28eec6f to c4dec10 Compare February 11, 2024 03:25
@skirpichev
Copy link
Member Author

See also #82062: we could fix that issue in a similar approach, using __objclass__.__module__ to set the __module__ attribute. Right now for built-in instance methods its missing (c.f. pure-python classes):

>>> int.to_bytes.__module__
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'method_descriptor' object has no attribute '__module__'. Did you mean: '__reduce__'?

@skirpichev
Copy link
Member Author

CC @serhiy-storchaka

@@ -6653,7 +6653,9 @@ type_add_method(PyTypeObject *type, PyMethodDef *meth)
descr = PyDescr_NewClassMethod(type, meth);
}
else if (meth->ml_flags & METH_STATIC) {
PyObject *cfunc = PyCFunction_NewEx(meth, (PyObject*)type, NULL);
PyObject *mod = PyObject_GetAttr((PyObject*)type, &_Py_ID(__module__));
Copy link
Member

Choose a reason for hiding this comment

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

It is better to use type_module() for consistency with the rest of this file. It will not give a surprise if Exceptions other than AttributeError should not be ignored.

@@ -130,7 +130,11 @@ classmethod_get(PyObject *self, PyObject *obj, PyObject *type)
if (descr->d_method->ml_flags & METH_METHOD) {
cls = descr->d_common.d_type;
}
return PyCMethod_New(descr->d_method, type, NULL, cls);
PyObject *mod = PyObject_GetAttr((PyObject*)type, &_Py_ID(__module__));
Copy link
Member

Choose a reason for hiding this comment

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

This will add an overhead for use of class methods. We should try to find other solution.

Copy link
Member Author

Choose a reason for hiding this comment

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

overhead for use of class methods

You meant for adding static/class methods?

We should try to find other solution.

Unlikely e.g. __name__, it's a member of PyCFunctionObject. I think we can set one only in PyCMethod_New and there is no more cheapest solution.

Copy link
Member Author

Choose a reason for hiding this comment

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

PR updated to use type_module().

For classmethods, I doubt there is another solution. Here is a micro-benchmark:

Benchmark ref patch
int.from_bytes 289 ns 446 ns: 1.54x slower

@serhiy-storchaka, does the rest (static methods) looks sane for you? If so, I'll create a separate pr just for that case.

import pyperf
runner = pyperf.Runner()
n = 'from_bytes'
runner.bench_func('int.from_bytes', getattr, int, n)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@skirpichev skirpichev marked this pull request as draft November 2, 2024 13:23
This reverts commit 777bc8d.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@skirpichev skirpichev marked this pull request as ready for review February 24, 2025 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants