Skip to content

stubgen: preserve enum value initialisers #17125

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 21, 2024
Merged

stubgen: preserve enum value initialisers #17125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bd5906
stubgen: preserve enum value initialisers
hauntsaninja Apr 15, 2024
97fcf07
.
hauntsaninja May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions mypy/stubgen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,7 @@ def __init__(
self.analyzed = analyzed
# Short names of methods defined in the body of the current class
self.method_names: set[str] = set()
self.processing_enum = False
self.processing_dataclass = False

def visit_mypy_file(self, o: MypyFile) -> None:
Expand Down Expand Up @@ -727,6 +728,8 @@ def visit_class_def(self, o: ClassDef) -> None:
if base_types:
for base in base_types:
self.import_tracker.require_name(base)
if self.analyzed and o.info.is_enum:
self.processing_enum = True
if isinstance(o.metaclass, (NameExpr, MemberExpr)):
meta = o.metaclass.accept(AliasPrinter(self))
base_types.append("metaclass=" + meta)
Expand Down Expand Up @@ -756,6 +759,7 @@ def visit_class_def(self, o: ClassDef) -> None:
self._state = CLASS
self.method_names = set()
self.processing_dataclass = False
self.processing_enum = False
self._current_class = None

def get_base_types(self, cdef: ClassDef) -> list[str]:
Expand Down Expand Up @@ -1153,6 +1157,9 @@ def get_init(
# Final without type argument is invalid in stubs.
final_arg = self.get_str_type_of_node(rvalue)
typename += f"[{final_arg}]"
elif self.processing_enum:
initializer, _ = self.get_str_default_of_node(rvalue)
return f"{self._indent}{lvalue} = {initializer}\n"
elif self.processing_dataclass:
# attribute without annotation is not a dataclass field, don't add annotation.
return f"{self._indent}{lvalue} = ...\n"
Expand Down
24 changes: 24 additions & 0 deletions test-data/unit/stubgen.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4342,3 +4342,27 @@ alias = tuple[()]
def f(x: tuple[()]): ...

class C(tuple[()]): ...

[case testPreserveEnumValue_semanal]
Copy link
Member

Choose a reason for hiding this comment

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

Can you test what happens with an enum over a nontrivial type, like a user-defined class?

from enum import Enum

class Foo(Enum):
A = 1
B = 2
C = 3

class Bar(Enum):
A = object()
B = "a" + "b"

[out]
from enum import Enum

class Foo(Enum):
A = 1
B = 2
C = 3

class Bar(Enum):
A = ...
B = ...
Loading