Skip to content

Commit

Permalink
stubgen: fix FunctionContext.fullname for nested classes (#17963)
Browse files Browse the repository at this point in the history
This fixes an issue with the computation of `FunctionContext.fullname`
for nested classes.

For a module named `spangle`, with the following classes:

```python
class Foo:
    class Bar:
        pass
```

The previous output for the class `Bar` was `"spangle.Bar"` and with
this fix it is now `"spangle.Foo.Bar"`.
  • Loading branch information
chadrik authored Nov 2, 2024
1 parent 05a9e79 commit 1f200dd
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 10 deletions.
16 changes: 11 additions & 5 deletions mypy/stubgen.py
Original file line number Diff line number Diff line change
Expand Up @@ -472,14 +472,18 @@ def __init__(
self._vars: list[list[str]] = [[]]
# What was generated previously in the stub file.
self._state = EMPTY
self._current_class: ClassDef | None = None
self._class_stack: list[ClassDef] = []
# Was the tree semantically analysed before?
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

@property
def _current_class(self) -> ClassDef | None:
return self._class_stack[-1] if self._class_stack else None

def visit_mypy_file(self, o: MypyFile) -> None:
self.module_name = o.fullname # Current module being processed
self.path = o.path
Expand Down Expand Up @@ -651,12 +655,14 @@ def visit_func_def(self, o: FuncDef) -> None:
if init_code:
self.add(init_code)

if self._current_class is not None:
if self._class_stack:
if len(o.arguments):
self_var = o.arguments[0].variable.name
else:
self_var = "self"
class_info = ClassInfo(self._current_class.name, self_var)
class_info: ClassInfo | None = None
for class_def in self._class_stack:
class_info = ClassInfo(class_def.name, self_var, parent=class_info)
else:
class_info = None

Expand Down Expand Up @@ -746,7 +752,7 @@ def get_fullname(self, expr: Expression) -> str:
return self.resolve_name(name)

def visit_class_def(self, o: ClassDef) -> None:
self._current_class = o
self._class_stack.append(o)
self.method_names = find_method_names(o.defs.body)
sep: int | None = None
if self.is_top_level() and self._state != EMPTY:
Expand Down Expand Up @@ -792,8 +798,8 @@ def visit_class_def(self, o: ClassDef) -> None:
self._state = CLASS
self.method_names = set()
self.processing_dataclass = False
self._class_stack.pop(-1)
self.processing_enum = False
self._current_class = None

def get_base_types(self, cdef: ClassDef) -> list[str]:
"""Get list of base classes for a class."""
Expand Down
10 changes: 7 additions & 3 deletions mypy/stubgenc.py
Original file line number Diff line number Diff line change
Expand Up @@ -787,7 +787,9 @@ def get_base_types(self, obj: type) -> list[str]:
bases.append(base)
return [self.strip_or_import(self.get_type_fullname(base)) for base in bases]

def generate_class_stub(self, class_name: str, cls: type, output: list[str]) -> None:
def generate_class_stub(
self, class_name: str, cls: type, output: list[str], parent_class: ClassInfo | None = None
) -> None:
"""Generate stub for a single class using runtime introspection.
The result lines will be appended to 'output'. If necessary, any
Expand All @@ -808,7 +810,9 @@ def generate_class_stub(self, class_name: str, cls: type, output: list[str]) ->
self.record_name(class_name)
self.indent()

class_info = ClassInfo(class_name, "", getattr(cls, "__doc__", None), cls)
class_info = ClassInfo(
class_name, "", getattr(cls, "__doc__", None), cls, parent=parent_class
)

for attr, value in items:
# use unevaluated descriptors when dealing with property inspection
Expand Down Expand Up @@ -843,7 +847,7 @@ def generate_class_stub(self, class_name: str, cls: type, output: list[str]) ->
class_info,
)
elif inspect.isclass(value) and self.is_defined_in_module(value):
self.generate_class_stub(attr, value, types)
self.generate_class_stub(attr, value, types, parent_class=class_info)
else:
attrs.append((attr, value))

Expand Down
16 changes: 14 additions & 2 deletions mypy/stubutil.py
Original file line number Diff line number Diff line change
Expand Up @@ -307,12 +307,18 @@ def args_str(self, args: Iterable[Type]) -> str:

class ClassInfo:
def __init__(
self, name: str, self_var: str, docstring: str | None = None, cls: type | None = None
self,
name: str,
self_var: str,
docstring: str | None = None,
cls: type | None = None,
parent: ClassInfo | None = None,
) -> None:
self.name = name
self.self_var = self_var
self.docstring = docstring
self.cls = cls
self.parent = parent


class FunctionContext:
Expand All @@ -335,7 +341,13 @@ def __init__(
def fullname(self) -> str:
if self._fullname is None:
if self.class_info:
self._fullname = f"{self.module_name}.{self.class_info.name}.{self.name}"
parents = []
class_info: ClassInfo | None = self.class_info
while class_info is not None:
parents.append(class_info.name)
class_info = class_info.parent
namespace = ".".join(reversed(parents))
self._fullname = f"{self.module_name}.{namespace}.{self.name}"
else:
self._fullname = f"{self.module_name}.{self.name}"
return self._fullname
Expand Down
11 changes: 11 additions & 0 deletions mypy/test/teststubgen.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
from mypy.stubgenc import InspectionStubGenerator, infer_c_method_args
from mypy.stubutil import (
ClassInfo,
FunctionContext,
common_dir_prefix,
infer_method_ret_type,
remove_misplaced_type_comments,
Expand Down Expand Up @@ -612,6 +613,16 @@ def test_common_dir_prefix_win(self) -> None:
assert common_dir_prefix([r"foo\bar/x.pyi"]) == r"foo\bar"
assert common_dir_prefix([r"foo/bar/x.pyi"]) == r"foo\bar"

def test_function_context_nested_classes(self) -> None:
ctx = FunctionContext(
module_name="spangle",
name="foo",
class_info=ClassInfo(
name="Nested", self_var="self", parent=ClassInfo(name="Parent", self_var="self")
),
)
assert ctx.fullname == "spangle.Parent.Nested.foo"


class StubgenHelpersSuite(unittest.TestCase):
def test_is_blacklisted_path(self) -> None:
Expand Down

0 comments on commit 1f200dd

Please sign in to comment.