Reorganize internal functions in preparaton for sphinx plugin dev

Author: amykyta3

peakrdl-cli/src/peakrdl/config/loader.py

@@ -1,4 +1,4 @@
-from typing import Optional, List, Any, Dict
+from typing import Optional, Any, Dict
 import os
 import sys
 
@@ -79,18 +79,11 @@ def _discover_cfg_file() -> Optional[str]:
     }
 })
 
-def load_cfg(argv: List[str]) -> AppConfig:
-    # lazy-parse argv to see if user provided a config file explicitly
-    path = None
-    argv_iter = iter(argv)
-    for arg in argv_iter:
-        if arg == "--peakrdl-cfg":
-            try:
-                path = next(argv_iter)
-            except StopIteration:
-                print("error: argument --peakrdl-cfg: expected FILE", file=sys.stderr)
-                sys.exit(1)
-            break
+def load_cfg(path: Optional[str]) -> AppConfig:
+    """
+    Careful! This is a secret API!
+    sphinx-peakrdl calls this.
+    """
 
     if path is None:
         # No config file path was provided from the command-line
@@ -102,17 +95,16 @@ def load_cfg(argv: List[str]) -> AppConfig:
         raw_data = {}
         path = ""
     else:
+        # Found file. Parse it
         if not os.path.isfile(path):
-            print(f"error: invalid config file path: {path}", file=sys.stderr)
-            sys.exit(1)
+            raise ValueError(f"error: invalid config file path: {path}")
 
         with open(path, 'r', encoding='utf-8') as f:
             s = f.read()
         try:
             raw_data = tomllib.loads(s)
         except tomllib.TOMLDecodeError as e:
-            print(f"{path}: error: {str(e)}", file=sys.stderr)
-            sys.exit(1)
+            raise ValueError(f"{path}: error: {str(e)}") from e
 
     # Do a first-pass extraction to fetch additional entries to be added to PYTHONPATH
     try:

peakrdl-cli/src/peakrdl/main.py

@@ -104,12 +104,32 @@ def repl(m: Match) -> str:
     return [pattern.sub(repl, arg) for arg in argv]
 
 
+def get_peakrdl_cfg_arg(argv: List[str]) -> Optional[str]:
+    # lazy-parse argv to see if user provided a config file explicitly
+    path = None
+    argv_iter = iter(argv)
+    for arg in argv_iter:
+        if arg == "--peakrdl-cfg":
+            try:
+                path = next(argv_iter)
+            except StopIteration:
+                print("error: argument --peakrdl-cfg: expected FILE", file=sys.stderr)
+                sys.exit(1)
+            break
+    return path
+
+
 def main() -> None:
     # manually expand any -f argfiles first
     argv = expand_file_args(sys.argv[1:])
     argv = expand_arg_vars(argv)
 
-    cfg = load_cfg(argv)
+    peakrdl_cfg_path = get_peakrdl_cfg_arg(argv)
+    try:
+        cfg = load_cfg(peakrdl_cfg_path)
+    except ValueError as e:
+        print(e.args[0], file=sys.stderr)
+        sys.exit(1)
 
     # Collect all importers and initialize them with the config
     importers = get_importer_plugins(cfg)

peakrdl-cli/src/peakrdl/process_input.py

@@ -6,7 +6,7 @@
 
 if TYPE_CHECKING:
     import argparse
-    from systemrdl import RDLCompiler, AddrmapNode
+    from systemrdl import RDLCompiler
     from .importer import Importer
 
 
@@ -99,57 +99,63 @@ def parse_defines(rdlc: 'RDLCompiler', define_options: List[str]) -> Dict[str, s
 
 def process_input(rdlc: 'RDLCompiler', importers: 'Sequence[Importer]', input_files: List[str], options: 'argparse.Namespace') -> None:
     defines = parse_defines(rdlc, options.defines)
-
     for file in input_files:
-        if not os.path.exists(file):
-            rdlc.msg.fatal(f"Input file does not exist: {file}")
-
-        ext = os.path.splitext(file)[1].strip(".")
-        if ext == "rdl":
-            # Is SystemRDL file
-            rdlc.compile_file(
-                file,
-                incl_search_paths=options.incdirs,
-                defines=defines,
-            )
-        else:
-            # Is foreign input file.
-
-            # Search which importer to use by extension first
-            importer_candidates: List["Importer"] = []
-            for imp in importers:
-                if ext in imp.file_extensions:
-                    importer_candidates.append(imp)
-
-            # Do 2nd pass if needed
-            if len(importer_candidates) == 1:
-                importer = importer_candidates[0]
-            elif len(importer_candidates) > 1:
-                # ambiguous which importer to use
-                # Do 2nd pass compatibility check
-                for importer_candidate in importer_candidates:
-                    if importer_candidate.is_compatible(file):
-                        importer = importer_candidate
-                        break
-                else:
-                    importer = None
+        load_file(rdlc, importers, file, defines, options.incdirs, options)
+
+
+def load_file(
+        rdlc: 'RDLCompiler',
+        importers: 'Sequence[Importer]',
+        path: str,
+        defines: Dict[str, str],
+        incdirs: List[str],
+        options: 'argparse.Namespace'
+    ) -> None:
+    """
+    Careful! This is a secret API!
+    sphinx-peakrdl calls this.
+    """
+
+    if not os.path.exists(path):
+        rdlc.msg.fatal(f"Input file does not exist: {path}")
+
+    ext = os.path.splitext(path)[1].strip(".")
+    if ext == "rdl":
+        # Is SystemRDL file
+        rdlc.compile_file(
+            path,
+            incl_search_paths=incdirs,
+            defines=defines,
+        )
+    else:
+        # Is foreign input file.
+
+        # Search which importer to use by extension first
+        importer_candidates: List["Importer"] = []
+        for imp in importers:
+            if ext in imp.file_extensions:
+                importer_candidates.append(imp)
+
+        # Do 2nd pass if needed
+        if len(importer_candidates) == 1:
+            importer = importer_candidates[0]
+        elif len(importer_candidates) > 1:
+            # ambiguous which importer to use
+            # Do 2nd pass compatibility check
+            for importer_candidate in importer_candidates:
+                if importer_candidate.is_compatible(path):
+                    importer = importer_candidate
+                    break
             else:
                 importer = None
+        else:
+            importer = None
 
-            if not importer:
-                rdlc.msg.fatal(
-                    "Unknown file type. Could not find any importers capable of reading this file.",
-                    FileSourceRef(file)
-                )
-                raise ValueError
-
-            importer.do_import(rdlc, options, file)
-
+        if not importer:
+            rdlc.msg.fatal(
+                "Unknown file type. Could not find any importers capable of reading this file.",
+                FileSourceRef(path)
+            )
+            raise ValueError
 
-def elaborate(rdlc: 'RDLCompiler', parameters: Dict[str, Any], options: 'argparse.Namespace') -> 'AddrmapNode':
-    root = rdlc.elaborate(
-        top_def_name=options.top_def_name,
-        inst_name=options.inst_name,
-        parameters=parameters
-    )
-    return root.top
+        importer.do_import(rdlc, options, path)

peakrdl-cli/src/peakrdl/subcommand.py

@@ -148,10 +148,14 @@ def main(self, importers: 'List[ImporterPlugin]', options: 'argparse.Namespace')
 
         process_input.process_input(rdlc, importers, options.input_files, options)
 
-        top = process_input.elaborate(rdlc, parameters, options)
+        root = rdlc.elaborate(
+            top_def_name=options.top_def_name,
+            inst_name=options.inst_name,
+            parameters=parameters
+        )
 
         # Run exporter
-        self.do_export(top, options)
+        self.do_export(root.top, options)
 
 
     def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> None:

test/pylint.rc

@@ -75,9 +75,6 @@ confidence=
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
 disable=
-        # Disable for now during development
-        fixme,
-
         # User ignored limits
         too-many-lines,
         too-many-locals,
@@ -88,6 +85,7 @@ disable=
         too-many-statements,
         too-many-instance-attributes,
         too-many-function-args,
+        too-many-positional-arguments,
         line-too-long,
 
         # Noise / Don't care
@@ -98,10 +96,7 @@ disable=
         abstract-method,
         protected-access,
         duplicate-code,
-        cyclic-import,
-
-        # Can't do until py35 support is dropped
-        consider-using-f-string
+        cyclic-import
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option