🐛 Prevent invalid annotations caused by list shadowing by method signature.

Author: sterliakov

codegen/parser/schemas/schema.py

@@ -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
 

githubkit/rest/__init__.py

@@ -31,6 +31,24 @@
     from githubkit.versions.v2022_11_28.models import (
         ActionsGetDefaultWorkflowPermissions as ActionsGetDefaultWorkflowPermissions,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        ActionsHostedRunner as ActionsHostedRunner,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        ActionsHostedRunnerImage as ActionsHostedRunnerImage,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        ActionsHostedRunnerLimits as ActionsHostedRunnerLimits,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        ActionsHostedRunnerLimitsPropPublicIps as ActionsHostedRunnerLimitsPropPublicIps,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        ActionsHostedRunnerMachineSpec as ActionsHostedRunnerMachineSpec,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        ActionsHostedRunnerPoolImage as ActionsHostedRunnerPoolImage,
+    )
     from githubkit.versions.v2022_11_28.models import (
         ActionsOrganizationPermissions as ActionsOrganizationPermissions,
     )
@@ -1039,6 +1057,10 @@
     from githubkit.versions.v2022_11_28.models import (
         MovedColumnInProjectIssueEventPropProjectCard as MovedColumnInProjectIssueEventPropProjectCard,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        NetworkConfiguration as NetworkConfiguration,
+    )
+    from githubkit.versions.v2022_11_28.models import NetworkSettings as NetworkSettings
     from githubkit.versions.v2022_11_28.models import (
         NotificationsPutBody as NotificationsPutBody,
     )
@@ -1141,6 +1163,30 @@
     from githubkit.versions.v2022_11_28.models import (
         OrgsOrgActionsCacheUsageByRepositoryGetResponse200 as OrgsOrgActionsCacheUsageByRepositoryGetResponse200,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgActionsHostedRunnersGetResponse200 as OrgsOrgActionsHostedRunnersGetResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgActionsHostedRunnersHostedRunnerIdPatchBody as OrgsOrgActionsHostedRunnersHostedRunnerIdPatchBody,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgActionsHostedRunnersImagesGithubOwnedGetResponse200 as OrgsOrgActionsHostedRunnersImagesGithubOwnedGetResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgActionsHostedRunnersImagesPartnerGetResponse200 as OrgsOrgActionsHostedRunnersImagesPartnerGetResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgActionsHostedRunnersMachineSizesGetResponse200 as OrgsOrgActionsHostedRunnersMachineSizesGetResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgActionsHostedRunnersPlatformsGetResponse200 as OrgsOrgActionsHostedRunnersPlatformsGetResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgActionsHostedRunnersPostBody as OrgsOrgActionsHostedRunnersPostBody,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgActionsHostedRunnersPostBodyPropImage as OrgsOrgActionsHostedRunnersPostBodyPropImage,
+    )
     from githubkit.versions.v2022_11_28.models import (
         OrgsOrgActionsPermissionsPutBody as OrgsOrgActionsPermissionsPutBody,
     )
@@ -1156,6 +1202,9 @@
     from githubkit.versions.v2022_11_28.models import (
         OrgsOrgActionsRunnerGroupsPostBody as OrgsOrgActionsRunnerGroupsPostBody,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgActionsRunnerGroupsRunnerGroupIdHostedRunnersGetResponse200 as OrgsOrgActionsRunnerGroupsRunnerGroupIdHostedRunnersGetResponse200,
+    )
     from githubkit.versions.v2022_11_28.models import (
         OrgsOrgActionsRunnerGroupsRunnerGroupIdPatchBody as OrgsOrgActionsRunnerGroupsRunnerGroupIdPatchBody,
     )
@@ -1429,6 +1478,15 @@
     from githubkit.versions.v2022_11_28.models import (
         OrgsOrgSecurityProductEnablementPostBody as OrgsOrgSecurityProductEnablementPostBody,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgSettingsNetworkConfigurationsGetResponse200 as OrgsOrgSettingsNetworkConfigurationsGetResponse200,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgSettingsNetworkConfigurationsNetworkConfigurationIdPatchBody as OrgsOrgSettingsNetworkConfigurationsNetworkConfigurationIdPatchBody,
+    )
+    from githubkit.versions.v2022_11_28.models import (
+        OrgsOrgSettingsNetworkConfigurationsPostBody as OrgsOrgSettingsNetworkConfigurationsPostBody,
+    )
     from githubkit.versions.v2022_11_28.models import (
         OrgsOrgTeamsPostBody as OrgsOrgTeamsPostBody,
     )
