Refactoring/406 add poetry to formatting ignore list (#418)

* Fix poetry pyproject.toml to pass poetry check & resolve minor type issue instead of ignoring whole file

* Fix unreleased.md to point to issue not PR

* Add `.poetry` to ignore list for formmatting tasks & consolidate code & tests

* Remove matrix.exasol from unit tests as matrix set only with matrix-python & unit tests shouldn't work with db

* Update dependencies

* Add working directory to python-environment action

* Fix typos in getting_started.rst

* Modify nox `docs:multiversion` to add `.nojekyll` file

* Fix formatting on files

* Resolve lint:typing and rst issues

* Update test per review comments

* Fix formatting on test file

Author: ArBridgeman

.github/actions/python-environment/action.yml

@@ -13,14 +13,19 @@ inputs:
     required: true
     default: "2.1.2"
 
+  working-directory:
+    description: 'Working directory to use'
+    required: true
+    default: "."
+
 runs:
 
   using: "composite"
   steps:
 
     - name: Setup Poetry (${{ inputs.poetry-version }})
-      run: pipx install poetry==${{ inputs.poetry-version }}
       shell: bash
+      run: pipx install poetry==${{ inputs.poetry-version }}
 
     - name: Setup Python (${{ inputs.python-version}})
       uses: actions/setup-python@v5
@@ -29,5 +34,6 @@ runs:
         cache: 'poetry'
 
     - name: Poetry install
-      run: poetry install
+      working-directory: ${{ inputs.working-directory }}
       shell: bash
+      run: poetry install

.github/workflows/report.yml

@@ -20,7 +20,7 @@ jobs:
         uses: ./.github/actions/python-environment
 
       - name: Download Artifacts
-        uses: actions/download-artifact@v4.2.1
+        uses: actions/download-artifact@v4.3.0
         with:
           path: ./artifacts
 

doc/changes/unreleased.md

@@ -2,4 +2,10 @@
 
 ## ✨ Features
 
-* [#378](https://github.com/exasol/python-toolbox/pull/378/files): Add Nox task to trigger a release
+* [#362](https://github.com/exasol/python-toolbox/issues/362): Added Nox task to trigger a release
+* [#406](https://github.com/exasol/python-toolbox/issues/406): Added `.poetry` to ignore list for formatting
+* [#417](https://github.com/exasol/python-toolbox/issues/417): Added `working-directory` to `python-environment` action for a different `pyproject.toml` location
+
+## Bugfixes
+
+* [#401](https://github.com/exasol/python-toolbox/issues/401): Modified nox `docs:multiversion` to add `.nojekyll` file

doc/user_guide/getting_started.rst

@@ -39,7 +39,7 @@ Use the following command to create a new project:
 
 **2. Follow the interactive project setup prompt**
 
-**3. Bootstrapp the development environment**
+**3. Bootstrap the development environment**
 
 Navigate to the directory of the newly created project:
 
@@ -127,7 +127,7 @@ Alternatively you can use the *noxconfig.py* file bellow and adjust the value of
 
 4. Configure the tooling
 ++++++++++++++++++++++++
-In order to make all standard task work properly you need add the configuration settings bellow to your *pyproject.toml*,
+In order to make all standard task work properly, you need add the configuration settings below to your *pyproject.toml*,
 and adjust the following settings to your project needs:
 
 * coverage
@@ -145,8 +145,8 @@ and adjust the following settings to your project needs:
 5. Make the toolbox tasks available
 +++++++++++++++++++++++++++++++++++
 In order to use the standard toolbox task via nox, just import them in your *noxfile.py*.
-If you only need the standard tasks provided by the toolbox your *noxfile.py* is straight
-forward and you just can use the example *noxfile.py* bellow.
+If you only need the standard tasks provided by the toolbox, your *noxfile.py* is straight
+forward, and you just can use the example *noxfile.py* below.
 
 .. literalinclude:: ../../noxfile.py
    :language: python3
@@ -161,8 +161,8 @@ forward and you just can use the example *noxfile.py* bellow.
 
 
 
-6. Setup the pre-commit hooks [optional]
-++++++++++++++++++++++++++++++++++++++++
+6. Set up the pre-commit hooks [optional]
++++++++++++++++++++++++++++++++++++++++++
 
 #. Add a :code:`.pre-commit-config.yaml` file to your project root
 
@@ -171,7 +171,7 @@ forward and you just can use the example *noxfile.py* bellow.
     .. literalinclude:: ../../.pre-commit-config.yaml
        :language: yaml
 
-#. Enable pre commit hooks for your workspace
+#. Enable pre-commit hooks for your workspace
 
     .. code-block:: shell
 

exasol/toolbox/nox/_documentation.py

@@ -36,6 +36,7 @@ def _build_multiversion_docs(session: nox.Session, config: Config) -> None:
         f"{config.doc}",
         DOCS_OUTPUT_DIR,
     )
+    session.run("touch", f"{DOCS_OUTPUT_DIR}/.nojekyll")
 
 
 def _git_diff_changes_main() -> int:

exasol/toolbox/nox/_shared.py

@@ -17,6 +17,7 @@
 
 from noxconfig import PROJECT_CONFIG
 
+DEFAULT_PATH_FILTERS = {"dist", ".eggs", "venv", ".poetry"}
 DOCS_OUTPUT_DIR = ".html-documentation"
 
 
@@ -26,24 +27,13 @@ class Mode(Enum):
 
 
 def python_files(project_root: Path) -> Iterable[Path]:
-    path_filters = tuple(["dist", ".eggs", "venv"] + list(PROJECT_CONFIG.path_filters))
-    return _python_files(project_root, path_filters)
-
-
-def _python_files(
-    project_root: Path, path_filters: Iterable[str] = ("dist", ".eggs", "venv")
-) -> Iterable[Path]:
-    """Returns all relevant"""
-    return _deny_filter(project_root.glob("**/*.py"), deny_list=path_filters)
-
-
-def _deny_filter(files: Iterable[Path], deny_list: Iterable[str]) -> Iterable[Path]:
     """
-    Adds a filter to remove unwanted paths containing python files from the iterator.
+    Returns iterable of python files after removing unwanted paths
     """
-    for entry in deny_list:
-        files = list(filter(lambda path: entry not in path.parts, files))
-    return files
+    deny_list = DEFAULT_PATH_FILTERS.union(set(PROJECT_CONFIG.path_filters))
+
+    files = project_root.glob("**/*.py")
+    return [path for path in files if not set(path.parts).intersection(deny_list)]
 
 
 def _version(session: Session, mode: Mode, version_file: Path) -> None:

exasol/toolbox/sphinx/multiversion/git.py

@@ -8,7 +8,7 @@
 import tempfile
 
 GitRef = collections.namedtuple(
-    "VersionRef",
+    "GitRef",
     [
         "name",
         "commit",

exasol/toolbox/templates/github/workflows/checks.yml

@@ -153,7 +153,7 @@ jobs:
         run: poetry run -- nox -s project:format
 
   Tests:
-    name: Unit-Tests (Python-${{ matrix.python-version }}, Exasol-${{ matrix.exasol-version}})
+    name: Unit-Tests (Python-${{ matrix.python-version }})
     needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix ]
     runs-on: ubuntu-24.04
     env:

noxconfig.py

@@ -46,9 +46,6 @@ class Config:
     importlinter: Path = Path(__file__).parent / ".import_linter_config"
     version_file: Path = Path(__file__).parent / "exasol" / "toolbox" / "version.py"
     path_filters: Iterable[str] = (
-        "dist",
-        ".eggs",
-        "venv",
         "metrics-schema",
         "project-template",
         "idioms",