Merge pull request #23 from casework/review_types_with_mypy

Add mypy to CI

Author: ajnelson-nist

case_gnu_time/__init__.py

@@ -21,10 +21,12 @@
 import datetime
 import logging
 import os
+import typing
 
 import dateutil
 import dateutil.parser
-import rdflib
+import dateutil.relativedelta
+import rdflib.util
 
 import case_utils
 
@@ -36,7 +38,7 @@
 NS_XSD = rdflib.namespace.XSD
 
 class ProcessUCOObject(object):
-    def __init__(self, graph, ns_base, **kwargs):
+    def __init__(self, graph, ns_base, **kwargs) -> None:
         """
         Initializing a ProcessUCOObject will create one triple in the graph.  To add data to the new node, call populate_from_gnu_time_log().
         """
@@ -51,12 +53,12 @@ def __init__(self, graph, ns_base, **kwargs):
         self._node = rdflib.URIRef(ns_base[prefix_slug + case_utils.local_uuid.local_uuid()])
         self.graph.add((self.node, NS_RDF.type, NS_UCO_OBSERVABLE.Process))
 
-        self._bnode_process = None
-        self._created_time = None
-        self._exit_status = None
-        self._exit_time = None
+        self._bnode_process: typing.Optional[rdflib.BNode] = None
+        self._created_time: typing.Optional[str] = None
+        self._exit_status: typing.Optional[int] = None
+        self._exit_time: typing.Optional[str] = None
 
-    def populate_from_gnu_time_log(self, gnu_time_log):
+    def populate_from_gnu_time_log(self, gnu_time_log) -> None:
         """
         This method populates Process data from a GNU Time log file.  If self.exit_time is not set before this method is called, it will be set by reading the modification time of gnu_time_log.
         """
@@ -106,7 +108,7 @@ def populate_from_gnu_time_log(self, gnu_time_log):
         self.created_time = created_time_datetime.isoformat()
 
     @property
-    def bnode_process(self):
+    def bnode_process(self) -> rdflib.BNode:
         """
         Created on first access.
         """
@@ -117,11 +119,11 @@ def bnode_process(self):
         return self._bnode_process
 
     @property
-    def created_time(self):
+    def created_time(self) -> typing.Optional[str]:
         return self._created_time
 
     @created_time.setter
-    def created_time(self, value):
+    def created_time(self, value: str) -> None:
         """
         Only set once.
         """
@@ -132,24 +134,22 @@ def created_time(self, value):
         check_value = dateutil.parser.isoparse(str_value)
         self.graph.add((self.bnode_process, NS_UCO_OBSERVABLE.observableCreatedTime, rdflib.Literal(str_value, datatype=NS_XSD.dateTime)))
         self._created_time = value
-        return self._created_time
 
     @property
-    def exit_status(self):
+    def exit_status(self) -> typing.Optional[int]:
         return self._exit_status
 
     @exit_status.setter
-    def exit_status(self, value):
+    def exit_status(self, value: int) -> None:
         assert isinstance(value, int)
         self.graph.add((self.bnode_process, NS_UCO_OBSERVABLE.exitStatus, rdflib.Literal(value)))
-        return self._exit_status
 
     @property
-    def exit_time(self):
+    def exit_time(self) -> typing.Optional[str]:
         return self._exit_time
 
     @exit_time.setter
-    def exit_time(self, value):
+    def exit_time(self, value: str) -> None:
         """
         Only set once.
         """
@@ -161,16 +161,15 @@ def exit_time(self, value):
         literal_time = rdflib.Literal(str_value, datatype=NS_XSD.dateTime)
         self.graph.add((self.bnode_process, NS_UCO_OBSERVABLE.exitTime, literal_time))
         self._exit_time = value
-        return self._exit_time
 
     @property
-    def node(self):
+    def node(self) -> rdflib.URIRef:
         """
         Read-only property.
         """
         return self._node
 