@@ -1703,6 +1761,7 @@
     from githubkit.versions.v2022_11_28.models import (
         ProtectedBranchRequiredStatusCheckPropChecksItems as ProtectedBranchRequiredStatusCheckPropChecksItems,
     )
+    from githubkit.versions.v2022_11_28.models import PublicIp as PublicIp
     from githubkit.versions.v2022_11_28.models import PublicUser as PublicUser
     from githubkit.versions.v2022_11_28.models import (
         PublicUserPropPlan as PublicUserPropPlan,
@@ -9641,6 +9700,7 @@
             "GlobalAdvisoryPropCreditsItems",
             "BasicError",
             "ValidationErrorSimple",
+            "Enterprise",
             "IntegrationPropPermissions",
             "Integration",
             "WebhookConfig",
@@ -9654,7 +9714,6 @@
             "HookDeliveryPropRequestPropPayload",
             "HookDeliveryPropResponse",
             "HookDeliveryPropResponsePropHeaders",
-            "Enterprise",
             "IntegrationInstallationRequest",
             "AppPermissions",
             "Installation",
@@ -9754,6 +9813,13 @@
             "OrganizationFull",
             "OrganizationFullPropPlan",
             "ActionsCacheUsageOrgEnterprise",
+            "ActionsHostedRunnerMachineSpec",
+            "ActionsHostedRunner",
+            "ActionsHostedRunnerPoolImage",
+            "PublicIp",
+            "ActionsHostedRunnerImage",
+            "ActionsHostedRunnerLimits",
+            "ActionsHostedRunnerLimitsPropPublicIps",
             "OidcCustomSub",
             "ActionsOrganizationPermissions",
             "SelectedActions",
@@ -9920,6 +9986,7 @@
             "ActionsBillingUsagePropMinutesUsedBreakdown",
             "PackagesBillingUsage",
             "CombinedBillingUsage",
+            "NetworkSettings",
             "TeamFull",
             "TeamOrganization",
             "TeamOrganizationPropPlan",
@@ -12536,13 +12603,22 @@
             "OrgsOrgPatchBody",
             "OrgsOrgActionsCacheUsageByRepositoryGetResponse200",
             "ActionsCacheUsageByRepository",
+            "OrgsOrgActionsHostedRunnersGetResponse200",
+            "OrgsOrgActionsHostedRunnersPostBody",
+            "OrgsOrgActionsHostedRunnersPostBodyPropImage",
+            "OrgsOrgActionsHostedRunnersImagesGithubOwnedGetResponse200",
+            "OrgsOrgActionsHostedRunnersImagesPartnerGetResponse200",
+            "OrgsOrgActionsHostedRunnersMachineSizesGetResponse200",
+            "OrgsOrgActionsHostedRunnersPlatformsGetResponse200",
+            "OrgsOrgActionsHostedRunnersHostedRunnerIdPatchBody",
             "OrgsOrgActionsPermissionsPutBody",
             "OrgsOrgActionsPermissionsRepositoriesGetResponse200",
             "OrgsOrgActionsPermissionsRepositoriesPutBody",
             "OrgsOrgActionsRunnerGroupsGetResponse200",
             "RunnerGroupsOrg",
             "OrgsOrgActionsRunnerGroupsPostBody",
             "OrgsOrgActionsRunnerGroupsRunnerGroupIdPatchBody",
+            "OrgsOrgActionsRunnerGroupsRunnerGroupIdHostedRunnersGetResponse200",
             "OrgsOrgActionsRunnerGroupsRunnerGroupIdRepositoriesGetResponse200",
             "OrgsOrgActionsRunnerGroupsRunnerGroupIdRepositoriesPutBody",
             "OrgsOrgActionsRunnerGroupsRunnerGroupIdRunnersGetResponse200",
@@ -12634,6 +12710,10 @@
             "OrgsOrgReposPostBodyPropCustomProperties",
             "OrgsOrgRulesetsPostBody",
             "OrgsOrgRulesetsRulesetIdPutBody",
+            "OrgsOrgSettingsNetworkConfigurationsGetResponse200",
+            "NetworkConfiguration",
+            "OrgsOrgSettingsNetworkConfigurationsPostBody",
+            "OrgsOrgSettingsNetworkConfigurationsNetworkConfigurationIdPatchBody",
             "OrgsOrgTeamsPostBody",
             "OrgsOrgTeamsTeamSlugPatchBody",
             "OrgsOrgTeamsTeamSlugDiscussionsPostBody",