inline-snapshot 0.34.0__tar.gz → 0.34.2__tar.gz

inline_snapshot-0.34.2/AGENTS.md

@@ -0,0 +1,91 @@
+# AGENTS.md
+
+## Project Overview
+
+`inline-snapshot` is a Python snapshot/approval testing library for pytest. Its core feature is storing expected values directly in source code through APIs such as `snapshot()`, `snapshot_arg()`, `external()`, and `outsource()`. The package also ships a pytest plugin that can report, review, create, update, trim, and fix snapshots.
+
+The project supports Python 3.9 through 3.14 and PyPy where possible. CI runs across Linux, macOS, Windows, CPython, PyPy, and both Pydantic 1 and 2 dependency sets.
+
+## Repository Layout
+
+- `src/inline_snapshot/`: package source.
+- `src/inline_snapshot/pytest_plugin.py`: pytest entry point and CLI flag handling.
+- `src/inline_snapshot/_inline_snapshot.py`, `_snapshot_arg.py`, `_get_snapshot_value.py`: main public snapshot behavior.
+- `src/inline_snapshot/_snapshot/`: snapshot value implementations such as equality, dict, min/max, collection, and undecided values.
+- `src/inline_snapshot/_customize/`: code-generation customization support.
+- `src/inline_snapshot/_external/`: external snapshot files, formats, storage, diffing, and outsourcing.
+- `src/inline_snapshot/plugin/`: first-party plugin hook specification and default plugin.
+- `src/inline_snapshot/testing/_example.py`: preferred test harness for new behavior tests.
+- `tests/`: pytest suite. Adapter tests live in `tests/adapter/`; external snapshot tests live in `tests/external/`.
+- `docs/`: MkDocs Material documentation.
+- `changelog.d/`: scriv changelog fragments. Do not edit `CHANGELOG.md` directly.
+- `.github/workflows/ci.yml`: CI matrix and coverage enforcement.
+
+## Development Commands
+
+The project is configured around `uv` and Hatch.
+
+- Install/run ad hoc commands: `uv run --group dev ...`
+- Run the normal test suite: `uv run --group dev pytest`
+- Run a focused test: `uv run --group dev pytest tests/test_file.py::test_name`
+- Run tests with coverage locally: `hatch test -acp`
+- Run the full Hatch test matrix: `hatch test`
+- Run one Hatch Python version with pytest args: `hatch test -py 3.10 -- --sw`
+- Run mypy like CI: `uv run --with pip --group dev -p 3.12 mypy --non-interactive --install-types src/inline_snapshot tests`
+- Build docs strictly: `hatch run docs:build`
+- Serve docs: `hatch run docs:serve`
+- Run pre-commit on all files: `pre-commit run -a`
+
+If dependencies are missing, prefer `uv run --group dev ...` before adding new tooling.
+
+## Testing Guidance
+
+New tests should usually use `inline_snapshot.testing.Example` from `src/inline_snapshot/testing/_example.py`. This is also called out in `CONTRIBUTING.md` as the preferred style.
+
+- Use `Example(...).run_inline(...)` for fast in-process tests of snapshot behavior and source rewrites.
+- Use `Example(...).run_pytest(...)` when behavior depends on the real pytest plugin, assertion rewriting, subprocess execution, terminal output, or pytest reports.
+- Use `snapshot_arg()` in tests when expected values themselves should be snapshot-managed.
+- Many tests compare changed files, report text, stderr, outcomes, or raised exceptions; keep these assertions explicit.
+- CPython-only rewriting tests are skipped on PyPy unless marked with `@pytest.mark.no_rewriting`.
+- The suite has a hard 100% coverage requirement in CI. Add tests with code changes, and use `# pragma: no cover` only for genuinely untestable paths.
+
+Snapshot-changing tests may rewrite files. Review diffs carefully after running tests with update flags such as `--inline-snapshot=create,fix,update,trim` or shortcuts from `[tool.inline-snapshot]`.
+
+## Formatting and Style
+
+- Black and isort are used; isort is configured with `profile = "black"` and `force_single_line = true`.
+- Pre-commit also runs pyupgrade, autoflake, blacken-docs, YAML formatting, actionlint, typos, and pyproject validation.
+- Keep imports in the existing single-import-per-line style.
+- The public API is exported from `src/inline_snapshot/__init__.py`; update `__all__` when adding public symbols.
+- `py.typed` is present, so public typing quality matters.
+
+## Pytest Plugin and Configuration Notes
+
+- The pytest plugin is registered through `[project.entry-points.pytest11]` as `inline_snapshot = "inline_snapshot.pytest_plugin"`.
+- The main CLI option is `--inline-snapshot=` with flags including `disable`, `short-report`, `report`, `review`, `create`, `update`, `trim`, `fix`, and insider-only `fix-assert`.
+- Project configuration is read from `[tool.inline-snapshot]` in `pyproject.toml`.
+- Custom shortcut options may be generated from inline-snapshot config.
+- xdist is detected and affects snapshot session behavior.
+- Assertion rewriting is registered for `inline_snapshot.extra` and `inline_snapshot.testing._example`.
+
+## Documentation
+
+Docs are built with MkDocs Material. The nav and plugins are configured in `mkdocs.yml`.
+
+- Source docs live under `docs/`.
+- The docs build watches `CONTRIBUTING.md`, `CHANGELOG.md`, `README.md`, `src/inline_snapshot`, and `changelog.d`.
+- Use `hatch run docs:build` before touching docs-heavy changes when feasible.
+
+## Changelog and Release Notes
+
+For user-visible changes, create a scriv fragment:
+
+```bash
+uvx scriv create --add
+```
+
+Fill in only the relevant headings in the generated `changelog.d/*.md` file. Do not edit `CHANGELOG.md` manually; it is assembled by `scriv collect`.
+
+## Current Workspace Caution
+
+At the time this file was created, `src/inline_snapshot/_adapter_context.py` already had uncommitted changes. Treat unrelated local modifications as user work and do not revert them.

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/CHANGELOG.md

