Field add_to_excluded_python_paths should work with multiple path parts

[tomuben]

Checklist

In order to improve the time, how long a bugfix does take, please make sure you address as much as possible of the following checklist.

• I have reproduced the issue with at least the latest released version of <PROJECT-NAME>.
• I have added references to issues that sound similar in section Related Issues.

Tip: Adding screenshots, outputs and logs might help to improve clarity.

Summary

Reproducing the Issue

always
Use something like:

    add_to_excluded_python_paths=(
        "test/resources",
    ),

to BaseConfig.
Observe that files with "test/resources" are not being ignored.

[ArBridgeman]

@tomuben This has been changed to a feature. While the documentation might be poor, add_to_excluded_python_paths was intended to avoid files like .venv, etc. which are more universal. We've historically allowed projects to add on to this, as they might be using different Python dependency management tools. Yes, as it was historically code, this limits which paths can be added.

From what you wrote regarding your issue, this seems to be a conflict between how mypy works with the pyproject.toml and how we pipe filenames directly into it, which leads to the observed issue that specific directories could not be ignored.

[ArBridgeman]

Again, this should be compared to the pyproject.toml usage & the documentation updated to clarify what works vs not.

[ckunki]

Repository notebook-connector seems to have a similar issue. It contains directories named like python files, e.g. ui_snapshots/test/integration/ui/test_access_store_ui.py.

This directory is created by Solara test framework during GUI tests and contains screenshots of the GUI. Solara can create and these screenshots as ground truth when exectuting the test cases again in a later session. Solara names each directory exactly like the name of the original file containing the pytests.

For example the tests in file test/integration/ui/test_access_store_ui.py will create screenshots in directory ui_snapshots/test/integration/ui/test_access_store_ui.py.

[ckunki]

We plan to update the PTB implementation in the following way:

• Handle the DEFAULT_EXCLUDED_PATHS as instances of pathlib.Path rather than strings.
• Interpret each entry as path below root_path (The root directory of the project),
• Update function get_filtered_python_files() to
  • exclude each of the specifed paths in whole
  • rather than splitting it into its parth components with set(path.parts).

[ckunki]

This will be a slight change in the semantics of how the PTB handles excluded paths.

Up to now PTB excluded each configured directory potentially on multiple levels, e.g. /.venv, /dir/.venv, /dir/subdir/.venv while in future only the top-level directory will be excluded. But in the worst case a project can also configure the path multiple times, each time with the required parent directories.

This approach will solve the use case in the notebook-connector (NC), as the NC can simply exclude the directory /ui_snapshots.

The approach should also serve the scenario described in repo script-languages-container-tool, PR #336.