Skip to content

Latest commit

 

History

History
438 lines (273 loc) · 9.89 KB

CHANGELOG.md

File metadata and controls

438 lines (273 loc) · 9.89 KB
Raw

0.18.1 — 2024-12-22

Fixed

  • uv is now only used during test time if you run the inline-snapshot tests with pytest --use-uv This solves a problem if you want to package inline-snapshot in distributions (#165)

0.18.0 — 2024-12-21

Added

  • Support for a new storage-dir configuration option, to tell inline-snapshot where to store data files such as external snapshots.

Fixed

  • pydantic v1 is supported again. pydantic v1 & v2 create now the same snapshots. You can use .dict() to get the same snapshots like in inline-snapshot-0.15.0 for pydantic v1.

    class M(BaseModel):
    name: str


def test_pydantic():
    m = M(name="Tom")
    assert m == snapshot(M(name="Tom"))
    assert m.dict() == snapshot({"name": "Tom"})

  • Find pyproject.toml file in parent directories, not just next to the Pytest configuration file.

0.17.1 — 2024-12-17

Fixed

  • Code generation for sets is now deterministic. 
    def test():
    assert {1j, 2j, 1, 2, 3} == snapshot({1, 1j, 2, 2j, 3})

0.17.0 — 2024-12-14

Added

  • attrs can now contain unmanaged values

    import datetime as dt
import uuid
import attrs
from dirty_equals import IsDatetime
from inline_snapshot import Is, snapshot


@attrs.define
class Attrs:
    ts: dt.datetime
    id: uuid.UUID


def test():
    id = uuid.uuid4()

    assert Attrs(dt.datetime.now(), id) == snapshot(
        Attrs(ts=IsDatetime(), id=Is(id))
    )

0.16.0 — 2024-12-12

Added

  • inline_snapshot.extra.warns to captures warnings and compares them against expected warnings. 
    def test_warns():
    with warns(snapshot([(8, "UserWarning: some problem")]), include_line=True):
        warn("some problem")

0.15.1 — 2024-12-10

Fixed

  • solved a bug caused by a variable inside a snapshot (#148)

0.15.0 — 2024-12-10

Added

  • snapshots inside snapshots are now supported.

    assert get_schema() == snapshot(
    [
        {
            "name": "var_1",
            "type": snapshot("int") if version < 2 else snapshot("string"),
        }
    ]
)

  • runtime values can now be part of snapshots.

    from inline_snapshot import snapshot, Is

current_version = "1.5"
assert request() == snapshot(
    {"data": "page data", "version": Is(current_version)}
)

  • f-strings can now also be used within snapshots, but are currently not fixed by inline-snapshot.

Changed

  • dirty-equals expressions are now treated like runtime values or snapshots within snapshots and are not modified by inline-snapshot.

Fixed

  • inline-snapshot checks now if the given command line flags (--inline-snapshot=...) are valid

  • Example(...).run_pytest(raise=snapshot(...)) uses now the flags from the current run and not the flags from the Example.

0.14.2 — 2024-12-07

Fixed

  • do not crash when handling raw f-strings (rf"",RF"",...) (#143)

0.14.1 — 2024-12-04

Fixed

  • Don't crash for snapshots like snapshot(f"") (#139) It first appeared with pytest-8.3.4, but already existed before for cpython-3.11. f-strings in snapshots are currently not official supported, but they should not lead to crashes.

  • skip formatting if black returns an error (#138)

0.14.0 — 2024-11-10

Removed

  • removed the "Programming Language :: Python :: Implementation :: PyPy" classifier which was incorrect, because inline-snapshot can not fix snapshots on pypy. inline-snapshot now enforces --inline-snapshot=disable when used with an implementation other than cpython, which allows it to be used in packages that want to support pypy.

Added

  • command line shortcuts can be defined to simplify your workflows. --review and --fix are defined by default. See the documentation for details.

Changed

  • --inline-snapshot=create/fix/trim/update will no longer show reports for other categories. You can use --inline-snapshot=create,report if you want to use the old behaviour.

0.13.4 — 2024-11-07

Changed

  • use tomli instead of toml (#130)

0.13.3 — 2024-09-24

Fixed

  • removed non-optional dirty-equals dependency (#118)

0.13.2 — 2024-09-24

Changed

  • star-expressions in list or dicts where never valid and cause a warning now. 
        other=[2]
    assert [5,2]==snapshot([5,*other])

Fixed

  • A snapshot which contains an dirty-equals expression can now be compared multiple times.

    def test_something():
    greeting = "hello"
    for name in ["alex", "bob"]:
        assert (name, greeting) == snapshot((IsString(), "hello"))

v0.13.1 (2024-09-18)

Fix

  • Use tomllib instead of PyPI toml on Python 3.11 and later

v0.13.0 (2024-09-10)

Feat

  • added extra.prints
  • 3.13 support
  • strings with one line-break at the end become no multiline strings

v0.12.1 (2024-08-05)

Fix

  • add license to project metadata and some other fixes in pyproject.toml (#104)

v0.12.0 (2024-07-22)

Feat

  • implement extra.raises
  • added inline_snapshot.testing.Example which can be used to test 3rd-party extensions

v0.11.0 (2024-07-07)

Feat

  • check if the result of copy.deepcopy() is equal to the copied value
  • support for enum.Enum, enum.Flag, type and omitting of default values (#73)

v0.10.2 (2024-05-28)

Fix

  • changed how --inline-snapshot=disable works in combination with xdist (#90)
  • fix typo, rename 'theme' with 'them'

v0.10.1 (2024-05-26)

Fix

  • trigger no update for trailing comma changes

v0.10.0 (2024-05-21)

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

v0.9.0 (2024-05-07)

Feat

  • check if inline-snapshot is used in combination with xdist and notify the user that this is not possible

Fix

  • change the quoting of strings does not trigger an update

v0.8.2 (2024-04-24)

Fix

  • removed restriction that the snapshot functions has to be called snapshot (#72)
  • report error in tear down for sub-snapshots with missing values (#70)
  • element access in sub-snapshots does not create new values

v0.8.1 (2024-04-22)

Fix

  • make typing less strict

v0.8.0 (2024-04-09)

Feat

  • prevent dirty-equal values from triggering of updates
  • fix lists by calculating the alignment of the changed values
  • insert dict items
  • delete dict items
  • preserve not changed dict-values and list-elements

Fix

  • update with UndecidedValue
  • handle dicts with mulitple insertions and deletions
  • handle lists with mulitple insertions and deletions
  • fixed typing and coverage

Refactor

  • removed old needs* logic
  • removed get_result
  • use _get_changes api for DictValue
  • use _get_changes api for CollectionValue
  • use _get_changes api for MinMaxValue
  • use _get_changes
  • moved some functions

v0.7.0 (2024-02-27)

Feat

  • removed old --update-snapshots option

v0.6.1 (2024-01-28)

Fix

  • use utf-8 encoding to read and write source files

v0.6.0 (2023-12-10)

Feat

  • store snapshot values in external files

v0.5.2 (2023-11-13)

Fix

  • remove upper bound from dependencies in pyproject.toml

v0.5.1 (2023-10-20)

Fix

  • show better error messages

v0.5.0 (2023-10-15)

Feat

  • support 3.12

Fix

  • do not change empty snapshot if it is not used

v0.4.0 (2023-09-29)

Feat

  • escaped linebreak at the start/end of multiline strings

Fix

  • added py.typed

v0.3.2 (2023-07-31)

Fix

  • handle update flag in sub-snapshots correctly
  • fixed some edge cases where sub-snapshots had problems with some flags
  • string literal concatenation should trigger no update

v0.3.1 (2023-07-14)

Fix

  • added __all__ to inline_snapshot
  • flags fix/trim/create/update are changing the matching snapshots

v0.3.0 (2023-07-12)

BREAKING CHANGE

  • values have to be copyable with copy.deepcopy

Fix

  • snapshot the current value of mutable objects 
    l = [1]
assert l == snapshot([1])  # old behaviour: snapshot([1, 2])
l.append(2)
assert l == snapshot([1, 2])

v0.2.1 (2023-07-09)

Fix

  • black configuration files are respected

v0.2.0 (2023-06-20)

Feat

  • 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.

  • convert strings with newlines to triple quoted strings

    assert "a\nb\n" == snapshot(
    """a
b
"""
)

  • preserve black formatting

v0.1.2 (2022-12-11)

Fix

  • updated executing

v0.1.1 (2022-12-08)

Fix

  • fixed typo in pytest plugin name

v0.1.0 (2022-07-25)

Feat

  • first inline-snapshot version