@@ -1,4 +1,18 @@
 
+<a id='changelog-0.34.2'></a>
+# 0.34.2 — 2026-06-19
+
+## Fixed
+
+- Fixed snapshot updates when pytest reuses stale assertion-rewrite cache files after a test folder is moved, which could leave cached code objects pointing at the old source path ([#369](https://github.com/15r10nk/inline-snapshot/issues/369)).
+
+<a id='changelog-0.34.1'></a>
+# 0.34.1 — 2026-06-05
+
+## Fixed
+
+- Fixed `snapshot_arg()` to use the `fix` category (instead of `create`) when creating an argument with an existing non-ellipsis default argument value.
+
 <a id='changelog-0.34.0'></a>
 # 0.34.0 — 2026-05-29
 

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: inline-snapshot
-Version: 0.34.0
+Version: 0.34.2
 Summary: golden master/snapshot/approval testing library which puts the values right into your source code
 Project-URL: Changelog, https://15r10nk.github.io/inline-snapshot/latest/changelog/
 Project-URL: Discussions, https://github.com/15r10nk/inline-snapshots/discussions
@@ -128,7 +128,7 @@ def test_something():
 The following examples show how you can use inline-snapshot in your tests. Take a look at the
 [documentation](https://15r10nk.github.io/inline-snapshot/latest) if you want to know more.
 
-<!-- inline-snapshot: create fix trim first_block outcome-passed=1 -->
+<!-- inline-snapshot: create fix trim first_block outcome-passed=1 outcome-errors=1 -->
 ``` python
 from inline_snapshot import external, outsource, snapshot
 

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/README.md

@@ -87,7 +87,7 @@ def test_something():
 The following examples show how you can use inline-snapshot in your tests. Take a look at the
 [documentation](https://15r10nk.github.io/inline-snapshot/latest) if you want to know more.
 
-<!-- inline-snapshot: create fix trim first_block outcome-passed=1 -->
+<!-- inline-snapshot: create fix trim first_block outcome-passed=1 outcome-errors=1 -->
 ``` python
 from inline_snapshot import external, outsource, snapshot
 

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/docs/categories.md

@@ -80,7 +80,7 @@ def test_something():
     assert 8 == s["key"]
 ```
 
-<!-- inline-snapshot: fix outcome-passed=1 -->
+<!-- inline-snapshot: fix outcome-passed=1 outcome-errors=1 -->
 ``` python hl_lines="5 7 9 11"
 from inline_snapshot import snapshot
 

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/docs/eq_snapshot.md

@@ -37,7 +37,7 @@ Example:
     ```
 
 === "--inline-snapshot=fix"
-    <!-- inline-snapshot: fix outcome-passed=1 -->
+    <!-- inline-snapshot: fix outcome-passed=1 outcome-errors=1 -->
     ``` python hl_lines="5"
     from inline_snapshot import snapshot
 
@@ -181,7 +181,7 @@ def test_function():
 
 Re-running the test with `--inline-snapshot=fix` will update the snapshot to match the new value of `payload`, while keeping the `date` as a dirty-equals expression:
 
-<!-- inline-snapshot: fix outcome-passed=1 -->
+<!-- inline-snapshot: fix outcome-passed=1 outcome-errors=1 -->
 ``` python hl_lines="17"
 import datetime
 from dirty_equals import IsNow
@@ -277,7 +277,7 @@ The snapshot does not need to be fixed when `current_version` changes in the fut
     ```
 
 === "--inline-snapshot=fix"
-    <!-- inline-snapshot: fix outcome-passed=1 -->
+    <!-- inline-snapshot: fix outcome-passed=1 outcome-errors=1 -->
     ``` python hl_lines="6"
     from inline_snapshot import Is, snapshot
 

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/docs/external/external.md

@@ -73,7 +73,7 @@ def test_something():
     )
 ```
 
-<!-- inline-snapshot: create fix outcome-passed=1 -->
+<!-- inline-snapshot: create fix outcome-passed=1 outcome-errors=1 -->
 ``` python hl_lines="6 7 8 9 10 11 12 13"
 from inline_snapshot import external, snapshot
 

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/docs/index.md

@@ -89,7 +89,7 @@ your code is correct and you want to update your test results.
 
 
 === "--inline-snapshot=fix"
-    <!-- inline-snapshot: fix outcome-passed=1 -->
+    <!-- inline-snapshot: fix outcome-passed=1 outcome-errors=1 -->
     ``` python hl_lines="9"
     from inline_snapshot import snapshot
 

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/docs/plugin.md

@@ -218,7 +218,7 @@ def long_string_handler(value, builder: Builder):
         return builder.create_external(value)
 ```
 
-<!-- inline-snapshot: create fix first_block outcome-passed=1 -->
+<!-- inline-snapshot: create fix first_block outcome-passed=1 outcome-errors=1 -->
 ``` python title="test_long_strings.py"
 from inline_snapshot import external, snapshot
 

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/docs/snapshot_arg.md

@@ -1,4 +1,3 @@
-
 # snapshot_arg(...)
 
 `snapshot_arg` lets you embed snapshot assertions inside a helper function, so callers don't need to pass `snapshot()` at every call site.
@@ -86,10 +85,10 @@ def test_numbers():
 
 2. Asserting this snapshot ensures it gets reset when `expr` stops returning a value.
 
-We are using `None` as the default because we want to omit the argument when its value matches the default. Using `...` would force inline-snapshot to always create it.
-Running with `--inline-snapshot=create` fills in only the arguments whose value differs from the default:
+We are using `None` as the default because we want to omit the argument when its value matches the default.
+Running with `--inline-snapshot=fix` fills in only the arguments whose value differs from the default:
 
-<!-- inline-snapshot: create outcome-passed=1 outcome-errors=1 -->
+<!-- inline-snapshot: fix outcome-passed=1 outcome-errors=1 -->
 ``` python hl_lines="17 18"
 from inline_snapshot import snapshot_arg
 
@@ -140,7 +139,7 @@ def test_prints():
 1. New style — no `snapshot()` needed.
 2. Old style — `snapshot()` is now redundant and can be removed.
 
-<!-- inline-snapshot: create outcome-passed=1 outcome-errors=1 -->
+<!-- inline-snapshot: create fix outcome-passed=1 outcome-errors=1 -->
 ``` python hl_lines="6 9"
 from inline_snapshot import snapshot
 from inline_snapshot.extra import prints

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/docs/testing.md

@@ -27,7 +27,7 @@ def test_a():
 
 Inline-snapshot will then populate the empty snapshots.
 
-<!-- inline-snapshot: create outcome-passed=1 outcome-errors=1 -->
+<!-- inline-snapshot: create fix outcome-passed=1 outcome-errors=1 -->
 ``` python hl_lines="17 18 19 20 21 22 23 24 25 26 27"
 from inline_snapshot import snapshot
 from inline_snapshot.testing import Example

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/src/inline_snapshot/_snapshot_arg.py

@@ -280,13 +280,15 @@ class SnapshotArgReference(SnapshotRefBase):
             if is_default:
                 return
 
-            new_code = yield from with_flag(self._value._new_code(), "create")
+            flag = "create" if self._default_value is ... else "fix"
+
+            new_code = yield from with_flag(self._value._new_code(), flag)
 
             # The first positional argument can be inserted positionally;
             # any later position requires keyword form to avoid leaving gaps.
             if self._arg_pos == 0:
                 yield CallArg(
-                    flag="create",
+                    flag=flag,
                     file=self._value._file,
                     node=self._context.expr.node,
                     arg_pos=0,
@@ -296,7 +298,7 @@ class SnapshotArgReference(SnapshotRefBase):
             else:
 
                 yield CallArg(
-                    flag="create",
+                    flag=flag,
                     file=self._value._file,
                     node=self._context.expr.node,
                     arg_pos=None,

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/src/inline_snapshot/_snapshot_session.py

@@ -17,6 +17,7 @@ from rich.syntax import Syntax
 from inline_snapshot._external._storage import default_storages
 from inline_snapshot._utils import category_link
 from inline_snapshot._utils import link
+from inline_snapshot.fix_pytest_cache import fix_pytest_cache
 
 from . import _config
 from ._change import ChangeBase
@@ -381,6 +382,7 @@ class SnapshotSession:
     def fix_libraries(self):
         pydantic_fix()
         fix_pytest_diff()
+        fix_pytest_cache()
 
     def show_report(self, con: Console):
 

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/src/inline_snapshot/extra.py

@@ -118,9 +118,9 @@ def prints(*, stdout: SnapshotArg[str] = "", stderr: SnapshotArg[str] = ""):
                 print("some error", file=sys.stderr)
         ```
 
-    === "--inline-snapshot=create"
+    === "--inline-snapshot=fix"
 
-        <!-- inline-snapshot: create outcome-passed=1 outcome-errors=1 -->
+        <!-- inline-snapshot: fix outcome-passed=1 outcome-errors=1 -->
         ``` python hl_lines="7"
         import sys
         from inline_snapshot import snapshot
@@ -210,7 +210,7 @@ def warns(
 
     === "--inline-snapshot=create"
 
-        <!-- inline-snapshot: create fix outcome-passed=1 -->
+        <!-- inline-snapshot: create fix outcome-passed=1 outcome-errors=1 -->
         ``` python hl_lines="7"
         from warnings import warn
         from inline_snapshot import snapshot

inline_snapshot-0.34.2/src/inline_snapshot/fix_pytest_cache.py

@@ -0,0 +1,47 @@
+import types
+from pathlib import Path
+from typing import Callable
+from typing import Optional
+
+import _pytest.assertion.rewrite
+
+fixed = False
+
+
+def fix_pytest_cache():
+    # keep this fix until https://github.com/pytest-dev/pytest/pull/14551 is merged
+    global fixed
+
+    if fixed:
+        return
+
+    _original_read_pyc = _pytest.assertion.rewrite._read_pyc
+
+    def _read_pyc(
+        source: Path, pyc: Path, trace: Callable[[str], None] = lambda x: None
+    ) -> Optional[types.CodeType]:
+
+        co = _original_read_pyc(source, pyc, trace)
+
+        if co is not None:
+            source_str = str(source)
+            if co.co_filename != source_str:
+                co = _replace_code_filenames(co, source_str)
+        return co
+
+    _pytest.assertion.rewrite._read_pyc = _read_pyc
+    fixed = True
+
+
+def _replace_code_filenames(co: types.CodeType, filename: str) -> types.CodeType:
+    return co.replace(
+        co_filename=filename,
+        co_consts=tuple(
+            (
+                _replace_code_filenames(const, filename)
+                if isinstance(const, types.CodeType)
+                else const
+            )
+            for const in co.co_consts
+        ),
+    )

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/src/inline_snapshot/version.py

@@ -2,7 +2,7 @@ is_insider = False
 
 insider_version = ""
 
-__version__ = "0.34.0"
+__version__ = "0.34.2"
 
 if is_insider:
     __version__ += "." + insider_version

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/tests/test_docs.py

@@ -431,8 +431,9 @@ uuid.uuid4=f
             )
 
         if "fix" in flags:
-            example.run_pytest(outcomes=(outcomes := Store()))
-            assert "errors" not in outcomes.value
+            next_outcomes: Store[Dict[str, int]]
+            example.run_pytest(outcomes=(next_outcomes := Store()))
+            assert "errors" not in next_outcomes.value
 
         print("flags:", flags, repr(block.block_options))
 
@@ -476,7 +477,7 @@ uuid.uuid4=f
             if changed_lines:
                 block.block_options["hl_lines"] = " ".join(changed_lines)
             else:
-                assert False, "no lines changed"
+                pass  # pragma: no cover
 
         if "first_block" not in options:
             new_code = re.sub(r" *# *\(\d+\)\!?", "", new_code)

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/tests/test_pytest_diff_fix.py

@@ -16,29 +16,29 @@ from inline_snapshot import snapshot,Is
 
 
 def test_dict_report():
-    usd = snapshot({"name": "US Dollar", "code": "USD", "symbol": "$"})
+    usd = snapshot({"code": "USD", "name": "US Dollar",  "symbol": "$"})
     usd2 = Is([1,2])
 
     price = {
         "amount": 1,
+        "b":[1,2],
         "currency": {
             "code": "USD",
             "name": "US Dollar",
             "symbol": "$",
         },
-        "b":[1,2]
     }
 
     assert price == snapshot({
         "amount": 2,
+        "b":usd2,
         "currency": usd,
-        "b":usd2
     })
 """).run_pytest(
         ["--inline-snapshot=report", "-vv"],
         error=snapshot("""\
 >       assert price == snapshot({
-E       AssertionError: assert {'amount': 1, 'currency': {'code': 'USD', 'name': 'US Dollar', 'symbol': '$'}, 'b': [1, 2]} == {'amount': 2, 'currency': {'name': 'US Dollar', 'code': 'USD', 'symbol': '$'}, 'b': [1, 2]}
+E       AssertionError: assert {'amount': 1, 'b': [1, 2], 'currency': {'code': 'USD', 'name': 'US Dollar', 'symbol': '$'}} == {'amount': 2, 'b': [1, 2], 'currency': {'code': 'USD', 'name': 'US Dollar', 'symbol': '$'}}
 E         \n\
 E         Common items:
 E         {'b': [1, 2], 'currency': {'code': 'USD', 'name': 'US Dollar', 'symbol': '$'}}

inline_snapshot-0.34.2/tests/test_pytester.py

@@ -0,0 +1,94 @@
+import shutil
+import sys
+
+from inline_snapshot import snapshot
+from inline_snapshot.testing._example import Example
+
+
+def test_run_pytester():
+    Example(
+        {
+            "conftest.py": """\
+pytest_plugins = ["pytester"]
+""",
+            "test_things.py": """\
+from inline_snapshot import snapshot
+
+def test_not_pytester():
+    assert "hey" == snapshot()
+
+def test_pytester(pytester):
+    pytester.runpytest()
+""",
+        }
+    ).run_pytest(
+        ["--inline-snapshot=create"],
+        changed_files=snapshot({"test_things.py": """\
+from inline_snapshot import snapshot
+
+def test_not_pytester():
+    assert "hey" == snapshot("hey")
+
+def test_pytester(pytester):
+    pytester.runpytest()
+"""}),
+        returncode=1,
+        outcomes={"passed": 2, "errors": 1},
+    ).run_pytest(
+        ["--inline-snapshot=disable"], outcomes={"passed": 2}
+    )
+
+
+def test_pytester_moved_folder_with_stale_pyc(pytester, monkeypatch):
+    monkeypatch.delenv("PYTEST_XDIST_WORKER", raising=False)
+
+    original = pytester.path / "original"
+    moved = pytester.path / "moved"
+    original.mkdir()
+
+    (original / "test_snapshot.py").write_text(
+        """\
+from inline_snapshot import snapshot
+
+
+def test_snapshot():
+    assert "value" == snapshot()
+""",
+        encoding="utf-8",
+    )
+
+    result = pytester.run(
+        sys.executable,
+        "-m",
+        "pytest",
+        "--inline-snapshot=disable",
+        "-q",
+        str(original),
+    )
+
+    assert result.ret == 1
+
+    shutil.move(original, moved)
+
+    result = pytester.run(
+        sys.executable,
+        "-m",
+        "pytest",
+        "--inline-snapshot=create",
+        "-q",
+        str(moved),
+    )
+
+    assert result.ret == 1
+    result.stdout.fnmatch_lines(["*1 passed*"])
+    result.stderr.no_fnmatch_line("*AssertionError:*")
+
+    result = pytester.run(
+        sys.executable,
+        "-m",
+        "pytest",
+        "--inline-snapshot=disable",
+        "-q",
+        str(moved),
+    )
+    assert result.ret == 0

{inline_snapshot-0.34.0 → inline_snapshot-0.34.2}/tests/test_snapshot_arg.py

@@ -57,7 +57,7 @@ def test_a():
     check_value(4)
     check_value(8,8)
 """).run_inline(
-        ["--inline-snapshot=fix,create,trim"],
+        ["--inline-snapshot=fix,trim"],
         changed_files=snapshot({"tests/test_something.py": """\
 from inline_snapshot._snapshot_arg import snapshot_arg
 
@@ -84,7 +84,7 @@ def test_a():
     check_value(4)
     check_value(8,expected=8)
 """).run_inline(
-        ["--inline-snapshot=fix,create,trim"],
+        ["--inline-snapshot=fix,trim"],
         changed_files=snapshot({"tests/test_something.py": """\
 from inline_snapshot._snapshot_arg import snapshot_arg
 

inline_snapshot-0.34.0/tests/test_pytester.py

@@ -1,36 +0,0 @@
-from inline_snapshot import snapshot
-from inline_snapshot.testing._example import Example
-
-
-def test_run_pytester():
-    Example(
-        {
-            "conftest.py": """\
-pytest_plugins = ["pytester"]
-""",
-            "test_things.py": """\
-from inline_snapshot import snapshot
-
-def test_not_pytester():
-    assert "hey" == snapshot()
-
-def test_pytester(pytester):
-    pytester.runpytest()
-""",
-        }
-    ).run_pytest(
-        ["--inline-snapshot=create"],
-        changed_files=snapshot({"test_things.py": """\
-from inline_snapshot import snapshot
-
-def test_not_pytester():
-    assert "hey" == snapshot("hey")
-
-def test_pytester(pytester):
-    pytester.runpytest()
-"""}),
-        returncode=1,
-        outcomes={"passed": 2, "errors": 1},
-    ).run_pytest(
-        ["--inline-snapshot=disable"], outcomes={"passed": 2}
-    )