Merge branch 'main' into feature/613_move_path_filters_to_BaseConfig

Author: ArBridgeman

.github/workflows/checks.yml

@@ -158,7 +158,7 @@ jobs:
         uses: ./.github/actions/python-environment
 
       - name: Run format check
-        run: poetry run -- nox -s project:format
+        run: poetry run -- nox -s format:check
 
   Build-Packages:
     name: Build Package Check

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
         types: [ python ]
         pass_filenames: false
         language: system
-        entry: poetry run -- nox -s project:fix
+        entry: poetry run -- nox -s format:fix
         stages: [ pre-commit ]
 
   - repo: local
@@ -39,4 +39,4 @@ repos:
       - id: end-of-file-fixer
         stages: [ pre-commit ]
       - id: trailing-whitespace
-        stages: [ pre-commit ]
+        stages: [ pre-commit ]

doc/changes/unreleased.md

@@ -1,5 +1,12 @@
 # Unreleased
 
+This major release removes `project:fix` and `project:format`
+and replaces them with `format:fix` and `format:check`.
+
+## Refactoring
+
+* #606: Renamed nox session `project:fix` more aptly to `format:fix` and `project:format` to `format:check`
+
 ## Feature
 
 * #614: Replaced `path_filters` with `BaseConfig.add_to_excluded_python_paths` and `BaseConfig.excluded_python_paths`

doc/user_guide/features/formatting_code/index.rst

@@ -45,9 +45,9 @@ deterministic manner.
 +--------------------+------------------+------------------------------------+
 | Nox session        | CI Usage         | Action                             |
 +====================+==================+====================================+
-| ``project:fix``    | No               | Applies code formatting changes    |
+| ``format:fix``     | No               | Applies code formatting changes    |
 +--------------------+------------------+------------------------------------+
-| ``project:format`` | ``checks.yml``   | Checks that current code does not  |
+| ``format:check``   | ``checks.yml``   | Checks that current code does not  |
 |                    |                  | need to be re-formatted            |
 +--------------------+------------------+------------------------------------+
 

doc/user_guide/features/formatting_code/troubleshooting.rst

@@ -3,15 +3,15 @@
 Troubleshooting
 ===============
 
-Formatting still fails after running ``project:fix``
+Formatting still fails after running ``format:fix``
 ----------------------------------------------------
 
 If when you execute:
 
-#. Run ``project:fix``
-#. Run ``project:format``
+#. Run ``format:fix``
+#. Run ``format:check``
 
-you receive an error from ``project:format`` (i.e. ``isort`` or ``black``), it it
+you receive an error from ``format:check`` (i.e. ``isort`` or ``black``), it it
 likely that you need to update your configuration to align with
 :ref:`formatting_configuration`.
 
@@ -46,7 +46,7 @@ might want to ignore automatically applied formatting.
 +-----------------------+--------------------------------+-----------------------+
 
 
-In the ``checks.yml``, ``project:format`` wants me to reformat code I did not modify
+In the ``checks.yml``, ``format:check`` wants me to reformat code I did not modify
 ------------------------------------------------------------------------------------
 
 This is likely due to one of our tools (i.e. ``black``) being upgraded. Within the

doc/user_guide/migrating.rst

@@ -63,9 +63,9 @@ For example, if test execution isn't performed in the standard way (e.g., :code:
     from exasol.toolbox.nox.tasks import *  # pylint: disable=wildcard-import disable=unused-wildcard-import
 
     # default actions to be run if nothing is explicitly specified with the -s option
-    nox.options.sessions = ["project:fix"]
+    nox.options.sessions = ["format:fix"]
 
-    @nox.session(name="project:fix", python=False)
+    @nox.session(name="format:fix", python=False)
     def my_project_fix_overwrite(session) -> None:
         """Runs all automated fixes on the code base"""
 
@@ -75,7 +75,7 @@ For example, if test execution isn't performed in the standard way (e.g., :code:
         from exasol.toolbox.nox._shared import get_filtered_python_files
 
         py_files = get_filtered_python_files(PROJECT_CONFIG.root)
-        print("The original 'project:fix' task has been taken hostage by this overwrite")
+        print("The original 'format:fix' task has been taken hostage by this overwrite")
         print("Files:\n{files}".format(files="\n".join(py_files))
 
 

exasol/toolbox/config.py

@@ -92,8 +92,8 @@ def excluded_python_paths(self) -> tuple[str, ...]:
           - lint:code
           - lint:security
           - lint:typing
-          - project:fix
-          - project:format
+          - format:fix
+          - format:check
         where it is desired restrict which Python files are considered within the
         source_path, like excluding `dist`, `.eggs`. As such, this property is used to
         exclude such undesired paths.

exasol/toolbox/nox/_format.py

@@ -42,18 +42,18 @@ def command(*args: str) -> Iterable[str]:
     session.run(*command("ruff", "check"), *files)
 
 
-@nox.session(name="project:fix", python=False)
-def fix(session: Session) -> None:
-    """Runs all automated fixes on the code base"""
+@nox.session(name="format:fix", python=False)
+def fix_format(session: Session) -> None:
+    """Runs all automated format fixes on the code base"""
     py_files = get_filtered_python_files(PROJECT_CONFIG.root)
     _version(session, Mode.Fix)
     _pyupgrade(session, config=PROJECT_CONFIG, files=py_files)
     _ruff(session, mode=Mode.Fix, files=py_files)
     _code_format(session, Mode.Fix, py_files)
 
 
-@nox.session(name="project:format", python=False)
-def fmt_check(session: Session) -> None:
+@nox.session(name="format:check", python=False)
+def check_format(session: Session) -> None:
     """Checks the project for correct formatting"""
     py_files = get_filtered_python_files(PROJECT_CONFIG.root)
     _ruff(session, mode=Mode.Check, files=py_files)

exasol/toolbox/nox/_package_version.py

@@ -23,7 +23,7 @@
     """
     ATTENTION:
         This file is generated by exasol/toolbox/nox/_package_version.py when using:
-            * either "poetry run -- nox -s project:fix"
+            * either "poetry run -- nox -s format:fix"
             * or "poetry run -- nox -s version:check -- --fix"
     Do not edit this file manually!
     If you need to change the version, do so in the pyproject.toml, e.g. by using

exasol/toolbox/nox/tasks.py

@@ -6,7 +6,7 @@
     "check",
     "clean_docs",
     "coverage",
-    "fix",
+    "fix_format",
     "integration_tests",
     "lint",
     "open_docs",
@@ -22,7 +22,7 @@
 # ruff: noqa F401
 from exasol.toolbox.nox._format import (
     _code_format,
-    fix,
+    fix_format,
 )
 
 # fmt: off