Enabled linting and fixed issues

Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>

Author: olehermanse

.github/workflows/black-format.yml .github/workflows/format.yml.github/workflows/black-format.yml renamed to .github/workflows/format.yml

@@ -1,4 +1,4 @@
-name: Automatically format with Black and submit PR
+name: Format
 permissions:
   contents: read
   pull-requests: write

.github/workflows/black-check.yml .github/workflows/lint.yml.github/workflows/black-check.yml renamed to .github/workflows/lint.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Check formatting with Black
+name: Lint
 on:
   push:
     branches: [main]
@@ -25,7 +25,16 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install black
+          python -m pip install uv
       - name: Check formatting with black
         run: |
-          black --check .
+          uv tool run black --check .
+      - name: Run flake8
+        run: |
+          uv tool run flake8 src/ --ignore=E203,W503,E722,E731 --max-complexity=100 --max-line-length=160
+      - name: Run pyflakes
+        run: |
+          uv tool run pyflakes src/
+      - name: Run pyright
+        run: |
+          uv tool run pyright src/

.github/workflows/pypi-publish.yml

@@ -1,3 +1,4 @@
+name: Publish
 # Taken from GH docs:
 on:
   release:

.github/workflows/tests.yml .github/workflows/test.yml.github/workflows/tests.yml renamed to .github/workflows/test.yml

@@ -1,6 +1,6 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-name: Tests
+name: Test
 on:
   push:
     branches: [main]

pyproject.toml

@@ -40,6 +40,11 @@ cfengine = "cfengine_cli.main:main"
 [tool.setuptools]
 license-files = [] # Workaround bug in setuptools https://github.com/astral-sh/uv/issues/9513
 
+[tool.pyright]
+include = ["src"]
+venvPath = "."
+venv = ".venv"
+
 [tool.setuptools_scm]
 
 [dependency-groups]

src/cfengine_cli/commands.py

@@ -89,5 +89,5 @@ def run() -> int:
     return 0
 
 
-def dev(subcommand) -> int:
-    return dispatch_dev_subcommand(subcommand)
+def dev(subcommand, args) -> int:
+    return dispatch_dev_subcommand(subcommand, args)

src/cfengine_cli/deptool.py

@@ -95,11 +95,15 @@ def __init__(
         log_info=True,
     ):
         """
-        Creates an instance of the class for a Git repository in a given path, cloning from GitHub if the path doesn't exist, then configures it and optionally checks out a requested ref (branch or tag). Arguments:
-        * `repo_path`: local filesystem path of the Git repository, or of the GitHub repository to clone
+        Creates an instance of the class for a Git repository in a given path,
+        cloning from GitHub if the path doesn't exist, then configures it and
+        optionally checks out a requested ref (branch or tag). Arguments:
+        * `repo_path`: local filesystem path of the Git repository, or of the
+                       GitHub repository to clone
         * `repo_owner`: name of owner of the GitHub repository to clone
         * `repo_name`: name of GitHub repository to clone
-        * `checkout_ref`: optional name of ref to checkout. If not provided, a ref from previous work might be left checked out.
+        * `checkout_ref`: optional name of ref to checkout. If not provided,
+                          a ref from previous work might be left checked out.
         """
         self.repo_path = repo_path
 
