Make the library strictly typed (#328)

Author: ggravlingen

.github/workflows/test.yml

@@ -132,8 +132,10 @@ jobs:
           pre-commit run --hook-stage manual ruff-format --all-files --show-diff-on-failure
         env:
           RUFF_OUTPUT_FORMAT: github
-      #     - name: Run mypy
-      #       run: mypy pyesef
+      - name: Run mypy
+        run: |
+          source .venv/bin/activate
+          pre-commit run --hook-stage manual mypy --all-files --show-diff-on-failure
 
   pytest:
     name: Run test suite

.pre-commit-config.yaml

@@ -20,3 +20,13 @@ repos:
       - id: no-commit-to-branch
         args:
           - --branch=main
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: >
+          ./script/run-in-env.sh mypy --config-file pyproject.toml
+        language: script
+        types: [python]
+        require_serial: true
+        files: ^pygleif/.+\.py$

pygleif/api/data.py

@@ -127,11 +127,11 @@ class Links(BaseSchema):
 class Relationships(BaseSchema):
     """Represent a relationships ."""
 
-    managing_lou: Links = None
-    lei_issuer: Links = None
-    field_modifications: Links = None
-    direct_parent: Links = None
-    ultimate_parent: Links = None
+    managing_lou: Links | None = None
+    lei_issuer: Links | None = None
+    field_modifications: Links | None = None
+    direct_parent: Links | None = None
+    ultimate_parent: Links | None = None
 
 
 class Data(BaseSchema):

pygleif/base.py

@@ -29,15 +29,15 @@ class PyGleifBase(ABC):
     search_string: str
 
     @property
-    def json_response(self) -> list[Any] | dict[Any, Any]:
+    def json_response(self) -> dict[Any, Any]:
         """Return JSON response."""
         full_url = f"{self.BASE_URL}{self.search_string}"
         try:
             with request.urlopen(
                 full_url,
                 timeout=self.TIMEOUT_SECOND,
             ) as fdesc:
-                return cast(dict[Any, Any] | list[Any], json.loads(fdesc.read()))
+                return cast(dict[Any, Any], json.loads(fdesc.read()))
         except error.HTTPError as e:
             if e.code == HttpErrorCodes.NOT_FOUND:
                 raise PyGLEIFApiError(f"Resource {full_url} not found")

pygleif/py.typed

@@ -49,6 +49,9 @@ version = {file = "pygleif/VERSION"}
 [tool.setuptools.packages.find]
 exclude = ["tests", "tests*"]
 
+[tool.setuptools.package-data]
+"pygleif" = ["py.typed"]
+
 [tool.pytest.ini_options]
 testpaths = [
     "tests",
@@ -120,3 +123,8 @@ known-first-party = [
   "pygleif",
   "tests",
 ]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+plugins = "pydantic.mypy"