Merge pull request #277 from 15r10nk/fix-config-path

fix!: change how tests directory is located

Author: 15r10nk

changelog.d/20250730_231113_15r10nk-git_fix_config_path.md

@@ -0,0 +1,7 @@
+### Changed
+
+- You now have to specify `test-dir` in your pyproject.toml when you save your tests in a folder other than `tests/` in your project root (#272).
+
+### Fixed
+
+- `pyproject.toml` is now also located based on the current directory and the `pytest-root`, which solves problems when you use inline-snapshot with uv-workspaces (#272).

docs/configuration.md

@@ -62,7 +62,7 @@ fix=["create","fix"]
         ```
 
     === "no command (default)"
-        inline-snapshot will format only the snapshot values with black when you specified no format command but needs black installed with `inline-snapshot[black]`.
+        inline-snapshot will format only the snapshot values with black when you specify no format command, but requires black to be installed with `inline-snapshot[black]`.
 
     The placeholder `{filename}` can be used to specify the filename if it is needed to find the correct formatting options for this file.
 
@@ -71,11 +71,12 @@ fix=["create","fix"]
 
 * **show-updates:**[](){#show-updates} shows updates in reviews and reports.
 
-
-* **default-storage:**[](){#default-storage} defines the default storage protocol to be used when creating snapshots without an explicit storage protocol (e.g. like `external()`).
+* **default-storage:**[](){#default-storage} defines the default storage protocol to be used when creating snapshots without an explicit storage protocol, such as `external()`.
     Possible values are `hash` and `uuid`.
-    external snapshots created by `outsource()` do not currently support this setting due to some internal limitations and will always use the old `hash` protocol.
+    External snapshots created by `outsource()` do not currently support this setting due to some internal limitations and will always use the old `hash` protocol.
 
-* **tests-dir:** can be used to define where your tests are located.
-    The default is `<pytest_config_dir>/tests` if it exists or `<pytest_config_dir>` if you have no tests directory,
+* **test-dir:** can be used to define where your tests are located.
+    The default is `<pytest_config_dir>/tests` if it exists,
     where `<pytest_config_dir>` is replaced by the directory containing the Pytest configuration file, if any.
+    This directory is used to search through all test files for `external()` calls and to check whether the currently saved external objects are still used in the source.
+    It is therefore required if you want to *trim* unused externals.

pyproject.toml

@@ -216,6 +216,7 @@ version = "command: cz bump --get-next"
 
 [tool.pytest.ini_options]
 markers=["no_rewriting: marks tests which need no code rewriting and can be used with pypy"]
+testpaths="tests"
 
 [tool.isort]
 profile="black"

src/inline_snapshot/_config.py

@@ -83,14 +83,6 @@ def read_path(name):
     ):
         config.tests_dir = test_dir
 
-    if (
-        config.tests_dir is None
-        and path.exists()
-        and (test_dir := path.parent).exists()
-        and test_dir.is_dir()
-    ):
-        config.tests_dir = test_dir
-
     config.default_storage = tool_config.get("default-storage", "uuid")
 
     if config.default_storage not in ("uuid", "hash"):

src/inline_snapshot/_external/_external_location.py

@@ -143,7 +143,7 @@ def __str__(self) -> str:
         except ValueError:
             pass
 
-        return str(p)
+        return p.as_posix()
 
     @contextmanager
     def load(self) -> Generator[Path]:

src/inline_snapshot/pytest_plugin.py

@@ -125,20 +125,43 @@ def is_implementation_supported():
     return sys.implementation.name == "cpython"
 
 
-def pytest_configure(config):
-    enter_snapshot_context()
+def is_relative_to(base, relative):
+    try:
+        relative.relative_to(base)
+    except ValueError:
+        return False
+    return True
 
-    directory = config.rootpath
-    while not (pyproject := directory / "pyproject.toml").exists():
+
+def find_pyproject(pytest_root, cwd):
+    if is_relative_to(pytest_root, Path.cwd()):
+        directory = Path.cwd()
+    else:
+        directory = pytest_root
+
+    while not (pyproject_pytest := directory / "pyproject.toml").exists():
         if directory == directory.parent:
             break
         directory = directory.parent
+    else:
+        return pyproject_pytest
+
+
+def pytest_configure(config):
+    enter_snapshot_context()
+
+    pyproject = find_pyproject(config.rootpath, Path.cwd())
 
     if is_pytest_compatible():
         state().config.default_flags_tui = ["create", "review"]
         state().config.default_flags = ["report"]
 
-    _config.read_config(pyproject, state().config)
+    if pyproject is not None:
+        _config.read_config(pyproject, state().config)
+
+    if state().config.tests_dir is None:
+        if (tests_dir := Path.cwd() / "tests").exists() and tests_dir.is_dir():
+            state().config.tests_dir = tests_dir
 
     console = Console()
     if is_ci_run():
@@ -417,7 +440,7 @@ def header():
                 console().print(
                     Panel(
                         Syntax(diff, "diff", theme="ansi_light", word_wrap=True),
-                        title=str(name),
+                        title=name.as_posix(),
                         box=(
                             box.ASCII
                             if os.environ.get("TERM", "") == "unknown"
@@ -527,40 +550,47 @@ def console():
         apply_all(used_changes, cr)
         changed_files = {Path(f.filename): f for f in cr.files()}
 
-        all_files = {
-            *map(Path, state().files_with_snapshots),
-        }
-
         test_dir = state().config.tests_dir
-        if test_dir:
-            all_files |= set(test_dir.rglob("*.py"))
-
-        used = []
-
-        for file in all_files:
-            if file in changed_files:
-                content = changed_files[file].new_code()
-                check_import = False
-            else:
-                content = file.read_text("utf-8")
-                check_import = True
-
-            for e in used_externals_in(content, check_import=check_import):
-                try:
-                    location = ExternalLocation.from_name(e)
-                    used.append(location)
-                except ValueError:
-                    pass
-
-        changes = {f: [] for f in Flags.all()}
-
-        for name, storage in state().all_storages.items():
-            for external_change in storage.sync_used_externals(
-                [e for e in used if e.storage == name]
-            ):
-                changes[external_change.flag].append(external_change)
-
-        used_changes += filter_changes(changes, snapshot_changes, console)
+        if not test_dir:
+            console().print(
+                "INFO: inline-snasphot can not trim your external snapshots,"
+                " because there is no [i]tests/[/] folder in your repository root"
+                " and no [i]test-dir[/] defined in your pyproject.toml."
+            )
+        else:
+
+            all_files = {
+                *map(Path, state().files_with_snapshots),
+                *test_dir.rglob("*.py"),
+            }
+
+            used = []
+
+            for file in all_files:
+                if file in changed_files:
+                    content = changed_files[file].new_code()
+                    check_import = False
+                else:
+                    content = file.read_text("utf-8")
+                    check_import = True
+
+                for e in used_externals_in(content, check_import=check_import):
+                    try:
+                        location = ExternalLocation.from_name(e)
+                    except ValueError:
+                        pass
+                    else:
+                        used.append(location)
+
+            changes = {f: [] for f in Flags.all()}
+
+            for name, storage in state().all_storages.items():
+                for external_change in storage.sync_used_externals(
+                    [e for e in used if e.storage == name]
+                ):
+                    changes[external_change.flag].append(external_change)
+
+            used_changes += filter_changes(changes, snapshot_changes, console)
 
         report_problems(console)
 

src/inline_snapshot/testing/_example.py

@@ -135,7 +135,7 @@ def __init__(self, files: str | dict[str, str | bytes]):
                    or just a string which will be saved as *test_something.py*.
         """
         if isinstance(files, str):
-            files = {"test_something.py": files}
+            files = {"tests/test_something.py": files}
 
         self.files = files
 
@@ -266,7 +266,7 @@ def run_inline(
 
                 try:
                     tests_found = False
-                    for filename in tmp_path.glob("*.py"):
+                    for filename in tmp_path.rglob("test_*.py"):
                         globals: dict[str, Any] = {}
                         print("run> pytest-inline", filename)
                         exec(

tests/adapter/test_change_types.py

@@ -49,6 +49,8 @@ def test_change():
     Example(code(a, b)).run_inline(
         ["--inline-snapshot=fix,update"],
         changed_files=(
-            {"test_something.py": code(a, code_repr(a))} if code_repr(a) != b else {}
+            {"tests/test_something.py": code(a, code_repr(a))}
+            if code_repr(a) != b
+            else {}
         ),
     )

tests/adapter/test_dataclass.py

@@ -22,7 +22,7 @@ def test_something():
         ["--inline-snapshot=fix"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot,Is
 from dataclasses import dataclass
 
@@ -64,7 +64,7 @@ def test_something():
         ["--inline-snapshot=fix"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot,Is
 from dataclasses import dataclass
 
@@ -102,7 +102,7 @@ def test_something():
         ["--inline-snapshot=update"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot,Is
 from dataclasses import dataclass,field
 
@@ -141,7 +141,7 @@ def test_something():
         ["--inline-snapshot=update"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot,Is
 from dataclasses import dataclass,field
 
@@ -181,7 +181,7 @@ def test_something():
         ["--inline-snapshot=fix"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot,Is
 import attrs
 
@@ -203,7 +203,7 @@ def test_something():
         ["--inline-snapshot=update"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot,Is
 import attrs
 
@@ -241,7 +241,7 @@ def test_something():
         ["--inline-snapshot=fix"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot,Is
 import attrs
 
@@ -277,7 +277,7 @@ def test():
         ["--inline-snapshot=create"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot
 import attrs
 
@@ -403,7 +403,7 @@ def test_something():
         ["--inline-snapshot=fix"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot
 from dataclasses import dataclass
 
@@ -495,7 +495,7 @@ def test_L3():
         ["--inline-snapshot=fix"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot
 
 from inline_snapshot._adapter.generic_call_adapter import GenericCallAdapter,Argument
@@ -557,7 +557,7 @@ def test_tuple():
         ["--inline-snapshot=fix"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot
 from collections import namedtuple
 
@@ -588,7 +588,7 @@ def test_tuple():
         ["--inline-snapshot=fix"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot
 from collections import defaultdict
 
@@ -623,7 +623,7 @@ def test():
         ["--inline-snapshot=create"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot
 from dataclasses import dataclass,field
 
@@ -659,7 +659,7 @@ def test_list():
         ["--inline-snapshot=update"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot,Is
 from dataclasses import dataclass,field
 

tests/adapter/test_dict.py

@@ -16,7 +16,7 @@ def test_list():
         ["--inline-snapshot=update"],
         changed_files=snapshot(
             {
-                "test_something.py": """\
+                "tests/test_something.py": """\
 from inline_snapshot import snapshot,Is
 
 def test_list():