-def build_process_object(graph, ns_base, gnu_time_log, mtime=None, prefix_slug=None):
+def build_process_object(graph, ns_base, gnu_time_log, mtime=None, prefix_slug=None) -> ProcessUCOObject:
     """
     This function builds a Process UCO Object from a file that contains the output of GNU Time's --verbose flag.
 
@@ -204,7 +203,7 @@ def build_process_object(graph, ns_base, gnu_time_log, mtime=None, prefix_slug=N
 argument_parser.add_argument("gnu_time_log", help="A file recording the output of the process wrapper GNU time, with the --verbose flag (recorded with the --output flag).  Used to retrieve exit status, conclusion time (if --done-log not provided), and run length.")
 argument_parser.add_argument("out_graph", help="A self-contained RDF graph file, in the format either requested by --output-format or guessed based on extension.")
 
-def main():
+def main() -> None:
     args = argument_parser.parse_args()
     logging.basicConfig(level=logging.DEBUG if args.debug else logging.INFO)
 
@@ -221,9 +220,9 @@ def main():
     process_object = build_process_object(graph, NS_BASE, args.gnu_time_log, mtime_str)
 
     #_logger.debug("args.output_format = %r." % args.output_format)
-    output_format = args.output_format or case_utils.guess_format(args.out_graph)
+    output_format = args.output_format or rdflib.util.guess_format(args.out_graph)
 
-    graph.serialize(destination=args.out_graph, format=output_format)
+    graph.serialize(destination=args.out_graph)
 
 if __name__ == "__main__":
     main()

tests/Makefile

@@ -35,6 +35,7 @@ all: \
   check-from_pip \
   check-gtime_log \
   check-gtime_and_done_log \
+  check-mypy \
   download
 
 .venv.done.log: \
@@ -122,7 +123,8 @@ check: \
   check-gtime_log \
   check-gtime_and_done_log \
   check-from_pip \
-  check-as_import
+  check-as_import \
+  check-mypy
 
 check-as_import: \
   all-as_import
@@ -148,6 +150,16 @@ check-gtime_and_done_log: \
 	  --directory gtime_and_done_log \
 	  check
 
+check-mypy: \
+  .venv.done.log
+	source venv/bin/activate \
+	  && mypy \
+	    $(top_srcdir)/case_gnu_time \
+	    as_import \
+	    from_pip \
+	    gtime_and_done_log \
+	    gtime_log
+
 clean:
 	@$(MAKE) \
 	  --directory gtime_log \

tests/as_import/test_as_import.py

@@ -22,18 +22,18 @@
 
 srcdir = os.path.dirname(__file__)
 
-def _parse_graph(filename):
+def _parse_graph(filename) -> rdflib.Graph:
     graph_filename = os.path.join(srcdir, filename)
     graph = rdflib.Graph()
     graph.parse(graph_filename)
     case_utils.ontology.load_subclass_hierarchy(graph)
     return graph
 
-def _test_as_import_load(graph_filename):
+def _test_as_import_load(graph_filename) -> None:
     graph = _parse_graph(graph_filename)
     assert len(graph) > 0
 
-def _test_as_import_query(graph_filename):
+def _test_as_import_query(graph_filename) -> None:
     graph = _parse_graph(graph_filename)
 
     nsdict = {k:v for (k,v) in graph.namespace_manager.namespaces()}
@@ -66,19 +66,19 @@ def _test_as_import_query(graph_filename):
         iris.add(n_process_object.toPython())
     assert len(iris) == 1
 
-def test_as_import_load_json():
+def test_as_import_load_json() -> None:
     _test_as_import_load("process.json")
 
-def test_as_import_load_turtle():
+def test_as_import_load_turtle() -> None:
     _test_as_import_load("process.ttl")
 
-def test_as_import_query_json():
+def test_as_import_query_json() -> None:
     _test_as_import_query("process.json")
 
-def test_as_import_query_turtle():
+def test_as_import_query_turtle() -> None:
     _test_as_import_query("process.ttl")
 
-def test_as_import_validation():
+def test_as_import_validation() -> None:
     graph = _parse_graph("validation.ttl")
     result = None
     for triple in graph.triples((None, rdflib.SH.conforms, None)):

tests/from_pip/test_from_pip.py

@@ -17,13 +17,13 @@
 
 srcdir = os.path.dirname(__file__)
 
-def _parse_graph(filename):
+def _parse_graph(filename) -> rdflib.Graph:
     graph_filename = os.path.join(srcdir, filename)
     graph = rdflib.Graph()
     graph.parse(graph_filename)
     return graph
 
-def test_from_pip_validation():
+def test_from_pip_validation() -> None:
     graph = _parse_graph("validation.ttl")
     result = None
     for triple in graph.triples((None, rdflib.SH.conforms, None)):

tests/gtime_and_done_log/test_gtime_and_done_log.py

@@ -17,13 +17,13 @@
 
 srcdir = os.path.dirname(__file__)
 
-def _parse_graph(filename):
+def _parse_graph(filename) -> rdflib.Graph:
     graph_filename = os.path.join(srcdir, filename)
     graph = rdflib.Graph()
     graph.parse(graph_filename)
     return graph
 
-def test_gtime_and_done_log_validation():
+def test_gtime_and_done_log_validation() -> None:
     graph = _parse_graph("validation.ttl")
     result = None
     for triple in graph.triples((None, rdflib.SH.conforms, None)):

tests/gtime_log/test_gtime_log.py

@@ -17,13 +17,13 @@
 
 srcdir = os.path.dirname(__file__)
 
-def _parse_graph(filename):
+def _parse_graph(filename) -> rdflib.Graph:
     graph_filename = os.path.join(srcdir, filename)
     graph = rdflib.Graph()
     graph.parse(graph_filename)
     return graph
 
-def test_gtime_log_validation():
+def test_gtime_log_validation() -> None:
     graph = _parse_graph("validation.ttl")
     result = None
     for triple in graph.triples((None, rdflib.SH.conforms, None)):

tests/requirements.txt

@@ -1,2 +1,3 @@
 case_utils
+mypy
 python-dateutil