Merge pull request #41 from casework/test_type_annotations

Test type annotations

.github/workflows/ci.yml

@@ -30,6 +30,9 @@ jobs:
       - name: Pre-commit Checks
         run: pre-commit run --all-files
 
+      - name: Type Checking
+        run: poetry run mypy case_mapping example.py tests
+
       - name: Unit Tests
         run: poetry run pytest --doctest-modules
 

Makefile

@@ -34,6 +34,9 @@ all: \
   .venv-pre-commit/var/.pre-commit-built.log \
   case.jsonld
 
+.PHONY: \
+  check-mypy
+
 # This virtual environment is meant to be built once and then persist, even through 'make clean'.
 # If a recipe is written to remove this flag file, it should first run `pre-commit uninstall`.
 .venv-pre-commit/var/.pre-commit-built.log:
@@ -101,6 +104,15 @@ case.ttl: \
 
 check: \
   all \
+  check-mypy \
   case.ttl
 	source venv/bin/activate \
 	  && poetry run pytest --doctest-modules
+
+check-mypy: \
+  .venv.done.log
+	source venv/bin/activate \
+	  && mypy \
+	    case_mapping \
+	    example.py \
+	    tests

case_mapping/uco/core.py

@@ -17,7 +17,7 @@ def __init__(
         The main CASE Object for representing a case and its activities and objects.
         """
         super().__init__(*args, **kwargs)
-        self.build = []
+        self.build = []  # type: ignore
         self["@context"] = {
             "@vocab": "http://caseontology.org/core#",
             "case-investigation": "https://ontology.caseontology.org/case/investigation/",

pyproject.toml

@@ -23,7 +23,9 @@ python = "^3.9"
 pytz = "^2023.3.post1"
 
 [tool.poetry.dev-dependencies]
+mypy = "^1"
 pytest = "^7.4.2"
+types-pytz = "^2024"
 
 [build-system]
 requires = ["poetry-core"]