Skip to content

Prevent list method from shadowing list in type annotations #184

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Prevent list method from shadowing list in type annotations #184

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions codegen/parser/schemas/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,38 +357,46 @@ class ListSchema(SchemaData):

@override
def get_type_string(self, include_constraints: bool = True) -> str:
type_string = f"list[{self.item_schema.get_type_string()}]"
type_string = f"builtins.list[{self.item_schema.get_type_string()}]"
if include_constraints and (args := self._get_field_args()):
return f"Annotated[{type_string}, {self._get_field_string(args)}]"
return type_string

@override
def get_param_type_string(self) -> str:
return f"list[{self.item_schema.get_param_type_string()}]"
# We **must** refer to `builtins.list` here explicitly to avoid shadowing:
# class A:
# def list(self): ...
# def meth(self) -> list[int]: ... # Oops, it's the `list` method, bad hint
return f"builtins.list[{self.item_schema.get_param_type_string()}]"

@override
def get_model_imports(self) -> set[str]:
imports = super().get_model_imports()
imports.add("from githubkit.compat import PYDANTIC_V2")
imports.add("import builtins")
imports.update(self.item_schema.get_model_imports())
return imports

@override
def get_type_imports(self) -> set[str]:
imports = super().get_type_imports()
imports.add("import builtins")
imports.update(self.item_schema.get_type_imports())
return imports

@override
def get_param_imports(self) -> set[str]:
imports = super().get_param_imports()
imports.add("import builtins")
imports.update(self.item_schema.get_param_imports())
return imports

@override
def get_using_imports(self) -> set[str]:
imports = super().get_using_imports()
imports.add("from githubkit.compat import PYDANTIC_V2")
imports.add("import builtins")
imports.update(self.item_schema.get_using_imports())
return imports

Expand Down