Apply code formatter

Author: Nicoretti

exasol/toolbox/nox/_lint.py

@@ -1,24 +1,22 @@
 from __future__ import annotations
 
+import argparse
+import sys
+from pathlib import Path
 from typing import (
+    Dict,
     Iterable,
     List,
-    Dict
 )
-import argparse
-from pathlib import Path
 
 import nox
+import rich.console
+import tomlkit
 from nox import Session
 
 from exasol.toolbox.nox._shared import python_files
 from noxconfig import PROJECT_CONFIG
 
-from pathlib import Path
-import rich.console
-import tomlkit
-import sys
-
 
 def _pylint(session: Session, files: Iterable[str]) -> None:
     session.run(
@@ -76,37 +74,28 @@ def _security_lint(session: Session, files: Iterable[str]) -> None:
     )
 
 
-
 def _import_lint(session: Session, path: Path) -> None:
-    session.run(
-        "poetry",
-        "run",
-        "lint-imports",
-        "--config",
-        path
-    )
+    session.run("poetry", "run", "lint-imports", "--config", path)
+
 
 class Dependencies:
-    def __init__(self, illegal: Dict[str, List[str]] | None):
+    def __init__(self, illegal: dict[str, list[str]] | None):
         self._illegal = illegal or {}
 
     @staticmethod
-    def parse(pyproject_toml: str) -> "Dependencies":
+    def parse(pyproject_toml: str) -> Dependencies:
         def _source_filter(version) -> bool:
-            ILLEGAL_SPECIFIERS = ['url', 'git', 'path']
-            return any(
-                specifier in version
-                for specifier in ILLEGAL_SPECIFIERS
-            )
+            ILLEGAL_SPECIFIERS = ["url", "git", "path"]
+            return any(specifier in version for specifier in ILLEGAL_SPECIFIERS)
 
-        def find_illegal(part) -> List[str]:
+        def find_illegal(part) -> list[str]:
             return [
                 f"{name} = {version}"
                 for name, version in part.items()
                 if _source_filter(version)
             ]
 
-        illegal: Dict[str, List[str]] = {}
+        illegal: dict[str, list[str]] = {}
         toml = tomlkit.loads(pyproject_toml)
         poetry = toml.get("tool", {}).get("poetry", {})
 
@@ -126,11 +115,11 @@ def find_illegal(part) -> List[str]:
         return Dependencies(illegal)
 
     @property
-    def illegal(self) -> Dict[str, List[str]]:
+    def illegal(self) -> dict[str, list[str]]:
         return self._illegal
 
 
-def report_illegal(illegal: Dict[str, List[str]], console: rich.console.Console):
+def report_illegal(illegal: dict[str, list[str]], console: rich.console.Console):
     count = sum(len(deps) for deps in illegal.values())
     suffix = "y" if count == 1 else "ies"
     console.print(f"{count} illegal dependenc{suffix}\n", style="red")
@@ -172,30 +161,33 @@ def dependency_check(session: Session) -> None:
         report_illegal(illegal, console)
         sys.exit(1)
 
+
 @nox.session(name="lint:import", python=False)
 def import_lint(session: Session) -> None:
     """(experimental) Runs import linter on the project"""
     parser = argparse.ArgumentParser(
         usage="nox -s import-lint -- [options]",
-        description="Runs the import linter on the project"
+        description="Runs the import linter on the project",
     )
     parser.add_argument(
         "-c",
         "--config",
         type=str,
         help="path to the configuration file for the importlinter",
-        metavar="TEXT"
+        metavar="TEXT",
     )
 
     args: argparse.Namespace = parser.parse_args(args=session.posargs)
     file: str = args.config
     path: Path | None = None
     if file is None:
-        path = getattr(PROJECT_CONFIG, "import_linter_config", Path(".import_linter_config"))
+        path = getattr(
+            PROJECT_CONFIG, "import_linter_config", Path(".import_linter_config")
+        )
     else:
         path = Path(file)
     if not path.exists():
         session.error(
             "Please make sure you have a configuration file for the importlinter"
         )
-    _import_lint(session=session, path=path)
+    _import_lint(session=session, path=path)

exasol/toolbox/tools/security.py

@@ -11,13 +11,14 @@
 from enum import Enum
 from functools import partial
 from inspect import cleandoc
+from pathlib import Path
 from typing import (
     Generator,
     Iterable,
     Tuple,
 )
+
 import typer
