Add code formatter

Author: Nicoretti

doc/conf.py

@@ -38,7 +38,7 @@
     "sphinx_design",
     "sphinx_inline_tabs",
     "sphinx_copybutton",
-    "exasol.toolbox.sphinx.multiversion"
+    "exasol.toolbox.sphinx.multiversion",
 ]
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

doc/user_guide/modules/sphinx/multiversion/conf.py

@@ -1,4 +1,5 @@
 """Sphinx configuration file."""
+
 import time
 
 author = "Jan Holthuis"

exasol/toolbox/metrics.py

@@ -157,7 +157,14 @@ def char(value: str, default: str = "H") -> str:
             return value[0]
         return default
 
-    weight = {"LL": 1/18, "LM": 1/15, "LH": 1/12, "ML": 1/9, "MM": 1/6, "MH": 1/3}
+    weight = {
+        "LL": 1 / 18,
+        "LM": 1 / 15,
+        "LH": 1 / 12,
+        "ML": 1 / 9,
+        "MM": 1 / 6,
+        "MH": 1 / 3,
+    }
     exp = 0.0
     for infos in ratings:
         severity = infos["issue_severity"]

exasol/toolbox/nox/_lint.py

@@ -11,14 +11,15 @@
 
 def _pylint(session: Session, files: Iterable[str]) -> None:
     session.run(
-            "poetry",
-            "run",
-            "python",
-            "-m",
-            "pylint",
-            "--output-format",
-            "colorized,json:.lint.json,text:.lint.txt",
-            *files)
+        "poetry",
+        "run",
+        "python",
+        "-m",
+        "pylint",
+        "--output-format",
+        "colorized,json:.lint.json,text:.lint.txt",
+        *files,
+    )
 
 
 def _type_check(session: Session, files: Iterable[str]) -> None:

exasol/toolbox/nox/_shared.py

@@ -65,7 +65,7 @@ def _context(session: Session, **kwargs: Any) -> MutableMapping[str, Any]:
     parser = _context_parser()
     namespace, args = parser.parse_known_args(session.posargs)
     cli_context: MutableMapping[str, Any] = vars(namespace)
-    cli_context['fwd-args'] = args
+    cli_context["fwd-args"] = args
     default_context = {"db_version": "7.1.9", "coverage": False}
     # Note: ChainMap scans last to first
     return ChainMap(kwargs, cli_context, default_context)

exasol/toolbox/nox/_test.py

@@ -28,7 +28,7 @@ def _test_command(
         else []
     )
     pytest_command = ["pytest", "-v", f"{path}"]
