Add test for test_excluded_python_paths and update description

Author: ArBridgeman

exasol/toolbox/config.py

@@ -20,6 +20,16 @@ def valid_version_string(version_string: str) -> str:
 
 ValidVersionStr = Annotated[str, AfterValidator(valid_version_string)]
 
+DEFAULT_EXCLUDED_PATHS = {
+    ".eggs",
+    ".html-documentation",
+    ".poetry",
+    ".sonar",
+    ".venv",
+    "dist",
+    "venv",
+}
+
 
 class BaseConfig(BaseModel):
     """
@@ -55,7 +65,7 @@ class BaseConfig(BaseModel):
         This is used to extend the default excluded_python_paths. If a more general
         path that would be seen in other projects, like .venv, needs to be added into
         this argument, please instead modify the
-        :meth:`exasol.toolbox.config.BaseConfig.excluded_paths` attribute.
+        `exasol.toolbox.config.DEFAULT_EXCLUDED_PATHS`.
         """,
     )
     model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True)
@@ -88,17 +98,8 @@ def excluded_python_paths(self) -> tuple[str, ...]:
         source_path, like excluding `dist`, `.eggs`. As such, this property is used to
         exclude such undesired paths.
         """
-        default_excluded_paths = {
-            ".eggs",
-            ".html-documentation",
-            ".poetry",
-            ".sonar",
-            ".venv",
-            "dist",
-            "venv",
-        }
         return tuple(
-            default_excluded_paths.union(set(self.add_to_excluded_python_paths))
+            DEFAULT_EXCLUDED_PATHS.union(set(self.add_to_excluded_python_paths))
         )
 
     @computed_field  # type: ignore[misc]

test/unit/config_test.py

@@ -2,6 +2,7 @@
 from pydantic_core._pydantic_core import ValidationError
 
 from exasol.toolbox.config import (
+    DEFAULT_EXCLUDED_PATHS,
     BaseConfig,
     valid_version_string,
 )
@@ -66,3 +67,22 @@ def test_minimum_python_version():
 def test_pyupgrade_argument(minimum_python_version):
     conf = BaseConfig(python_versions=("3.11", minimum_python_version, "3.12"))
     assert conf.pyupgrade_argument == ("--py310-plus",)
+
+
+@pytest.mark.parametrize(
+    "add_to_excluded_python_paths,expected",
+    [
+        pytest.param((), tuple(DEFAULT_EXCLUDED_PATHS), id="no_additions"),
+        pytest.param(
+            (next(iter(DEFAULT_EXCLUDED_PATHS)),),
+            tuple(DEFAULT_EXCLUDED_PATHS),
+            id="duplicate_addition",
+        ),
+        pytest.param(
+            ("dummy",), tuple(DEFAULT_EXCLUDED_PATHS) + ("dummy",), id="add_a_new_entry"
+        ),
+    ],
+)
+def test_excluded_python_paths(add_to_excluded_python_paths, expected):
+    conf = BaseConfig(add_to_excluded_python_paths=add_to_excluded_python_paths)
+    assert sorted(conf.excluded_python_paths) == sorted(expected)