-from pathlib import Path
 
 stdout = print
 stderr = partial(print, file=sys.stderr)
@@ -128,14 +129,16 @@ def from_json(report_str: str, prefix: Path) -> Iterable[SecurityIssue]:
             cwe=str(issue["issue_cwe"].get("id", "")),
             test_id=issue["test_id"],
             description=issue["issue_text"],
-            references=tuple(references)
+            references=tuple(references),
         )
 
 
 def issues_to_markdown(issues: Iterable[SecurityIssue]) -> str:
-    template = cleandoc("""
+    template = cleandoc(
+        """
         {header}{rows}
-    """)
+    """
+    )
 
     def _header():
         header = "# Security\n\n"
@@ -153,10 +156,7 @@ def _row(issue):
         row = row[:-5] + "|"
         return row
 
-    return template.format(
-        header=_header(),
-        rows="\n".join(_row(i) for i in issues)
-    )
+    return template.format(header=_header(), rows="\n".join(_row(i) for i in issues))
 
 
 def security_issue_title(issue: Issue) -> str:
@@ -217,6 +217,7 @@ def create_security_issue(issue: Issue, project="") -> Tuple[str, str]:
 CVE_CLI = typer.Typer()
 CLI.add_typer(CVE_CLI, name="cve", help="Work with CVE's")
 
+
 class Format(str, Enum):
     Maven = "maven"
 
@@ -320,8 +321,10 @@ class PPrintFormats(str, Enum):
 
 @CLI.command(name="pretty-print")
 def json_issue_to_markdown(
-        json_file: typer.FileText = typer.Argument(mode="r", help="json file with issues to convert"),
-        path: Path = typer.Argument(default=Path("."), help="path to project root")
+    json_file: typer.FileText = typer.Argument(
+        mode="r", help="json file with issues to convert"
+    ),
+    path: Path = typer.Argument(default=Path("."), help="path to project root"),
 ) -> None:
     content = json_file.read()
     issues = from_json(content, path.absolute())

test/unit/dependencies_check_test.py

@@ -1,7 +1,10 @@
 import pytest
 import rich.console
 
