🚨 make linter happy

Author: yanyongyu

.github/workflows/pyright.yml

@@ -45,3 +45,24 @@ jobs:
         uses: jakebailey/pyright-action@v2
         with:
           pylance-version: latest-release
+          extra-args: githubkit
+
+  lint-codegen:
+    name: Codegen Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python environment
+        uses: ./.github/actions/setup-python
+
+      - run: |
+          echo "$(dirname $(uv python find))" >> $GITHUB_PATH
+        shell: bash
+
+      - name: Run Pyright
+        uses: jakebailey/pyright-action@v2
+        with:
+          working-directory: ./codegen
+          pylance-version: latest-release

codegen/pyproject.toml

@@ -4,3 +4,9 @@ target-version = "py310"
 
 [tool.ruff.lint]
 ignore = ["TID"]
+
+# pyright config for ci check
+[tool.pyright]
+extends = "../pyproject.toml"
+
+executionEnvironments = [{ root = ".", pythonVersion = "3.10" }]

codegen/templates/webhooks/event.py.jinja

@@ -44,7 +44,7 @@ action_types: dict[str, type[GitHubModel]] = {
     {% for webhook in webhooks %}
     "{{ webhook.action }}": {{ webhook.event_schema.get_type_string() }},
     {% endfor %}
-}
+}  # pyright: ignore[reportAssignmentType]
 {% else %}
 action_types = {{ (webhooks | first).event_schema.get_type_string() }}
 {% endif %}

githubkit/compat.py

@@ -97,9 +97,21 @@ class ExtraGitHubModel(BaseModel):
         class Config:
             extra = Extra.allow
 
+    @overload
+    def type_validate_python(type_: type[T], data: Any) -> T: ...
+
+    @overload
+    def type_validate_python(type_: Any, data: Any) -> Any: ...
+
     def type_validate_python(type_: type[T], data: Any) -> T:
         return parse_obj_as(type_, data)
 
+    @overload
+    def type_validate_json(type_: type[T], data: Any) -> T: ...
+
+    @overload
+    def type_validate_json(type_: Any, data: Any) -> Any: ...
+
     def type_validate_json(type_: type[T], data: Any) -> T:
         return parse_raw_as(type_, data)
 

githubkit/versions/ghec_v2022_11_28/webhooks/branch_protection_configuration.py

@@ -32,7 +32,7 @@
 action_types: dict[str, type[GitHubModel]] = {
     "disabled": WebhookBranchProtectionConfigurationDisabled,
     "enabled": WebhookBranchProtectionConfigurationEnabled,
-}
+}  # pyright: ignore[reportAssignmentType]
 
 branch_protection_configuration_action_types = action_types
 

githubkit/versions/ghec_v2022_11_28/webhooks/branch_protection_rule.py

@@ -35,7 +35,7 @@
     "created": WebhookBranchProtectionRuleCreated,
     "deleted": WebhookBranchProtectionRuleDeleted,
     "edited": WebhookBranchProtectionRuleEdited,
-}
+}  # pyright: ignore[reportAssignmentType]
 
 branch_protection_rule_action_types = action_types
 

githubkit/versions/ghec_v2022_11_28/webhooks/check_run.py

@@ -38,7 +38,7 @@
     "created": WebhookCheckRunCreated,
     "requested_action": WebhookCheckRunRequestedAction,
     "rerequested": WebhookCheckRunRerequested,
-}
+}  # pyright: ignore[reportAssignmentType]
 
 check_run_action_types = action_types
 

githubkit/versions/ghec_v2022_11_28/webhooks/check_suite.py

@@ -35,7 +35,7 @@
     "completed": WebhookCheckSuiteCompleted,
     "requested": WebhookCheckSuiteRequested,
     "rerequested": WebhookCheckSuiteRerequested,
-}
+}  # pyright: ignore[reportAssignmentType]
 
 check_suite_action_types = action_types
 

githubkit/versions/ghec_v2022_11_28/webhooks/code_scanning_alert.py

@@ -44,7 +44,7 @@
     "fixed": WebhookCodeScanningAlertFixed,
     "reopened": WebhookCodeScanningAlertReopened,
     "reopened_by_user": WebhookCodeScanningAlertReopenedByUser,
-}
+}  # pyright: ignore[reportAssignmentType]
 
 code_scanning_alert_action_types = action_types
 

githubkit/versions/ghec_v2022_11_28/webhooks/custom_property.py

@@ -38,7 +38,7 @@
     "deleted": WebhookCustomPropertyDeleted,
     "promote_to_enterprise": WebhookCustomPropertyPromotedToEnterprise,
     "updated": WebhookCustomPropertyUpdated,
-}
+}  # pyright: ignore[reportAssignmentType]
 
 custom_property_action_types = action_types