@@ -128,7 +132,9 @@ def __init__(
             self.checkout(checkout_ref)
 
     def run_command(self, *command, **kwargs):
-        """Runs a git command in the Git repository. Syntactically this function tries to be as close to `subprocess.run` as possible, just adding `"git"` with some extra parameters at the beginning."""
+        """Runs a git command in the Git repository. Syntactically this
+        function tries to be as close to `subprocess.run` as possible,
+        just adding `"git"` with some extra parameters at the beginning."""
         git_command = [
             "git",
             "-C",
@@ -286,11 +292,12 @@ def extract_version_from_filename(self, dep, filename):
             match = re.search("-([0-9a-z.]*).tar", filename)
             if not match:
                 match = re.search("_([0-9a-z_]*).tar", filename)
+            assert match is not None
             version = match.group(1)
         elif dep == "pthreads-w32":
-            version = re.search("w32-([0-9-]*)-rel", filename).group(1)
+            version = re.search("w32-([0-9-]*)-rel", filename).group(1)  # type: ignore
         else:
-            version = re.search(r"[-_]([0-9.]*)[\.-]", filename).group(1)
+            version = re.search(r"[-_]([0-9.]*)[\.-]", filename).group(1)  # type: ignore
         return version
 
     def get_current_version(self, dep):
@@ -325,7 +332,9 @@ def deps_versions(self, ref):
         return deps_versions
 
     def deps_dict(self, refs):
-        """Returns a 2D dictionary of dependencies and versions from all refs: `deps_dict[dep][ref] = version`, as well as a dictionary of widths of each column (ref)."""
+        """Returns a 2D dictionary of dependencies and versions from all refs:
+        `deps_dict[dep][ref] = version`, as well as a dictionary of widths of
+        each column (ref)."""
 
         deps_dict = {}
         ref_column_widths = {}
@@ -335,7 +344,7 @@ def deps_dict(self, refs):
             deps_versions = self.deps_versions(ref)
 
             for dep in deps_versions:
-                if not dep in deps_dict:
+                if dep not in deps_dict:
                     deps_dict[dep] = collections.defaultdict(lambda: "-")
                 deps_dict[dep][ref] = deps_versions[dep]
                 ref_column_widths[ref] = max(
@@ -345,7 +354,10 @@ def deps_dict(self, refs):
         return deps_dict, ref_column_widths
 
     def updated_deps_markdown_table(self, refs):
-        """Code from bot-tom's `depstable` that processes the README table directly, returning the updated README. The updated README will not contain dependencies that were not in the README beforehand, and will not automatically remove dependencies that no longer exist."""
+        """Code from bot-tom's `depstable` that processes the README table
+        directly, returning the updated README. The updated README will not
+        contain dependencies that were not in the README beforehand, and
+        will not automatically remove dependencies that no longer exist."""
         updated_hub_table_lines = []
         updated_agent_table_lines = []
 
@@ -356,6 +368,7 @@ def updated_deps_markdown_table(self, refs):
         readme_lines = readme_file.split("\n")
         has_notes = False  # flag to say that we're in a table that has "Notes" column
         in_hub = False  # flag that we're in Hub section
+        column_widths = None
         for i, line in enumerate(readme_lines):
             if " Hub " in line:
                 in_hub = True
@@ -395,6 +408,7 @@ def updated_deps_markdown_table(self, refs):
                     + " |"
                 )
             elif line.startswith("| :-"):
+                assert column_widths is not None
                 line = (
                     "| "
                     + (" | ".join((":" + "-" * (width - 1) for width in column_widths)))
@@ -423,6 +437,7 @@ def updated_deps_markdown_table(self, refs):
                         line,
                     )
                     deps_dict[dep] = collections.defaultdict(lambda: "-")
+                note = None
                 if has_notes:
                     note = re.search(r"\| ([^|]*) \|$", line)
                     if not note:
@@ -432,11 +447,13 @@ def updated_deps_markdown_table(self, refs):
                         note = note.group(1)
                 if in_hub:
                     dep = re.sub("-hub$", "", dep)
+                assert note is not None
                 row = (
                     ["[%s](%s)" % (dep_title, url)]
                     + [deps_dict[dep][ref] for ref in refs]
                     + ([note] if has_notes else [])
                 )
+                assert column_widths is not None
                 line = (
                     "| "
                     + (
@@ -562,7 +579,7 @@ def comparison_md_table(self, refs, skip_unchanged=False):
 
         deps_name_urllink_mapping = {
             d: (
-                "[" + HUMAN_NAME.get(d, d) + "](" + HOME_URL[d] + ")"
+                "[" + HUMAN_NAME.get(d, d) + "](" + HOME_URL[d] + ")"  # type: ignore
                 if d in HOME_URL
                 else HUMAN_NAME.get(d, d)
             )
@@ -728,6 +745,10 @@ def deptool(
     if cdx_sbom_path_template:
         dr.write_cdx_sboms(cdx_sbom_path_template, refs)
 
+    updated_readme = None
+    updated_agent_table = None
+    updated_hub_table = None
+
     if patch or not compare:
         updated_readme, updated_agent_table, updated_hub_table = (
             dr.updated_deps_markdown_table(refs)
@@ -738,8 +759,10 @@ def deptool(
         print(comparison_table)
     else:
         print("### Agent dependencies\n")
+        assert updated_agent_table is not None
         print(updated_agent_table)
         print("\n### Enterprise Hub dependencies\n")
+        assert updated_hub_table is not None
         print(updated_hub_table)
 
     if patch:

src/cfengine_cli/docs.py

@@ -45,6 +45,7 @@ def extract_inline_code(path, languages):
         flags = info_string[1:]
 
         if language in languages:
+            assert child.map is not None
             yield {
                 "language": language,
                 "flags": flags,
@@ -124,9 +125,7 @@ def fn_check_syntax(origin_path, snippet_path, language, first_line, _last_line)
                 with open(snippet_abs_path, "r") as f:
                     json.loads(f.read())
             except json.decoder.JSONDecodeError as e:
-                raise UserError(
-                    f"Unknown error when checking '{snippet_abs_path}': {str(e)}"
-                )
+                raise UserError(f"Error when checking '{snippet_abs_path}': {str(e)}")
             except Exception as e:
                 print(str(e))
                 raise UserError(f"Unknown error when checking '{snippet_abs_path}'")
@@ -215,7 +214,7 @@ def _markdown_code_checker(
                 cb["last_line"] += offset
 
             language = supported_languages[code_block["language"]]
-            snippet_path = f"{origin_path}.snippet-{i+1}.{language}"
+            snippet_path = f"{origin_path}.snippet-{i + 1}.{language}"
 
             if extract and "noextract" not in code_block["flags"]:
                 fn_extract(
@@ -227,13 +226,18 @@ def _markdown_code_checker(
                 )
 
             if syntax_check and "novalidate" not in code_block["flags"]:
-                fn_check_syntax(
-                    origin_path,
-                    snippet_path,
-                    language,
-                    code_block["first_line"],
-                    code_block["last_line"],
-                )
+                try:
+                    fn_check_syntax(
+                        origin_path,
+                        snippet_path,
+                        language,
+                        code_block["first_line"],
+                        code_block["last_line"],
+                    )
+                except Exception as e:
+                    if cleanup:
+                        os.remove(snippet_path)
+                    raise e
 
             if autoformat and "noautoformat" not in code_block["flags"]:
                 fn_autoformat(

src/cfengine_cli/format.py

@@ -1,7 +1,5 @@
-import sys
 import tree_sitter_cfengine as tscfengine
-from typing import Generator
-from tree_sitter import Language, Parser, Node, Tree
+from tree_sitter import Language, Parser, Node
 from cfbs.pretty import pretty_file
 
 

src/cfengine_cli/main.py

@@ -93,7 +93,7 @@ def run_command_with_args(args) -> int:
     if args.command == "run":
         return commands.run()
     if args.command == "dev":
-        return commands.dev(args.dev_command)
+        return commands.dev(args.dev_command, args)
     raise UserError(f"Unknown command: '{args.command}'")