| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Sorry, something went wrong.
There was a problem hiding this comment.
My two cents, if they're valid <3
Sorry, something went wrong.
| } | ||
| if (suggest_missing_self) { | ||
| self_hint = PyUnicode_FromString( | ||
| ". Did you forget to declare 'self' as the first parameter?"); |
There was a problem hiding this comment.
I agree with @edvilme: self is only a naming convention. What matters is that the first parameter receives the instance. Consider something like:
". Did you forget the instance parameter (e.g. self) in the function definition?"This avoids misleading beginners into adding a parameter named self in the wrong position.
Sorry, something went wrong.
There was a problem hiding this comment.
This avoids misleading beginners into adding a parameter named self in the wrong position.
I'm not so sure that "instance parameter" means anything more to a beginner than a "self" parameter. "Self" has the advantage of being a very, very common pattern in Python, and I think that's more easily searchable than "instance parameter". For reference, our docs use "self" hundreds of times, whereas "instance parameter" does not appear once.
I would lean more towards this:
Did you forget the 'self' parameter in the function definition?
"self parameter python" on Google will yield millions of results describing exactly what the user wants, whereas "instance parameter python" returns some unrelated results about class methods vs. instance methods and similar.
Sorry, something went wrong.
There was a problem hiding this comment.
I must agree with
'"self parameter python"' on Google will yield millions of results'.
Sorry, something went wrong.
There was a problem hiding this comment.
I've updated the error message to include the self parameter:
self_hint = ". Did you forget the 'self' parameter "
"in the function definition?";
Sorry, something went wrong.
| if (suggest_missing_self) { | ||
| self_hint = PyUnicode_FromString( | ||
| ". Did you forget to declare 'self' as the first parameter?"); | ||
| if (self_hint == NULL) { |
There was a problem hiding this comment.
If PyUnicode_FromString fails, the original TypeError is never raised and the user gets no error message. Better to skip the hint and still emit the normal _PyErr_Format.
Sorry, something went wrong.
There was a problem hiding this comment.
We should actually propagate the exception in this case, and not suggest anything at all. This is already the case when creating kwonly_sig
Sorry, something went wrong.
There was a problem hiding this comment.
I've switched it to a char*. Does that suffice?
Sorry, something went wrong.
| def positional_only(arg, /): | ||
| pass | ||
|
|
||
| def missing_self(another_arg): |
There was a problem hiding this comment.
Good setup for the happy path. If possible, add a def method_with_self(self, x) on the same class A to cover the false positive case.
Sorry, something went wrong.
There was a problem hiding this comment.
Can you take another look: https://github.com/python/cpython/pull/152326/changes#diff-f27c08f13ff54ee9a69325f9291a3a2510a05b82ff8d813a8ab2e0072af632bb
I've added coverage for common cases.
Sorry, something went wrong.
|
|
||
| /* Copy all positional arguments into local variables */ | ||
| Py_ssize_t j, n; | ||
| int missing_self_hint = suggest_missing_self(func, co, args, argcount); |
There was a problem hiding this comment.
The heuristic of matching tp_name against the class segment in qualname is solid. A negative test for a @classmethod missing cls would be useful, it probably shouldnt trigger the hint, and that would document the expected behavior.
Sorry, something went wrong.
There was a problem hiding this comment.
I've switched it to checking function name matching the self dictionary. Please take a fresh look at the PR and lmk if it suffices.
Sorry, something went wrong.
| suggest_missing_self(PyFunctionObject *func, PyCodeObject *co, | ||
| _PyStackRef const *args, Py_ssize_t argcount) | ||
| { | ||
| if (co->co_argcount >= argcount) { |
There was a problem hiding this comment.
Hmm, this fires whenever argcount > co_argcount and the first argument's type matches the class in qualname. That's broader than the beginner mistake this PR targets.
Ex:
This should hint
def lol(a): ...
A().lol(1) but his should not:
def method(self, x): ...
A().method(1, 2, 3) I'd suggest combining argcount == co_argcount + 1 with a second check, like, the first declared parameter is not named "self", or verifying via _PyType_Lookup that this code object is the function bound on the instance's type.
Sorry, something went wrong.
There was a problem hiding this comment.
ok, I've included your runtime arg count == defined arg count + 1 check. It also does both of your suggested checks on the first parameter. Please review it again
Sorry, something went wrong.
There was a problem hiding this comment.
This needs a news entry and a note in "What's New in Python 3.16".
Sorry, something went wrong.
|
|
||
| PyObject *self = PyStackRef_AsPyObjectBorrow(args[0]); | ||
| if (self == NULL) { | ||
| // When first arg is NULL, its not really about self |
There was a problem hiding this comment.
| // When first arg is NULL, its not really about self | |
| // When first arg is NULL, it's not really about self |
Sorry, something went wrong.
There was a problem hiding this comment.
Added it in the HEAD
Sorry, something went wrong.
| Py_ssize_t qualname_len; | ||
| const char *qualname = PyUnicode_AsUTF8AndSize( | ||
| func->func_qualname, &qualname_len); | ||
| if (qualname == NULL) { | ||
| PyErr_Clear(); | ||
| return 0; | ||
| } | ||
|
|
||
| const char *method_dot = strrchr(qualname, '.'); | ||
| if (method_dot == NULL) { | ||
| return 0; | ||
| } | ||
|
|
||
| const char *class_start = qualname; | ||
| for (const char *p = qualname; p < method_dot; p++) { | ||
| if (*p == '.') { | ||
| class_start = p + 1; | ||
| } | ||
| } | ||
| Py_ssize_t class_len = method_dot - class_start; | ||
| const char *type_name = Py_TYPE(self)->tp_name; | ||
|
|
||
| return (strlen(type_name) == (size_t)class_len | ||
| && strncmp(type_name, class_start, (size_t)class_len) == 0); | ||
| } |
There was a problem hiding this comment.
This feels like a nasty hack. Relying on the __qualname__ feels very icky. I need to look into this more, but it's probably possible to determine whether this is an instance method earlier in the eval loop. That would be much cleaner.
Sorry, something went wrong.
There was a problem hiding this comment.
I asked AI on other options. Please review this approach
Sorry, something went wrong.
There was a problem hiding this comment.
(not a full review)
I think the important part of this issue is to find cases where self (as a concept, not as a name) is really missing from the func definition.
So, we can clearly tell apart cases where we just forgot a parameter vs where we forgot to add self to the function definition.
Sorry, something went wrong.
| self.assertEqual(str(cm.exception), message) | ||
|
|
||
| def test_happy_path(self): | ||
| self.assertIs(None, A().method_with_self(1, kwarg=2)) |
There was a problem hiding this comment.
There's no real need for this test. We test method calling in many other test cases in CPython. It does not add any real value.
Sorry, something went wrong.
There was a problem hiding this comment.
This was my response to #152326 (comment) . I think I interpreted the happy path incorrectly
Sorry, something went wrong.
There was a problem hiding this comment.
Removed it.
Sorry, something went wrong.
| def missing_self(another_arg): | ||
| pass | ||
|
|
||
| def missing_self_no_args(): |
There was a problem hiding this comment.
Please, add a test case for def method_with_self_arg(x, self): ...
and then call it like inst.method_with_self().
Also: you can add def zero_args_self(self): ... and call it like: A.zero_args_self() and check that error message is also correct.
Sorry, something went wrong.
There was a problem hiding this comment.
added bark_with_self_arg and test_unbound_method_with_self_keeps_missing_argument_error for this.
Sorry, something went wrong.
There was a problem hiding this comment.
You should add tests with classmethods, staticmethods (whether on regular classes or metaclasses)
Sorry, something went wrong.
| assert(kwonly_sig != NULL); | ||
| } | ||
| if (should_suggest_missing_self) { | ||
| self_hint = PyUnicode_FromString( |
There was a problem hiding this comment.
Your self_hint is non NULL (before assignment). While empty strings are immortal, you still need to decref it if this ever changes. For that use Py_SETREF.
Sorry, something went wrong.
There was a problem hiding this comment.
I don't feel super strongly about this, but I disagree with refcounting immortal objects. I've expressed before that too many users rely on certain things being immortal (such as empty strings), so changing that would be very difficult anyway. We might as well enjoy the performance boost rather than trying to maintain forward compatibility with a seemingly impossible case.
Sorry, something went wrong.
There was a problem hiding this comment.
I'm ok with not changing this path though I would prefer to have it initialized to NULL instead in this case and before constructing the message we would put it to something. But I won't be strongly opposed to keep things as is.
Sorry, something went wrong.
There was a problem hiding this comment.
I've switched it to char*. Does that suffice?
Sorry, something went wrong.
| if (suggest_missing_self) { | ||
| self_hint = PyUnicode_FromString( | ||
| ". Did you forget to declare 'self' as the first parameter?"); | ||
| if (self_hint == NULL) { |
There was a problem hiding this comment.
We should actually propagate the exception in this case, and not suggest anything at all. This is already the case when creating kwonly_sig
Sorry, something went wrong.
| } | ||
| if (should_suggest_missing_self) { | ||
| self_hint = PyUnicode_FromString( | ||
| ". Did you forget the 'self' parameter in the function definition?"); |
There was a problem hiding this comment.
Would this suggestion be also there if we are using classmethods? Or what about methodws on metaclasses? they can have cls as the first parameter name.
Sorry, something went wrong.
There was a problem hiding this comment.
I've added exemption for those cases.
Sorry, something went wrong.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request. |
Sorry, something went wrong.
Documentation build overview427 files changed · + 12 added · ± 415 modified + Added
± Modified |
Sorry, something went wrong.
|
@picnixz , I've added tests with classmethods, staticmethods and instancemethods with classes/metaclasses. @sobolevn, I've added tests. @ZeroIntensity , I've added news. At a high level, I feel like I've taken on too much complexity in one PR. If people can chime on what feels good enough, that'd be great. This is ready for next round of review. |
Sorry, something went wrong.
|
I have made the requested changes; please review again |
Sorry, something went wrong.
|
Thanks for making the requested changes! @picnixz: please review the changes made to this pull request. |
Sorry, something went wrong.
|
reminder to review |
Sorry, something went wrong.
If you get a hard time getting reviews, you can request one in https://discuss.python.org/c/core-dev/23 under the tag #review-request |
Sorry, something went wrong.
There was a problem hiding this comment.
Sorry for the delay!
The crux of the change looks pretty good. I left a number of housekeeping comments below.
Sorry, something went wrong.
There was a problem hiding this comment.
LGTM. I'll run the buildbots before merging.
Sorry, something went wrong.
|
🤖 New build scheduled with the buildbot fleet by @ZeroIntensity for commit a4c2623 🤖 Results will be shown at: https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F152326%2Fmerge If you want to schedule another build, you need to add the 🔨 test-with-buildbots label again. |
Sorry, something went wrong.
| Back | FazBrowse Home | New Git URL |
Uh oh!
There was an error while loading. Please reload this page.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.