-    return base_command + coverage_command + pytest_command + context['fwd-args']
+    return base_command + coverage_command + pytest_command + context["fwd-args"]
 
 
 def _unit_tests(

exasol/toolbox/sphinx/multiversion/__init__.py

@@ -15,9 +15,9 @@
 The original version and its defaults were minimally adjusted to work in Exasol's projects with the defaults and without adding an extra template. The [Shibuya](https://github.com/lepture/shibuya) theme is expected to be used for HTML, which already evaluates the versions field in the HTML context and generates an appropriate selector for the versions.
 """
 
-from exasol.toolbox.version import VERSION
 from exasol.toolbox.sphinx.multiversion.main import main
 from exasol.toolbox.sphinx.multiversion.sphinx import setup
+from exasol.toolbox.version import VERSION
 
 __version__ = VERSION
 

exasol/toolbox/sphinx/multiversion/sphinx.py

@@ -9,6 +9,8 @@
 from sphinx.locale import _
 from sphinx.util import i18n as sphinx_i18n
 
+from exasol.toolbox.version import VERSION
+
 logger = logging.getLogger(__name__)
 
 DATE_FMT = "%Y-%m-%d %H:%M:%S %z"
@@ -136,11 +138,13 @@ def in_development(self):
     def __iter__(self):
         tags = (
             ExasolVersionTag(tag)
-            for tag in self.tags if ExasolVersionTag.is_valid_tag(tag)
+            for tag in self.tags
+            if ExasolVersionTag.is_valid_tag(tag)
         )
         yield from self.branches
         yield from [
-            t.version for t in sorted(tags, key=lambda t: t.version_triple, reverse=True)
+            t.version
+            for t in sorted(tags, key=lambda t: t.version_triple, reverse=True)
         ]
 
     def __getitem__(self, name):
@@ -167,22 +171,19 @@ def vpathto(self, other_version_name):
         other_outputroot = os.path.abspath(other_version["outputdir"])
         outputroot = os.path.commonpath((current_outputroot, other_outputroot))
 
-        current_outputroot = os.path.relpath(
-            current_outputroot, start=outputroot)
+        current_outputroot = os.path.relpath(current_outputroot, start=outputroot)
         other_outputroot = os.path.relpath(other_outputroot, start=outputroot)
 
         # Ensure that we use POSIX separators in the path (for the HTML code)
         if os.sep != posixpath.sep:
-            current_outputroot = posixpath.join(
-                *os.path.split(current_outputroot))
+            current_outputroot = posixpath.join(*os.path.split(current_outputroot))
             other_outputroot = posixpath.join(*os.path.split(other_outputroot))
 
         # Find relative path to root of other_version's outputdir
         current_outputdir = posixpath.dirname(
             posixpath.join(current_outputroot, self.context["pagename"])
         )
-        other_outputdir = posixpath.relpath(
-            other_outputroot, start=current_outputdir)
+        other_outputdir = posixpath.relpath(other_outputroot, start=current_outputdir)
 
         if not self.vhasdoc(other_version_name):
             return posixpath.join(other_outputdir, "index.html")
@@ -284,14 +285,10 @@ def setup(app):
     app.add_config_value("smv_current_version", "", "html")
     app.add_config_value("smv_latest_version", "master", "html")
     app.add_config_value("smv_tag_whitelist", DEFAULT_TAG_WHITELIST, "html")
-    app.add_config_value("smv_branch_whitelist",
-                         DEFAULT_BRANCH_WHITELIST, "html")
-    app.add_config_value("smv_remote_whitelist",
-                         DEFAULT_REMOTE_WHITELIST, "html")
-    app.add_config_value("smv_released_pattern",
-                         DEFAULT_RELEASED_PATTERN, "html")
-    app.add_config_value("smv_outputdir_format",
-                         DEFAULT_OUTPUTDIR_FORMAT, "html")
+    app.add_config_value("smv_branch_whitelist", DEFAULT_BRANCH_WHITELIST, "html")
+    app.add_config_value("smv_remote_whitelist", DEFAULT_REMOTE_WHITELIST, "html")
+    app.add_config_value("smv_released_pattern", DEFAULT_RELEASED_PATTERN, "html")
+    app.add_config_value("smv_outputdir_format", DEFAULT_OUTPUTDIR_FORMAT, "html")
     app.add_config_value("smv_build_targets", DEFAULT_BUILD_TARGETS, "html")
     app.add_config_value(
         "smv_clean_intermediate_files",
@@ -301,7 +298,7 @@ def setup(app):
     app.connect("config-inited", config_inited)
 
     return {
-        "version": "0.2",
+        "version": VERSION,
         "parallel_read_safe": True,
         "parallel_write_safe": True,
     }

exasol/toolbox/tools/security.py

@@ -1,4 +1,5 @@
 """This module contains security related CLI tools and code"""
+
 import json
 import re
 import subprocess

noxconfig.py

@@ -1,4 +1,5 @@
 """Configuration for nox based task runner"""
+
 from __future__ import annotations
 
 from dataclasses import dataclass
@@ -35,8 +36,15 @@ class Config:
     root: Path = Path(__file__).parent
     doc: Path = Path(__file__).parent / "doc"
     version_file: Path = Path(__file__).parent / "exasol" / "toolbox" / "version.py"
-    path_filters: Iterable[str] = ("dist", ".eggs", "venv", "metrics-schema", "project-template", "idioms")
+    path_filters: Iterable[str] = (
+        "dist",
+        ".eggs",
+        "venv",
+        "metrics-schema",
+        "project-template",
+        "idioms",
+    )
     plugins = [UpdateTemplates]
-    
+
 
 PROJECT_CONFIG = Config()