chore: enable pyright checks

Changed the CI to install py-gitguardian in a virtualenv, because that is
what our pyright pre-commit config expects.

Author: agateau-gg

.github/workflows/test-lint.yml

@@ -25,7 +25,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install --upgrade pipenv==2022.10.4 pre-commit
-          pipenv install --system --skip-lock
+          pipenv install --dev --skip-lock
 
       - uses: actions/cache@v3
         with:

.pre-commit-config.yaml

@@ -12,11 +12,17 @@ repos:
     hooks:
       - id: flake8
 
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.961
-    hooks:
-      - id: mypy
-        additional_dependencies: [types-requests]
+  # use a "local" repo and not the pyright hook to ensure pyright runs in the same virtualenv
+  # as the rest of the code
+  - repo: local
+    hooks:
+      - id: pyright
+        name: pyright
+        entry: 'pipenv run pyright'
+        language: system
+        types: [python]
+        # do not pass filenames, otherwise Pyright might scan files we don't want it to scan
+        pass_filenames: false
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.3.0

Pipfile

@@ -16,7 +16,6 @@ pre-commit = "*"
 pytest = "*"
 vcrpy = ">=4.3.0,!=4.3.1,<4.4.0"  # v4.3.1 broke decode_compressed_response
 urllib3 = "<2" # pin until https://github.com/kevin1024/vcrpy/issues/688 is fixed
-mypy = "==0.961"
-types-requests = "*"
 scriv = { version = "*", extras = ["toml"] }
 responses = ">=0.23.1,<0.24.0"
+pyright = "==1.1.313"

pyproject.toml

@@ -6,26 +6,8 @@ line-length = 88
 profile = "black"
 lines_after_imports = 2
 
-[tool.mypy]
-python_version = "3.9"
-warn_return_any = true
-check_untyped_defs = true
-disallow_incomplete_defs = true
-disallow_untyped_defs = true
-follow_imports = "silent"
-ignore_missing_imports = true
-no_implicit_optional = true
-strict_equality = true
-strict_optional = true
-warn_incomplete_stub = true
-warn_redundant_casts = true
-warn_unreachable = true
-warn_unused_configs = true
-warn_unused_ignores = true
-
-[[tool.mypy.overrides]]
-module = ["tests.*", "examples.*"]
-ignore_errors = true
+[tool.pyright]
+include = ["pygitguardian"]
 
 [tool.scriv]
 version = "literal: pygitguardian/__init__.py: __version__"