What's Changed

• support for enum.Enum, enum.Flag, type and omitting of default values
• feat: customize repr (#73) by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/85

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.10.2...v0.11.0

What's Changed

• fix: changed how --inline-snapshot=disable works in combination with xdist by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/93
• fix: Fix typo, rename theme with them by @patrick91 in https://github.com/15r10nk/inline-snapshot/pull/92
• docs: fix docu generation in ci by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/94

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.10.1...v0.10.2

What's Changed

• fix: trigger no update for trailing comma changes by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/91

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.10.0...v0.10.1

What's Changed

BREAKING CHANGE

• removed support for python 3.7
• removed --inline-snapshot-disable option and replaced it with --inline-snapshot=disable

Feat

• new flags: disable, short-report, report and review
• added config option and environment variable to specify default flags
• show diff of changed snapshots in pytest report
• interactive review mode
• docs: Explain where the external files are saved by @pawamoy in https://github.com/15r10nk/inline-snapshot/pull/74

New Contributors

• @pawamoy made their first contribution in https://github.com/15r10nk/inline-snapshot/pull/74

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.9.0...v0.10.0

What's Changed

• ci: use macos-13 by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/83
• fix: change the quoting of strings does not trigger an update by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/82
• feat: check if inline-snapshot is used in combination with xdist by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/84

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.8.2...v0.9.0

What's Changed

• removed restriction that the snapshot functions has to be called snapshot (#72)
  which allows you to use

  from inline_snapshot import snapshot as snap
  

• report error in tear down for sub-snapshots with missing values (#70)
• element access in sub-snapshots does not create new values

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.8.1...v0.8.2

What's Changed

fixed problems with the typing of the following snapshots:

snapshot([])
snapshot({})

• docs: add pydantic sponsor by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/66
• fix: make typing less strict by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/69

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.8.0...v0.8.1

What's Changed

Snapshot parts can now be replaced by dirty-equals expressions. These parts will not be changed if the user uses --inline-snapshot=fix. This should provide more flexibility if snapshots change frequently for unimportant reasons.

from inline_snapshot import snapshot
from dirty_equals import IsDatetime
import datetime

def get_data():
    return {
        "date": datetime.datetime.utcnow(),
        "payload": "some data",
    }

def test_function():
    assert get_data() == snapshot(
        {
            "date": IsDatetime(),
            "payload": "some data",
        }
    )

Documentation

Thank you to @alexmojaki for the Idea.

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.7.0...v0.8.0

What's Changed

• feat!: removed deprecated --update-snapshots option by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/55

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.6.1...v0.7.0

What's Changed

• fixed windows support (use utf-8 encoding to read and write source files) by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/44

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.6.0...v0.6.1

snapshot values can now be saved in external files:

assert outsource("large string\n" * 1000) == snapshot(external("8bf10bdf2c30*.txt"))

see the documentation for more details

What's Changed

• feat: store snapshot values in external files by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/25

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.5.2...v0.6.0

What's Changed

• fix: remove upper bound from dependencies in pyproject.toml by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/39

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.5.1...v0.5.2

show the user better error messages when he mixes snapshot operations.

def test_something():
    s = snapshot(5)
    assert 5 <= s
    assert 5 == s

>    assert 5 == s
E    TypeError: This snapshot cannot be use with `==`, because it was previously used with `x <= snapshot`

What's Changed

• Design and documentation by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/35
• fix: show better error messages by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/36

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.5.0...v0.5.1

What's Changed

• fix: do not change an empty snapshot if it is not used
• 3.12 support

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.4.0...v0.5.0

Escaped newlines for multiline strings

Multiline strings are now formatted so that the quotes are always on a separate line.

def test_something():
    assert "\nfirst line\nsecond line" == snapshot(
        """\

first line
second line\
"""
    )

What's Changed

• Multiline strings by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/19

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.3.2...v0.4.0

correct handling of flags for sub-snapshots:

from inline_snapshot import snapshot

def test_foo():
    s = snapshot(
        {
            "hello": "world",
            "number": 8,
            "values": ["old value"],          # trim: remove "old value"
        }
    )
    assert "mars" == s["hello"]               # fix:    change "world" to "mars"
    assert 5 <= s["number"]                   # trim:   change 8 to 5
    assert "some output" in s["known output"] # create: add "known output": ["some output"]
    assert "new value" in s["values"]         # fix:    add "new value"

pytest --inline-snapshot=create|fix|trim will apply the changes to the snapshot

every flag implies --inline-snapshot=update

What's Changed

• fix: string literal concatenation should trigger no update by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/23
• fix: fixed edge cases where sub-snapshots had problems with some flags by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/22

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.3.1...v0.3.2

What's Changed

• fix: flags fix/trim/create/update are changing the matching snapshots by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/15

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.3.0...v0.3.1

What's Changed

• docs: added contributing.md by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/10
• fix: snapshot the current value of mutable objects by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/12

BREAKING CHANGE

• values have to be copyable with copy.deepcopy

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.2.1...v0.3.0

What's Changed

• fix: black configuration files are respected by @15r10nk in https://github.com/15r10nk/inline-snapshot/pull/8

Full Changelog: https://github.com/15r10nk/inline-snapshot/compare/v0.2.0...v0.2.1

support for new snapshot operations:

• value <= snapshot() to ensure that something gets smaller/larger over time (number of iterations of an algorithm you want to optimize for example),
• value in snapshot() to check if your value is in a known set of values,
• snapshot()[key] to generate new sub-snapshots on demand.

new features:

• convert strings with newlines to triple quoted strings
• preserve black formatting

more information can be found in the new documentation