Quick fixes (#232)

.pre-commit-config.yaml

@@ -59,7 +59,7 @@ repos:
       - id: tox-ini-fmt
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.10
+    rev: v0.5.5
     hooks:
       - id: ruff
         args:

.vscode/settings.json

@@ -21,5 +21,9 @@
   "python.testing.unittestEnabled": false,
   "triggerTaskOnSave.tasks": {
     "pydoclint": ["*.py"]
+  },
+  "sonarlint.connectedMode.project": {
+    "connectionId": "ansible",
+    "projectKey": "ansible_ansible-dev-environment"
   }
 }

src/ansible_dev_environment/collection.py

@@ -108,6 +108,7 @@ def parse_collection_request(  # noqa: PLR0915
         output.debug(msg)
         collection.path = path
         msg = f"Setting collection path: {collection.path}"
+        output.debug(msg)
         collection.opt_deps = string.split("[")[1].split("]")[0]
         msg = f"Setting optional dependencies: {collection.opt_deps}"
         output.debug(msg)

src/ansible_dev_environment/output.py

@@ -11,14 +11,13 @@
 from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING
 
 
 if TYPE_CHECKING:
     from .utils import TermFeatures
 
 
-T = TypeVar("T", bound="Level")
 GOLDEN_RATIO = 1.61803398875
 
 
@@ -109,7 +108,7 @@ def log_level(self: Level) -> int:
         return mapping[self]
 
     @classmethod
-    def _longest_name(cls: type[T]) -> int:
+    def _longest_name(cls) -> int:
         """Return the longest exit message prefix.
 
         Returns:
@@ -118,7 +117,7 @@ def _longest_name(cls: type[T]) -> int:
         return max(len(member.value) for member in cls)
 
     @classmethod
-    def longest_formatted(cls: type[T]) -> int:
+    def longest_formatted(cls) -> int:
         """Return the longest exit message prefix.
 
         Returns:
@@ -213,7 +212,7 @@ def to_lines(
 class Output:
     """Output functionality."""
 
-    def __init__(  # noqa: PLR0913
+    def __init__(
         self: Output,
         log_file: str,
         log_level: str,

src/ansible_dev_environment/subcommands/installer.py

@@ -29,7 +29,13 @@
 
 
 class Installer:
-    """The installer class."""
+    """The installer class.
+
+    Attributes:
+        RE_GALAXY_INSTALLED: The regular expression to match galaxy installed collections
+    """
+
+    RE_GALAXY_INSTALLED = re.compile(r"(\w+\.\w+):.*installed")
 
     def __init__(self: Installer, config: Config, output: Output) -> None:
         """Initialize the installer.
@@ -180,7 +186,7 @@ def _install_galaxy_collections(
             err = f"Failed to install collection: {exc}\n{exc.stderr}"
             self._output.critical(err)
             return
-        installed = re.findall(r"(\w+\.\w+):.*installed", proc.stdout)
+        installed = self.RE_GALAXY_INSTALLED.findall(proc.stdout)
         msg = f"Installed collections include: {oxford_join(installed)}"
         self._output.note(msg)
 
@@ -231,7 +237,7 @@ def _install_galaxy_requirements(self: Installer) -> None:
             err = f"Failed to install collections: {exc} {exc.stderr}"
             self._output.critical(err)
 
-        installed = re.findall(r"(\w+\.\w+):.*installed", proc.stdout)
+        installed = self.RE_GALAXY_INSTALLED.findall(proc.stdout)
         if not self._config.args.cpi:
             msg = f"Installed collections include: {oxford_join(installed)}"
         else:
@@ -472,7 +478,7 @@ def _install_local_collection(
                 collection.cache_dir / "MANIFEST.json",
             )
 
-        installed = re.findall(r"(\w+\.\w+):.*installed", proc.stdout)
+        installed = self.RE_GALAXY_INSTALLED.findall(proc.stdout)
         msg = f"Installed collections include: {oxford_join(installed)}"
         self._output.note(msg)
 

src/ansible_dev_environment/subcommands/treemaker.py

@@ -15,6 +15,8 @@
 ScalarVal = bool | str | float | int | None
 JSONVal = ScalarVal | list["JSONVal"] | dict[str, "JSONVal"]
 
+NOT_A_DICT = "Tree dict is not a dict."
+
 
 class TreeMaker:
     """Generate a dependency tree."""
@@ -99,14 +101,12 @@ def run(self: TreeMaker) -> None:  # noqa: C901, PLR0912, PLR0915
         else:
             pruned_tree_dict: JSONVal = {}
             if not isinstance(pruned_tree_dict, dict):
-                msg = "Tree dict is not a dict."
-                raise TypeError(msg)
+                raise TypeError(NOT_A_DICT)
             for collection_name in list(tree_dict.keys()):
                 found = False
                 for value in tree_dict.values():
                     if not isinstance(value, dict):
-                        msg = "Tree dict is not a dict."
-                        raise TypeError(msg)
+                        raise TypeError(NOT_A_DICT)
                     if collection_name in value:
                         found = True
                 if not found:
@@ -141,12 +141,10 @@ def add_python_reqs(
         TypeError: If the tree dict is not a dict.
     """
     if not isinstance(tree_dict, dict):
-        msg = "Tree dict is not a dict."
-        raise TypeError(msg)
+        raise TypeError(NOT_A_DICT)
     collection = tree_dict[collection_name]
     if not isinstance(collection, dict):
-        msg = "Tree dict is not a dict."
-        raise TypeError(msg)
+        raise TypeError(NOT_A_DICT)
     collection["python requirements"] = []
 
     for dep in sorted(python_deps):

src/ansible_dev_environment/tree.py

@@ -107,7 +107,7 @@ def is_scalar(obj: JSONVal) -> bool:
         """
         return isinstance(obj, str | int | float | bool) or obj is None
 
-    def _print_tree(  # noqa: C901, PLR0913, PLR0912
+    def _print_tree(  # noqa: C901, PLR0912
         self: Tree,
         obj: JSONVal,
         is_last: bool,  # noqa: FBT001

src/ansible_dev_environment/utils.py

@@ -136,21 +136,21 @@ def subprocess_run(  # noqa: PLR0913
     output.debug(cmd)
     log_level = logging.ERROR - (verbose * 10)
     if log_level == logging.DEBUG:
-        return subprocess_tee.run(
+        return subprocess_tee.run(  # noqa: S604
             command,
             check=True,
             cwd=cwd,
             env=env,
-            shell=True,  # noqa: S604
+            shell=True,
             text=True,
         )
     with Spinner(message=msg, term_features=output.term_features):
-        return subprocess.run(
+        return subprocess.run(  # noqa: S602
             command,
             check=True,
             cwd=cwd,
             env=env,
-            shell=True,  # noqa: S602
+            shell=True,
             capture_output=True,
             text=True,
         )
@@ -420,7 +420,7 @@ def __init__(
             term_features: Terminal features
             delay: The delay between characters
         """
-        self.spinner = itertools.cycle(("|", "/", "-", "\\", "|", "/", "-"))
+        self._spinner = itertools.cycle(("|", "/", "-", "\\", "|", "/", "-"))
         self.delay = delay
         self.busy = False
         self.spinner_visible = False
@@ -435,9 +435,9 @@ def write_next(self: Spinner) -> None:
         with self._screen_lock:
             if not self.spinner_visible:
                 if self._term_features.color:
-                    char = f"{Ansi.GREY}{next(self.spinner)}{Ansi.RESET}"
+                    char = f"{Ansi.GREY}{next(self._spinner)}{Ansi.RESET}"
                 else:
-                    char = next(self.spinner)
+                    char = next(self._spinner)
                 sys.stdout.write(char)
                 self.spinner_visible = True
                 sys.stdout.flush()