Enum private attributes are not enum members #17182
Conversation
This comment has been minimized.
This comment has been minimized.
| @@ -1139,8 +1139,8 @@ def analyze_enum_class_attribute_access( | |||
| # Skip these since Enum will remove it | |||
| if name in ENUM_REMOVED_PROPS: | |||
| return report_missing_attribute(mx.original_type, itype, name, mx) | |||
| # For other names surrendered by underscores, we don't make them Enum members | |||
| if name.startswith("__") and name.endswith("__") and name.replace("_", "") != "": | |||
| # Dunders and private names are not Enum members | |||
There was a problem hiding this comment.
nit: I would call any name that starts with a single underscore a "private" (by convention) name, and any name that starts with two underscores a "mangled" name
| # Dunders and private names are not Enum members | |
| # Dunders and mangled names are not Enum members |
(There's several other places in this PR where you also refer to them as "private" names; I'd change those too, personally)
There was a problem hiding this comment.
I used the same terminology used by the enum docs: https://docs.python.org/3/howto/enum.html#private-names
There was a problem hiding this comment.
Fair enough... though I sorta think the docs there are using the wrong terminology... but hey :P
| B = 2 | ||
| __my_dict = {A: "ham", B: "spam"} | ||
|
|
||
| x: MyEnum = MyEnum.__my_dict # E: Incompatible types in assignment (expression has type "Dict[int, str]", variable has type "MyEnum") |
There was a problem hiding this comment.
Hmm, I'm not sure this is correct? The name is mangled at runtime, so this attempted attribute access fails with an exception unless you use the mangled name:
>>> from enum import Enum
>>> class Foo(Enum):
... __x = 'y'
... y = 'z'
...
>>> Foo.__x
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: type object 'Foo' has no attribute '__x'
>>> Foo._Foo__x
'y'This PR definitely improves the handling of mangled names in enum class namespaces, but really mypy should be warning that MyEnum has no attribute __my_dict here (it has a _MyEnum__my_dict attribute instead). I think that's at least worth a comment, if it's not an easy fix.
There was a problem hiding this comment.
Hmm, I'm not sure this is correct?
It isn't :D, but mypy doesn't understand name mangling yet and it is out of scope here. You are right however, there should be a comment.
There was a problem hiding this comment.
oof, we don't understand name mangling in any context? 😬
You are right however, there should be a comment.
Thanks!
There was a problem hiding this comment.
We don't: https://mypy-play.net/?mypy=latest&python=3.12&gist=13d2e1e6e60b8e3828129fc44b336381 but there is already an issue for that #8267
There was a problem hiding this comment.
Oh and a PR #16715
This comment has been minimized.
This comment has been minimized.
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
This adds on to the change in python#17182 and fixes enum attributes being used as members.
This adds on to the change in python#17182 and fixes enum attributes being used as members.
This adds on to the change in #17182 and fixes enum attributes being used as members. Fixes: #16730 --------- Co-authored-by: Jelle Zijlstra <[email protected]> Co-authored-by: Ali Hamdan <[email protected]> Co-authored-by: hauntsaninja <[email protected]>
Fixes #17098