Add mypy source review to current state

This patch is to show what is needed to add static type checking with
`mypy`.

The brunt of the effort is adding `#type: ignore` annotations to
`rdflib`.  These can be removed once an `rdflib` release with the merged
PR 1407 is issued.

The additional package in `tests/requirements.txt` pertaining to
`dateutil` was reported by `mypy`.

DISCLAIMER:
Participation by NIST in the creation of the documentation of mentioned
software is not intended to imply a recommendation or endorsement by the
National Institute of Standards and Technology, nor is it intended to
imply that any specific software is necessarily the best available for
the purpose.

References:
* [AC-211] Add static type checking to CASE-Utilities-Python
* RDFLib/rdflib#1407

Signed-off-by: Alex Nelson <alexander.nelson@nist.gov>

Author: ajnelson-nist

case_utils/__init__.py

@@ -15,7 +15,7 @@
 
 import warnings
 
-import rdflib.util
+import rdflib.util  # type: ignore
 
 from . import local_uuid
 

case_utils/case_file/__init__.py

@@ -21,7 +21,7 @@
 import hashlib
 import os
 
-import rdflib
+import rdflib  # type: ignore
 
 import case_utils
 

case_utils/case_sparql_construct/__init__.py

@@ -21,7 +21,7 @@
 import os
 import logging
 
-import rdflib.plugins.sparql
+import rdflib.plugins.sparql  # type: ignore
 
 import case_utils
 

case_utils/case_sparql_select/__init__.py

@@ -33,8 +33,8 @@
 import os
 import logging
 
-import pandas as pd
-import rdflib.plugins.sparql
+import pandas as pd  # type: ignore
+import rdflib.plugins.sparql  # type: ignore
 
 import case_utils
 

tests/Makefile

@@ -32,6 +32,7 @@ all: \
   check-case_sparql_construct \
   check-case_sparql_select \
   check-isomorphic_diff \
+  check-mypy \
   download
 
 .venv.done.log: \
@@ -79,6 +80,7 @@ all-case_sparql_select: \
 # These check calls are provided in preferred run-order.
 check: \
   check-isomorphic_diff \
+  check-mypy \
   check-case_file \
   check-case_sparql_construct \
   check-case_sparql_select
@@ -116,6 +118,18 @@ check-isomorphic_diff: \
 	  --directory isomorphic_diff \
 	  check
 
+# mypy is called against specific members of the tests directory to avoid descending into the virtual environment.
+check-mypy: \
+  .venv.done.log
+	source venv/bin/activate \
+	  && mypy \
+	    $(top_srcdir)/case_utils \
+	    case_file \
+	    case_sparql_construct \
+	    case_utils \
+	    hexbinary \
+	    src
+
 clean:
 	@$(MAKE) \
 	  --directory case_sparql_select \

tests/case_file/test_case_file.py

@@ -16,7 +16,7 @@
 import os
 
 import pytest
-import rdflib.plugins.sparql
+import rdflib.plugins.sparql  # type: ignore
 
 _logger = logging.getLogger(os.path.basename(__file__))
 

tests/case_sparql_construct/test_case_sparql_construct.py

@@ -11,7 +11,7 @@
 #
 # We would appreciate acknowledgement if the software is used.
 
-import rdflib.plugins.sparql
+import rdflib.plugins.sparql  # type: ignore
 
 import case_utils
 

tests/case_utils/test_guess_format.py

@@ -12,7 +12,7 @@
 # We would appreciate acknowledgement if the software is used.
 
 import pytest
-import rdflib
+import rdflib  # type: ignore
 
 import case_utils
 

tests/hexbinary/test_hexbinary.py

@@ -50,7 +50,7 @@
 import os
 
 import pytest
-import rdflib.plugins.sparql
+import rdflib.plugins.sparql  # type: ignore
 
 _logger = logging.getLogger(os.path.basename(__file__))
 

tests/requirements.txt

@@ -1,3 +1,5 @@
 PyLD
+mypy
 pytest
 python-dateutil
+types-python-dateutil

tests/src/compact.py

@@ -24,7 +24,7 @@
 import os
 import json
 
-import pyld
+import pyld  # type: ignore
 
 _logger = logging.getLogger(os.path.basename(__file__))
 

tests/src/glom_graph.py

@@ -17,7 +17,7 @@
 
 __version__ = "0.1.0"
 
-import rdflib
+import rdflib  # type: ignore
 
 import case_utils
 

tests/src/isomorphic_diff.py

@@ -34,7 +34,7 @@
 import os
 import sys
 
-import rdflib.compare
+import rdflib.compare  # type: ignore
 
 import case_utils