-from exasol.toolbox.nox._lint import Dependencies, report_illegal
+from exasol.toolbox.nox._lint import (
+    Dependencies,
+    report_illegal,
+)
 
 
 @pytest.mark.parametrize(
@@ -10,7 +13,7 @@
         (
             """
             """,
-            {}
+            {},
         ),
         (
             """
@@ -31,11 +34,19 @@
 example-path1 = {path = "../my-package/dist/my-package-0.1.0.tar.gz"}
             """,
             {
-                "tool.poetry.dependencies": ["example-url1 = {'url': 'https://example.com/my-package-0.1.0.tar.gz'}"],
-                "tool.poetry.dev.dependencies": ["example-url2 = {'url': 'https://example.com/my-package-0.2.0.tar.gz'}"],
-                "tool.poetry.group.test.dependencies": ["example-git = {'git': '[email protected]:requests/requests.git'}"],
-                "tool.poetry.group.dev.dependencies": ["example-path1 = {'path': '../my-package/dist/my-package-0.1.0.tar.gz'}"],
-            }
+                "tool.poetry.dependencies": [
+                    "example-url1 = {'url': 'https://example.com/my-package-0.1.0.tar.gz'}"
+                ],
+                "tool.poetry.dev.dependencies": [
+                    "example-url2 = {'url': 'https://example.com/my-package-0.2.0.tar.gz'}"
+                ],
+                "tool.poetry.group.test.dependencies": [
+                    "example-git = {'git': '[email protected]:requests/requests.git'}"
+                ],
+                "tool.poetry.group.dev.dependencies": [
+                    "example-path1 = {'path': '../my-package/dist/my-package-0.1.0.tar.gz'}"
+                ],
+            },
         ),
         (
             """
@@ -52,10 +63,16 @@
 example-path1 = {path = "../my-package/dist/my-package-0.1.0.tar.gz"}
             """,
             {
-                "tool.poetry.dev.dependencies": ["example-url2 = {'url': 'https://example.com/my-package-0.2.0.tar.gz'}"],
-                "tool.poetry.group.test.dependencies": ["example-git = {'git': '[email protected]:requests/requests.git'}"],
-                "tool.poetry.group.dev.dependencies": ["example-path1 = {'path': '../my-package/dist/my-package-0.1.0.tar.gz'}"],
-            }
+                "tool.poetry.dev.dependencies": [
+                    "example-url2 = {'url': 'https://example.com/my-package-0.2.0.tar.gz'}"
+                ],
+                "tool.poetry.group.test.dependencies": [
+                    "example-git = {'git': '[email protected]:requests/requests.git'}"
+                ],
+                "tool.poetry.group.dev.dependencies": [
+                    "example-path1 = {'path': '../my-package/dist/my-package-0.1.0.tar.gz'}"
+                ],
+            },
         ),
         (
             """
@@ -72,10 +89,16 @@
 example-path1 = {path = "../my-package/dist/my-package-0.1.0.tar.gz"}
             """,
             {
-                "tool.poetry.dependencies": ["example-url1 = {'url': 'https://example.com/my-package-0.1.0.tar.gz'}"],
-                "tool.poetry.group.test.dependencies": ["example-git = {'git': '[email protected]:requests/requests.git'}"],
-                "tool.poetry.group.dev.dependencies": ["example-path1 = {'path': '../my-package/dist/my-package-0.1.0.tar.gz'}"],
-            }
+                "tool.poetry.dependencies": [
+                    "example-url1 = {'url': 'https://example.com/my-package-0.1.0.tar.gz'}"
+                ],
+                "tool.poetry.group.test.dependencies": [
+                    "example-git = {'git': '[email protected]:requests/requests.git'}"
+                ],
+                "tool.poetry.group.dev.dependencies": [
+                    "example-path1 = {'path': '../my-package/dist/my-package-0.1.0.tar.gz'}"
+                ],
+            },
         ),
         (
             """
@@ -88,11 +111,15 @@
 example-url2 = {url = "https://example.com/my-package-0.2.0.tar.gz"}
             """,
             {
-                "tool.poetry.dependencies": ["example-url1 = {'url': 'https://example.com/my-package-0.1.0.tar.gz'}"],
-                "tool.poetry.dev.dependencies": ["example-url2 = {'url': 'https://example.com/my-package-0.2.0.tar.gz'}"],
-            }
-        )
-    ]
+                "tool.poetry.dependencies": [
+                    "example-url1 = {'url': 'https://example.com/my-package-0.1.0.tar.gz'}"
+                ],
+                "tool.poetry.dev.dependencies": [
+                    "example-url2 = {'url': 'https://example.com/my-package-0.2.0.tar.gz'}"
+                ],
+            },
+        ),
+    ],
 )
 def test_dependency_check_parse(toml, expected):
     dependencies = dependencies = Dependencies.parse(toml)
@@ -136,9 +163,9 @@ def test_dependency_check_parse(toml, expected):
 example-path1 = {'path': '../my-package/dist/my-package-0.1.0.tar.gz'}
 example-path2 = {'path': '../my-package/dist/my-package-0.2.0.tar.gz'}
 
-"""
+""",
         ),
-    ]
+    ],
 )
 def test_dependencies_check_report(toml, expected, capsys):
     console = rich.console.Console()

test/unit/security_test.py

@@ -410,7 +410,7 @@ def test_format_jsonl_removes_newline():
     "json_file,expected",
     [
         (
-            '''{
+            """{
     "results": [
         {
             "code": "1 import subprocess\\n2 from typing import Iterable\\n3 \\n",
@@ -434,7 +434,7 @@ def test_format_jsonl_removes_newline():
         }
     ]
 }
-            ''',
+            """,
             {
                 "file_name": "exasol/toolbox/git.py",
                 "line": 53,
@@ -444,11 +444,11 @@ def test_format_jsonl_removes_newline():
                 "description": "Consider possible security implications associated with the subprocess module.",
                 "references": (
                     "https://bandit.readthedocs.io/en/1.7.10/blacklists/blacklist_imports.html#b404-import-subprocess",
-                    "https://cwe.mitre.org/data/definitions/78.html"
-                )
-            }
+                    "https://cwe.mitre.org/data/definitions/78.html",
+                ),
+            },
         )
-    ]
+    ],
 )
 def test_from_json(json_file, expected):
     actual = security.from_json(json_file, pathlib.Path("/home/test/python-toolbox"))
@@ -459,6 +459,6 @@ def test_from_json(json_file, expected):
         cwe=expected["cwe"],
         test_id=expected["test_id"],
         description=expected["description"],
-        references=expected["references"]
+        references=expected["references"],
     )
     assert list(actual) == [expected_issue]