Pre-commit demo

.github/workflows/lint.yaml

@@ -1,49 +1,30 @@
 ---
 name: "Lint"
-on: # yamllint disable-line rule:truthy
+on:  # yamllint disable-line rule:truthy
   push:
     branches:
       - "main"
   pull_request:
     branches: ["*"]
 jobs:
   lint:
-    name: "Format & Lint"
+    # Uses pre-commit to run all checks
     runs-on: "ubuntu-latest"
-    strategy:
-      matrix:
-        python-version:
-          - "3.10"
-      fail-fast: false
     steps:
       - uses: "actions/checkout@v4"
-      - uses: "bewuethr/[email protected]"
+      - name: "Install Poetry"
+        uses: "snok/install-poetry@v1"
         with:
-          config-file: ".yamllint"
+          # This should come from pyproject.toml but poetry
+          # wasn't picking it up for whatever reason.
+          virtualenvs-in-project: true
+          virtualenvs-path: ".venv"
       - uses: "actions/setup-python@v5"
         with:
-          python-version: "3.10"
-      - name: "Setup Python Environment"
-        run: "pip install -U pip virtualenv"
-      - name: "Install Dependencies"
-        run: |
-          virtualenv ~/.cache/virtualenv/authzedpy
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          pip install poetry
-          poetry env info
-          poetry install --only dev
-      - name: "Pyflakes"
-        run: |
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          find . -name "*.py" | grep -v "_pb2" | xargs pyflakes
-      - name: "Blacken"
-        run: |
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          black --check --diff .
-      - name: "Isort"
-        run: |
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          find . -name "*.py" | grep -v "_pb2" | xargs isort --check --diff
+          python-version: "3.11"
+          cache: 'poetry'
+      - run: "poetry install"
+      - uses: "pre-commit/[email protected]"
   codeql:
     name: "Analyze with CodeQL"
     runs-on: "ubuntu-latest"
@@ -75,24 +56,3 @@ jobs:
         uses: "github/codeql-action/upload-sarif@v3"
         with:
           sarif_file: "trivy-results.sarif"
-  mypy:
-    name: "Type Check with Mypy"
-    runs-on: "ubuntu-latest"
-    steps:
-      - uses: "actions/checkout@v4"
-      - uses: "actions/setup-python@v5"
-        with:
-          python-version: "3.10"
-      - name: "Setup Python Environment"
-        run: "pip install -U pip virtualenv"
-      - name: "Install Dependencies"
-        run: |
-          virtualenv ~/.cache/virtualenv/authzedpy
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          pip install poetry
-          poetry env info
-          poetry install --only dev
-      - name: "mypy"
-        run: |
-          source ~/.cache/virtualenv/authzedpy/bin/activate
-          mypy authzed

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+---
+repos:
+  - repo: "https://github.com/astral-sh/ruff-pre-commit"
+    # Ruff version.
+    rev: "v0.6.1"
+    hooks:
+      # Run the linter.
+      - id: "ruff"
+        exclude: ".*_pb2.*"
+      # Run the formatter.
+      - id: "ruff-format"
+        exclude: ".*_pb2.*"
+  - repo: "https://github.com/adrienverge/yamllint"
+    rev: "v1.35.1"
+    hooks:
+      - id: "yamllint"
+  - repo: "https://github.com/RobertCraigie/pyright-python"
+    rev: "v1.1.376"
+    hooks:
+      - id: "pyright"

authzed/api/v1/__init__.py

@@ -64,7 +64,9 @@
 from authzed.api.v1.watch_service_pb2_grpc import WatchServiceStub
 
 
-class Client(SchemaServiceStub, PermissionsServiceStub, ExperimentalServiceStub, WatchServiceStub):
+class Client(
+    SchemaServiceStub, PermissionsServiceStub, ExperimentalServiceStub, WatchServiceStub
+):
     """
     v1 Authzed gRPC API client - Auto-detects sync or async depending on if initialized within an event loop
     """

authzed/api/v1/__init__.pyi

@@ -64,11 +64,19 @@ from authzed.api.v1.schema_service_pb2 import (
     WriteSchemaRequest,
     WriteSchemaResponse,
 )
-from authzed.api.v1.schema_service_pb2_grpc import SchemaServiceAsyncStub, SchemaServiceStub
+from authzed.api.v1.schema_service_pb2_grpc import (
+    SchemaServiceAsyncStub,
+    SchemaServiceStub,
+)
 from authzed.api.v1.watch_service_pb2 import WatchRequest, WatchResponse
-from authzed.api.v1.watch_service_pb2_grpc import WatchServiceAsyncStub, WatchServiceStub
+from authzed.api.v1.watch_service_pb2_grpc import (
+    WatchServiceAsyncStub,
+    WatchServiceStub,
+)
 
-class Client(SchemaServiceStub, PermissionsServiceStub, ExperimentalServiceStub, WatchServiceStub):
+class Client(
+    SchemaServiceStub, PermissionsServiceStub, ExperimentalServiceStub, WatchServiceStub
+):
     """The Client is typed as a synchronous client (though in practice it works with both sync and async code).
     If you are using the async code, you should switch to the AsyncClient class instead in order to get proper type hints
     """

examples/v1/bulk_check_permissions.py

@@ -47,5 +47,11 @@
     )
 )
 assert len(resp.pairs) == 2
-assert resp.pairs[0].item.permissionship == CheckPermissionResponse.PERMISSIONSHIP_HAS_PERMISSION
-assert resp.pairs[1].item.permissionship == CheckPermissionResponse.PERMISSIONSHIP_HAS_PERMISSION
+assert (
+    resp.pairs[0].item.permissionship
+    == CheckPermissionResponse.PERMISSIONSHIP_HAS_PERMISSION
+)
+assert (
+    resp.pairs[1].item.permissionship
+    == CheckPermissionResponse.PERMISSIONSHIP_HAS_PERMISSION
+)

examples/v1/bulk_import_export_relationships.py

@@ -60,7 +60,7 @@
     )
 ]
 
-import_reps = client.BulkImportRelationships(((req for req in reqs)))
+import_reps = client.BulkImportRelationships((req for req in reqs))
 assert import_reps.num_loaded == 2
 
 export_resp = client.BulkExportRelationships(

examples/v1alpha1/read_schema_async.py

@@ -7,7 +7,9 @@
 async def async_new_client():
     # Within an async context, the client's methods are all async:
     client = Client("grpc.authzed.com:443", bearer_token_credentials("mytoken"))
-    resp = await client.ReadSchema(ReadSchemaRequest(object_definitions_names=["example/user"]))
+    resp = await client.ReadSchema(
+        ReadSchemaRequest(object_definitions_names=["example/user"])
+    )
     print(resp)