Issue when parsing explicit tuples for trimming

[pawamoy]

The snapshots, once created, will contain explicit tuples with a single element. It looks like inline-snapshot has trouble parsing them when trimming, because it removes too much code, leaving the test module in a broken state.

import pytest

from inline_snapshot import snapshot, outsource, external

options = {
    "very_very_very_long_option_name": ["value1", "value2"],
    "another_super_extra_long_option_name": [True, False, None],
}


@pytest.mark.parametrize("option1", options["options1"])
@pytest.mark.parametrize("option2", options["options2"])
def test_combinations(option1, option2):
    final_options = {"option1": option1, "option2": option2}
    result = "whatever, not important here"
    assert outsource(result) == snapshot(tuple(final_options.items()))

Run pytest --inline-snapshot=create. The snapshots will look something like this:

snapshots = snapshot(
    {(
            ("very_very_very_long_option_name", "value1"),
            ("another_super_extra_long_option_name", True),
        ): external("36a1a03a6364*.html"), (
            ("very_very_very_long_option_name", "value1"),
            ("another_super_extra_long_option_name", False),
        ): external("bd14e6a60af2*.html"), (
            ("very_very_very_long_option_name", "value1"),
            ("another_super_extra_long_option_name", None),
        ): external("d552c9951139*.html"), (
            ("very_very_very_long_option_name", "value2"),
            ("another_super_extra_long_option_name", True),
        ): external("36a1a03a6364*.html"), (
            ("very_very_very_long_option_name", "value2"),
            ("another_super_extra_long_option_name", False),
        ): external("bd14e6a60af2*.html"), (
            ("very_very_very_long_option_name", "value2"),
            ("another_super_extra_long_option_name", None),
        ): external("d552c9951139*.html")},
)

Optionally format the test module with ruff, and run pytest --inline-snaphost=trim.

It leaves me with something like this in my own test module:

snapshots = snapshot({(
    ("annotations_path", "brief"),
    ("show_signature", True),
    ("show_signature_annotations", False),
    ("signature_crossrefs", True),
    ("separate_signature", True),
    ("unwrap_annotated", False),
): external("c7fb0a797254*.html"), urce", options["show_source"])
# @pytest.mark.parametrize("preload_modules", options["preload_modules"])
# Heading options.
# @pytest.mark.parametrize("heading_level", options["heading_level"])
# @pytest.mark.parametrize("show_root_heading", options["show_root_heading"])
# @pytest.mark.parametrize("show_root_toc_entry", options["show_root_toc_entry"])
# @pytest.mark.parametrize("show_root_full_path", options["show_root_full_path"])
# @pytest.mark.parametrize("show_, eme's templates.

    Parameters:
        identifier: Parametrized identifier.
        handler: Python handler (fixture).
    """
    final_options = {**locals()}
    final_options.pop("handler")
,  for k, v in final_options.items())
        assert outsource(html, suffix=".html") == snapshots[snapshot_key]

, , , , , 

I'll try to create a proper reproduction a bit later.

[pawamoy]

Hmmm I'm actually seeing other issues:

• broken syntax even when creating snapshots

...
    ("unwrap_annotated", False),
): external("011c334b854b*.html")}{(  # <-- closing and reopening dict? happens both on python 3.8 and 3.10
    ("annotations_path", "brief"),
...

• always telling that values are missing and to create snapshots (sorted my tuples but no luck)

[pawamoy]

If you want to try it in my own repo:

git clone https://github.com/mkdocstrings/python
git checkout end-to-end-tests
make setup  # install dependencies in venvs (needs uv, install with pipx)

# then you can activate the venv of your choice to test
. .venvs/3.8/bin/activate

# and run the tests
duty test match=end_to_end snapshot=create

# at this point, possible syntax error, try fixing it
# run tests again
duty test match=end_to_end  # probably telling values are missing

# try trimming
duty test match=end_to_end snapshot=trim  # probably breaking syntax

For reference: mkdocstrings/python#157.

[15r10nk]

Uhh, I think I know the problem. The code range of a tuple ast node does not include the braces. I think this breaks some internal logic in inline-snapshot.

[15r10nk]

no, this is not the problem. Can you remove -n auto from your pytest invocation if you use inline-snapshot.

    args = [f"--inline-snapshot={snapshot}"] if snapshot else []

    if not snapshot:
        args+=["-n","auto"]

    ctx.run(
        pytest.run(*args, "tests", config_file="config/pytest.ini", select=match, color="yes"),
        title=pyprefix("Running tests"),
        command=f"pytest -c config/pytest.ini -n auto -k{match!r} --color=yes tests",
    )

this should solve your problem. I don't know if it is possible to use inline-snapshot with xdist but I will notify the user if he tries to.

[pawamoy]

Oh damn, yes, it felt like race conditions but I didn't think about pytest-xdist! Good catch. I'll do what you suggest and disable it when inline snapshot modifies files 👍

[pawamoy]

OK, it's working. So sorry for this bad tendency I have to open invalid issues on your repositories 🙇

[15r10nk]

nothing to sorry about. I'm currently implementing a check for xdist which should save everyone after you from this mistake.