Add type signatures to most of case_utils

Some further signature work will come to case_file.

References:
* [AC-211] Add static type checking to CASE-Utilities-Python

Signed-off-by: Alex Nelson <[email protected]>

Author: ajnelson-nist

case_utils/__init__.py

@@ -13,13 +13,17 @@
 
 __version__ = "0.2.1"
 
+import typing
 import warnings
 
 import rdflib.util  # type: ignore
 
 from . import local_uuid
 
-def guess_format(fpath, fmap=None):
+def guess_format(
+  fpath : str,
+  fmap : typing.Optional[typing.Dict[str, str]] = None
+) -> typing.Optional[str]:
     warnings.warn("The functionality in case_utils.guess_format is now upstream.  Please revise your code to use rdflib.util.guess_format.  The function arguments remain the same.  case_utils.guess_format will be removed in case_utils 0.4.0.", DeprecationWarning)
 
     return rdflib.util.guess_format(fpath, fmap)

case_utils/case_file/__init__.py

@@ -20,6 +20,7 @@
 import datetime
 import hashlib
 import os
+import typing
 
 import rdflib  # type: ignore
 
@@ -234,7 +235,7 @@ def main() -> None:
     else:
         output_format = args.output_format
 
-    serialize_kwargs = {
+    serialize_kwargs : typing.Dict[str, typing.Any] = {
       "format": output_format
     }
     if output_format == "json-ld":

case_utils/case_sparql_construct/__init__.py

@@ -20,6 +20,7 @@
 import argparse
 import os
 import logging
+import typing
 
 import rdflib.plugins.sparql  # type: ignore
 
@@ -74,7 +75,7 @@ def main() -> None:
     else:
         output_format = args.output_format
 
-    serialize_kwargs = {
+    serialize_kwargs : typing.Dict[str, typing.Any] = {
       "format": output_format
     }
     if output_format == "json-ld":

case_utils/local_uuid.py

@@ -21,17 +21,17 @@
 import sys
 import uuid
 
-USE_DEMO_UUID = False
+USE_DEMO_UUID : bool = False
 
-DEMO_UUID_COUNTER = 0
+DEMO_UUID_COUNTER : int = 0
 
-def configure():
+def configure() -> None:
     global USE_DEMO_UUID
 
     if os.getenv("DEMO_UUID_REQUESTING_NONRANDOM") == "NONRANDOM_REQUESTED":
         USE_DEMO_UUID = True
 
-def demo_uuid():
+def demo_uuid() -> str:
     """
     This function generates a repeatable UUID, drawing on non-varying elements of the environment and process call for entropy.
 
@@ -52,16 +52,17 @@ def demo_uuid():
     parts.append(str(DEMO_UUID_COUNTER))
 
     # Component: Present working directory, replacing $HOME with '~'.
-    parts.append(os.getcwd().replace(os.getenv("HOME"), "~"))
+    env_HOME : str = os.getenv("HOME", "/nonexistent")
+    parts.append(os.getcwd().replace(env_HOME, "~"))
 
     # Component: Argument vector.
     parts.extend(sys.argv)
 
     return str(uuid.uuid5(uuid.NAMESPACE_URL, "/".join(parts)))
 
-def local_uuid():
+def local_uuid() -> str:
     """
-    Generate either a UUID4, or if requested via environment configuration, a non-random demo UUID.  Returns a string.
+    Generate either a UUID4, or if requested via environment configuration, a non-random demo UUID.
     """
     global USE_DEMO_UUID
     if USE_DEMO_UUID: