Installation
You can install "inline-snapshot" via pip:
pip install inline-snapshot
Key Features
-
support for normal assertions: inline-snapshot can now also fix normal assertions which do not use
snapshot()like:assert 1 + 1 == 3
You can learn here more about this feature.
-
Intuitive Semantics:
snapshot(x)mirrorsxfor easy understanding. -
Versatile Comparison Support: Equipped with
x == snapshot(...),x <= snapshot(...),x in snapshot(...), andsnapshot(...)[key]. -
No CLI arguments required: you will get a nice report where you can review the snapshot changes when you run pytest (only for CPython > 3.11, you have to use --inline-snapshot=review on older versions).
-
Enhanced Control Flags: Utilize various flags for precise control of which snapshots you want to change.
-
Preserved Formatting: Retains formatting consistency with Black formatting or a custom format-command.
-
External File Storage: Store snapshots externally using
external("uuid:eb1167b3-67a9-4378-bc65-c1e582e2e662.json")with support for custom file formats. -
Seamless Pytest Integration: Integrated seamlessly with pytest for effortless testing.
-
Integration into normal functions: use
snapshot_arg()to convert the arguments of your function into snapshots. -
Customizable: code generation can be customized with @customize
-
Nested Snapshot Support: snapshots can contain other snapshots
-
Fuzzy Matching: Incorporate dirty-equals for flexible comparisons within snapshots.
-
Dynamic Snapshot Content: snapshots can contain non-constant values
-
Comprehensive Documentation: Access detailed documentation for complete guidance.
Usage
You can use snapshot() instead of the value which you want to compare with.
from inline_snapshot import snapshot
def test_something():
assert 1548 * 18489 == snapshot()
You can now run the tests and record the correct values.
$ pytest --inline-snapshot=review
from inline_snapshot import snapshot
def test_something():
assert 1548 * 18489 == snapshot(28620972)
The following examples show how you can use inline-snapshot in your tests. Take a look at the documentation if you want to know more.
from inline_snapshot import external, outsource, snapshot
def test_something():
for number in range(5):
# testing for numeric limits
assert number <= snapshot()
assert number >= snapshot()
for c in "hello world":
# test if something is part of a set
assert c in snapshot()
s = snapshot()
for number in range(5):
# create sub-snapshots at runtime
assert s[number]["square"] == number**2
assert s[number]["pow_of_two"] == (
(number & (number - 1) == 0) and number != 0
)
assert outsource("large string\n" * 5) == snapshot()
assert "generates\nmultiline\nstrings" == snapshot()
snapshot_arg() can also be used for function parameters:
import subprocess as sp
import sys
from inline_snapshot import snapshot_arg
def run_python(cmd, stdout="", stderr=""):
result = sp.run([sys.executable, "-c", cmd], capture_output=True)
assert result.stdout.decode() == snapshot_arg(stdout)
assert result.stderr.decode() == snapshot_arg(stderr)
def test_cmd():
run_python("print('hello world')")
run_python("1/0")
Feedback
inline-snapshot provides some advanced ways to work with snapshots.
I would like to know how these features are used to further improve this small library. Let me know if you've found interesting use cases for this library via 𝕏, fosstodon or in the github discussions.
Sponsors
I would like to thank my sponsors. Without them, I would not be able to invest so much time in my projects.
Silver sponsor 🥈
I have also started to offer insider features for inline-snapshot. I will only release features as insider features if they will not cause problems for you when used in an open source project. I hope sponsoring will allow me to spend more time working on open source projects. Thank you for using inline-snapshot, the future will be 🚀.
Issues
If you encounter any problems, please report an issue along with a detailed description.
License
Distributed under the terms of the MIT license, "inline-snapshot" is free and open source software.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file inline_snapshot-0.35.0.tar.gz.
File metadata
- Download URL: inline_snapshot-0.35.0.tar.gz
- Upload date:
- Size: 2.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7351b4692106e970777c54c5e5d264b9406555cfc2619321b8e9a3447eb06361
|
|
| MD5 |
870d95c5ad4abd818b62daa46dc72907
|
|
| BLAKE2b-256 |
cbdbc72dcff365970f7668b1b944138894c794ebc3e39ac338dfd27b6c866ecf
|
Provenance
The following attestation bundles were made for inline_snapshot-0.35.0.tar.gz:
Publisher:
ci.yml on 15r10nk/inline-snapshot
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
inline_snapshot-0.35.0.tar.gz -
Subject digest:
7351b4692106e970777c54c5e5d264b9406555cfc2619321b8e9a3447eb06361 - Sigstore transparency entry: 2174148342
- Sigstore integration time:
-
Permalink:
15r10nk/inline-snapshot@0dd6d93471cbb2ba2cad8d568c47d16b21d60b99 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/15r10nk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@0dd6d93471cbb2ba2cad8d568c47d16b21d60b99 -
Trigger Event:
push
-
Statement type:
File details
Details for the file inline_snapshot-0.35.0-py3-none-any.whl.
File metadata
- Download URL: inline_snapshot-0.35.0-py3-none-any.whl
- Upload date:
- Size: 94.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ef63c1d997d7cd8e5f773fb2ea120144d067899d3c25cf1dbe0f70a0fa206e81
|
|
| MD5 |
0bb5b84005ff90cbf63c5531f293c0b8
|
|
| BLAKE2b-256 |
90037bd4d7dd9749b53565d0e2ced233afa32736a51aaa7fb0be54479bdd83cb
|
Provenance
The following attestation bundles were made for inline_snapshot-0.35.0-py3-none-any.whl:
Publisher:
ci.yml on 15r10nk/inline-snapshot
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
inline_snapshot-0.35.0-py3-none-any.whl -
Subject digest:
ef63c1d997d7cd8e5f773fb2ea120144d067899d3c25cf1dbe0f70a0fa206e81 - Sigstore transparency entry: 2174148364
- Sigstore integration time:
-
Permalink:
15r10nk/inline-snapshot@0dd6d93471cbb2ba2cad8d568c47d16b21d60b99 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/15r10nk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@0dd6d93471cbb2ba2cad8d568c47d16b21d60b99 -
Trigger Event:
push
-
Statement type:
