Merge pull request #14 from sandialabs/8-support-down-to-python-3.8

Support down to Python 3.8

Author: jmgate

.gitignore

@@ -1 +1,5 @@
 .vscode
+.coverage
+coverage.json
+coverage.xml
+**/__pycache__

staged_script/staged_script.py

@@ -24,7 +24,7 @@
 from datetime import datetime, timedelta, timezone
 from pathlib import Path
 from subprocess import CompletedProcess
-from typing import Callable, NamedTuple
+from typing import Callable, Dict, List, NamedTuple, Optional, Set
 
 import __main__
 import rich.traceback
@@ -122,14 +122,14 @@ class StagedScript:
     Attributes:
         args (Namespace):  The parsed command line arguments for the
             script.
-        commands_executed (list[str]):  The commands that were executed
+        commands_executed (List[str]):  The commands that were executed
             in the shell.
         console (Console):  Used to print rich text to the console.
         current_stage (str):  The name of the stage being run.
         dry_run (bool):  If ``True``, don't actually run the command
             that would be executed in the shell; instead just print it
             out.
-        durations (list[StageDuration]):  A mapping from stage names to
+        durations (List[StageDuration]):  A mapping from stage names to
             how long it took for each to run.  This is implemented as a
             ``list`` of named tuples instead of as a ``dict`` to allow
             the flexibility for stages to be run multiple times.
@@ -145,12 +145,12 @@ class StagedScript:
         script_success (bool):  Subclass developers can toggle this
             attribute to indicate whether the script has succeeded.
         stage_start_time (datetime):  The time at which a stage began.
-        stages (set[str]):  The stages registered for an instantiation
+        stages (Set[str]):  The stages registered for an instantiation
             of a :class:`StagedScript` subclass, which are used to
             automatically populate pieces of the
             :class:`ArgumentParser`.  This may be a subset of all the
             stages defined in the subclass.
-        stages_to_run (set[str]):  Which stages to run, as specified by
+        stages_to_run (Set[str]):  Which stages to run, as specified by
             the user via the command line arguments.
         start_time (datetime):  The time at which this object was
             initialized.
@@ -176,9 +176,9 @@ class StagedScript:
 
     def __init__(
         self,
-        stages: set[str],
+        stages: Set[str],
         *,
-        console_force_terminal: bool | None = None,
+        console_force_terminal: Optional[bool] = None,
         console_log_path: bool = True,
         print_commands: bool = True,
     ):
@@ -207,20 +207,20 @@ def __init__(
         for stage in stages:
             self._validate_stage_name(stage)
         self.args = Namespace()
-        self.commands_executed: list[str] = []
+        self.commands_executed: List[str] = []
         self.console = Console(
             force_terminal=console_force_terminal, log_path=console_log_path
         )
         self.current_stage = "CURRENT STAGE NOT SET"
         self.dry_run = False
-        self.durations: list[StageDuration] = []
+        self.durations: List[StageDuration] = []
         self.print_commands = print_commands
         self.script_name = Path(__main__.__file__).name
         self.script_stem = Path(__main__.__file__).stem
         self.script_success = True
         self.stage_start_time = datetime.now(tz=timezone.utc)
         self.stages = stages
-        self.stages_to_run: set[str] = set()
+        self.stages_to_run: Set[str] = set()
         self.start_time = datetime.now(tz=timezone.utc)
 
     @staticmethod
@@ -364,7 +364,7 @@ def parser(self) -> ArgumentParser:
                 setattr(self, f"{stage}_retry_timeout_arg", retry_timeout)
         return ap
 
-    def parse_args(self, argv: list[str]) -> None:
+    def parse_args(self, argv: List[str]) -> None:
         """
         Parse the command line arguments.
 
@@ -376,7 +376,7 @@ def parse_args(self, argv: list[str]) -> None:
 
         .. code-block:: python
 
-            def parse_args(self, argv: list[str]) -> None:
+            def parse_args(self, argv: List[str]) -> None:
                 super().parse_args(argv)
                 # Parse additional arguments and store as attributes.
                 self.foo = self.args.foo
@@ -912,7 +912,7 @@ def print_heading(self, message: str, *, color: str = "cyan") -> None:
         self.console.log(Panel(f"[bold]{message}", style=color))
 
     def print_script_execution_summary(
-        self, extra_sections: dict[str, str] | None = None
+        self, extra_sections: Optional[Dict[str, str]] = None
     ) -> None:
         """
         Print a summary of everything that was done by the script.
@@ -934,11 +934,11 @@ def print_script_execution_summary(
 
             def print_script_execution_summary(
                 self,
-                extra_sections: dict[str, str] | None = None
+                extra_sections: Optional[Dict[str, str]] = None
             ) -> None:
                 extras = {"Additional section": "With some details."}
                 if extra_sections is not None:
-                    extras |= extra_sections
+                    extras.update(extra_sections)
                 super().print_script_execution_summary(
                     extra_sections=extras
                 )
@@ -955,7 +955,7 @@ def print_script_execution_summary(
             ),
         }
         if extra_sections is not None:
-            sections |= extra_sections
+            sections.update(extra_sections)
         items = [""]
         for section, details in sections.items():
             items.extend([f"➤ {section}:", Padding(details, (1, 0, 1, 4))])
@@ -969,7 +969,7 @@ def run(
         command: str,
         *,
         pretty_print: bool = False,
-        print_command: bool | None = None,
+        print_command: Optional[bool] = None,
         **kwargs,
     ) -> CompletedProcess:
         """
@@ -1028,7 +1028,7 @@ def _get_timing_report(self) -> Table:
         return table
 
     @staticmethod
-    def _current_arg_is_long_flag(args: list[str]) -> bool:
+    def _current_arg_is_long_flag(args: List[str]) -> bool:
         """
         Determine if the first argument in the list is a long flag.
 
@@ -1041,7 +1041,7 @@ def _current_arg_is_long_flag(args: list[str]) -> bool:
         return len(args) > 0 and args[0].startswith("--")
 
     @staticmethod
-    def _next_arg_is_flag(args: list[str]) -> bool:
+    def _next_arg_is_flag(args: List[str]) -> bool:
         """
         Determine if the second argument in the list is a flag.
 

test/test_staged_script.py

@@ -9,6 +9,7 @@
 import shlex
 from datetime import datetime, timedelta, timezone
 from subprocess import CompletedProcess
+from typing import Dict, Optional
 from unittest.mock import MagicMock, patch
 
 import pytest
@@ -239,7 +240,7 @@ def test_run_override_print_commands(
 )
 def test_print_script_execution_summary(
     mock_get_pretty_command_line_invocation: MagicMock,
-    extras: dict[str, str] | None,
+    extras: Optional[Dict[str, str]],
     script_success: bool,  # noqa: FBT001
     script: StagedScript,
     capsys: pytest.CaptureFixture,

test/test_staged_script_advanced_subclass.py

@@ -11,6 +11,7 @@
 import pytest
 from rich.console import Console
 from tenacity import RetryCallState, Retrying, TryAgain
+from typing import Set
 
 from staged_script import StagedScript
 
@@ -103,7 +104,7 @@ def ensure_phase_comes_next(
 @pytest.mark.parametrize("custom_pre_stage", [True, False])
 @pytest.mark.parametrize("stages_to_run", [{"test"}, set()])
 def test_stage(  # noqa: PLR0913
-    stages_to_run: set[str],
+    stages_to_run: Set[str],
     custom_pre_stage: bool,  # noqa: FBT001
     custom_begin_stage: bool,  # noqa: FBT001
     custom_skip_stage: bool,  # noqa: FBT001

test/test_staged_script_basic_subclass.py

@@ -6,6 +6,8 @@
 
 # SPDX-License-Identifier: BSD-3-Clause
 
+from typing import Set
+
 import pytest
 from rich.console import Console
 
@@ -49,7 +51,7 @@ def script() -> MyBasicScript:
 
 @pytest.mark.parametrize("stages_to_run", [{"good"}, set()])
 def test_good_stage(
-    stages_to_run: set[str],
+    stages_to_run: Set[str],
     script: MyBasicScript,
     capsys: pytest.CaptureFixture,
 ) -> None: