Add more type checking to Ramble

Author: linsword13

lib/ramble/ramble/analysis/backwards.py

@@ -9,6 +9,7 @@
 """Define the backwards-reading analysis strategy"""
 
 import os
+from typing import Any, Dict, FrozenSet, Tuple
 
 import ramble.success_criteria
 import ramble.util.lock as lk
@@ -121,9 +122,9 @@ def __call__(self, workspace):
 
         exp_lock = app.experiment_lock
 
-        fom_values = {}
-        context_metadata = {}
-        null_key = (_NULL_CONTEXT, _NULL_CONTEXT, frozenset())
+        fom_values: Dict[Tuple[str, str, FrozenSet[Any]], Dict[str, Any]] = {}
+        context_metadata: Dict[Tuple[str, str, FrozenSet[Any]], Dict[str, Any]] = {}
+        null_key: Tuple[str, str, FrozenSet[Any]] = (_NULL_CONTEXT, _NULL_CONTEXT, frozenset())
         context_metadata[null_key] = {
             "name": _NULL_CONTEXT,
             "def_name": _NULL_CONTEXT,

lib/ramble/ramble/analysis/forward.py

@@ -10,6 +10,7 @@
 
 import os
 import string
+from typing import Any, Dict, FrozenSet, Tuple
 
 import ramble.success_criteria
 import ramble.util.lock as lk
@@ -61,9 +62,9 @@ def format_context(context_match, context_format):
 
         exp_lock = app.experiment_lock
 
-        fom_values = {}
-        context_metadata = {}
-        null_key = (_NULL_CONTEXT, _NULL_CONTEXT, frozenset())
+        fom_values: Dict[Tuple[str, str, FrozenSet[Any]], Dict[str, Any]] = {}
+        context_metadata: Dict[Tuple[str, str, FrozenSet[Any]], Dict[str, Any]] = {}
+        null_key: Tuple[str, str, FrozenSet[Any]] = (_NULL_CONTEXT, _NULL_CONTEXT, frozenset())
         context_metadata[null_key] = {
             "name": _NULL_CONTEXT,
             "def_name": _NULL_CONTEXT,
@@ -75,7 +76,7 @@ def format_context(context_match, context_format):
             for file, file_conf in files.items():
 
                 # Start with no active contexts in a file.
-                active_contexts = {}
+                active_contexts: Dict[str, Any] = {}
                 logger.debug(f"Reading log file: {file}")
 
                 if not os.path.exists(file):

lib/ramble/ramble/cmd/__init__.py

@@ -9,6 +9,7 @@
 
 import os
 import re
+from typing import List, Optional
 
 from llnl.util.lang import attr_setdefault
 
@@ -50,7 +51,7 @@ def require_cmd_name(cname):
 
 
 #: global, cached list of all commands -- access through all_commands()
-_all_commands = None
+_all_commands: Optional[List[str]] = None
 
 
 def all_commands():

lib/ramble/ramble/cmd/common/arguments.py

@@ -13,7 +13,17 @@
 
 from ramble.util.logger import logger
 
-from spack.util.pattern import Args
+
+class Args:
+    """Class to hold positional flags and keyword arguments for parser.add_argument."""
+
+    flags: tuple
+    kwargs: dict
+
+    def __init__(self, *flags, **kwargs):
+        self.flags = tuple(flags)
+        self.kwargs = kwargs
+
 
 __all__ = [
     "add_common_arguments",

lib/ramble/ramble/cmd/common/info.py

@@ -9,6 +9,7 @@
 import enum
 import fnmatch
 import textwrap
+from collections.abc import Iterable
 
 from llnl.util.tty.colify import colified
 
@@ -376,7 +377,7 @@ def print_single_attribute(obj, attr, verbose=False, pattern="*", format=support
         # Otherwise, we print the attribute's value directly.
         if isinstance(internal_attr, dict):
             to_print = list(internal_attr.keys())
-        elif hasattr(internal_attr, "default_variants"):
+        elif internal_attr is not None and hasattr(internal_attr, "default_variants"):
             to_print = []
             for variant in internal_attr.default_variants.values():
                 to_print.append(variant)
@@ -387,7 +388,7 @@ def print_single_attribute(obj, attr, verbose=False, pattern="*", format=support
                 to_print.append(variant)
             for variant in internal_attr.version_variants.values():
                 to_print.append(variant)
-        elif hasattr(internal_attr, "family_type"):
+        elif internal_attr is not None and hasattr(internal_attr, "family_type"):
             to_print = [f"{internal_attr.family_type}={family}" for family in internal_attr]
         else:
             to_print = internal_attr
@@ -396,9 +397,7 @@ def print_single_attribute(obj, attr, verbose=False, pattern="*", format=support
         #     if it's a list of dicts, convert the keys like above and print
         #     otherwise filter it and print using the format specification
         # Otherwise, print it as a raw string.
-        if isinstance(to_print, (list, set, tuple)) or (
-            hasattr(to_print, "__iter__") and not isinstance(to_print, str)
-        ):
+        if isinstance(to_print, Iterable) and not isinstance(to_print, str):
             to_print = list(to_print)
             if (
                 internal_attr
@@ -415,9 +414,10 @@ def print_single_attribute(obj, attr, verbose=False, pattern="*", format=support
         if isinstance(internal_attr, dict):
             _print_verbose_dict_attr(internal_attr, pattern=pattern, indentation=indentation)
         elif (
-            isinstance(internal_attr, (list, set, tuple))
-            or (hasattr(internal_attr, "__iter__") and not isinstance(internal_attr, str))
-        ) and not hasattr(internal_attr, "as_str"):
+            isinstance(internal_attr, Iterable)
+            and not isinstance(internal_attr, str)
+            and not hasattr(internal_attr, "as_str")
+        ):
             internal_list = list(internal_attr)
             # If it's a list of dicts, print each
             if internal_list and isinstance(internal_list[0], dict):
@@ -440,7 +440,7 @@ def print_single_attribute(obj, attr, verbose=False, pattern="*", format=support
                         color.cprint(f"{colified(to_print, tty=True, indent=4)}")
                     color.cprint("")
         else:
-            if hasattr(internal_attr, "as_str"):
+            if internal_attr is not None and hasattr(internal_attr, "as_str"):
                 color.cprint(internal_attr.as_str(verbose=True))
             else:
                 color.cprint(f"{indentation}{internal_attr}\n")

lib/ramble/ramble/cmd/config.py

@@ -26,6 +26,8 @@
 section = "config"
 level = "long"
 
+_add_parser = None
+
 
 def setup_parser(subparser):
     scopes_metavar = ramble.config.scopes_metavar
@@ -94,7 +96,8 @@ def setup_parser(subparser):
     )
 
     # Make the add parser available later
-    setup_parser.add_parser = add_parser
+    global _add_parser
+    _add_parser = add_parser
 
     update = sp.add_parser("update", help="update configuration files to the latest format")
     ramble.cmd.common.arguments.add_common_arguments(update, ["yes_to_all"])
@@ -207,7 +210,8 @@ def config_add(args):
     This is a stateful operation that edits the config files."""
     if not (args.file or args.path):
         logger.error("No changes requested. Specify a file or value.")
-        setup_parser.add_parser.print_help()
+        if _add_parser:
+            _add_parser.print_help()
         exit(1)
 
     scope, _ = _get_scope_and_section(args)

lib/ramble/ramble/cmd/filter_groups.py

@@ -7,6 +7,7 @@
 # except according to those terms.
 
 import copy
+from typing import Any, Dict, List
 
 from llnl.util.tty.colify import colify
 
@@ -203,7 +204,7 @@ def print_filter_groups(resolved_scope_name=None, original_scope_name=None, verb
                 lines.extend(f"        - {ew}" for ew in definition["exclude_where"])
             color.cprint("\n".join(lines))
     else:
-        scope_groups = {}
+        scope_groups: Dict[str, List[str]] = {}
         for item in groups_to_print:
             scope = item["scope"]
             name = item["name"]
@@ -212,7 +213,7 @@ def print_filter_groups(resolved_scope_name=None, original_scope_name=None, verb
             scope_groups[scope].append(name)
 
         out_stream = logger.active_stream()
-        colify_opts = {"indent": 4, "padding": 2}
+        colify_opts: Dict[str, Any] = {"indent": 4, "padding": 2}
         if out_stream:
             colify_opts["output"] = out_stream
 

lib/ramble/ramble/cmd/license.py

@@ -42,7 +42,7 @@ def _object_file_regex_list(is_ramble_root=True):
 
 
 #: regular expressions for licensed files.
-licensed_files = [
+_raw_licensed_files = [
     # ramble scripts
     r"bin/ramble$",
     r"bin/ramble-python$",
@@ -66,6 +66,7 @@ def _object_file_regex_list(is_ramble_root=True):
     # examples
     r"examples/.*\.yaml$",
 ]
+licensed_files = [re.compile(regex) for regex in _raw_licensed_files]
 
 
 #: licensed files that can have LGPL language in them
@@ -327,8 +328,6 @@ def license(parser, args):
     if not git:
         logger.die("ramble license requires git in your environment")
 
-    licensed_files[:] = [re.compile(regex) for regex in licensed_files]
-
     commands = {
         "list-files": list_files,
         "verify": verify,

lib/ramble/ramble/cmd/python.py

@@ -81,8 +81,8 @@ def python(parser, args, unknown_args):
 
     # Run user choice of interpreter
     if args.python_interpreter == "ipython":
-        return ramble.cmd.python.ipython_interpreter(args)
-    return ramble.cmd.python.python_interpreter(args)
+        return ipython_interpreter(args)
+    return python_interpreter(args)
 
 
 def ipython_interpreter(args):

lib/ramble/ramble/cmd/style.py

@@ -89,7 +89,7 @@ def is_object(f):
 #
 # For each file, if the filename pattern matches, we'll add per-line
 # exemptions if any patterns in the sub-dict match.
-pattern_exemptions = {
+_raw_pattern_exemptions = {
     # exemptions applied only to application.py files.
     rf"application.py|{base_class_file}$": {
         # Allow 'from ramble.appkit import *' in applications,
@@ -144,7 +144,7 @@ def is_object(f):
     re.compile(file_pattern): {
         code: [re.compile(p) for p in patterns] for code, patterns in error_dict.items()
     }
-    for file_pattern, error_dict in pattern_exemptions.items()
+    for file_pattern, error_dict in _raw_pattern_exemptions.items()
 }
 
 # Tools run in the given order