1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
## General
!!! info
This feature is currently under development. See this [issue](https://github.com/15r10nk/inline-snapshot/issues/86) for more information.
Storing snapshots in the source code is the main feature of inline snapshots.
This has the advantage that you can easily see changes in code reviews. But it also has some problems:
* It is problematic to snapshot a lot of data, because it takes up a lot of space in your tests.
* Binary data or images are not readable in your tests.
The `outsource()` function solves this problem and integrates itself nicely with the inline snapshot.
It stores the data in a special `external()` object that can be compared in snapshots.
The object is represented by the hash of the data.
The actual data is stored in a separate file in your project.
This allows the test to be renamed and moved around in your code without losing the connection to the stored data.
Example:
=== "original code"
<!-- inline-snapshot: first_block outcome-passed=1 outcome-errors=1 -->
``` python
from inline_snapshot import snapshot, outsource
def test_something():
assert outsource("long text\n" * 1000) == snapshot()
```
=== "--inline-snapshot=create"
<!-- inline-snapshot: create outcome-passed=1 outcome-errors=1 -->
``` python hl_lines="3 4 7 8 9"
from inline_snapshot import snapshot, outsource
from inline_snapshot import external
def test_something():
assert outsource("long text\n" * 1000) == snapshot(
external("f5a956460453*.txt")
)
```
The `external` object can be used inside other data structures.
=== "original code"
<!-- inline-snapshot: first_block outcome-passed=1 outcome-errors=1 -->
``` python
from inline_snapshot import snapshot, outsource
def test_something():
assert [
outsource("long text\n" * times) for times in [50, 100, 1000]
] == snapshot()
```
=== "--inline-snapshot=create"
<!-- inline-snapshot: create outcome-passed=1 outcome-errors=1 -->
``` python hl_lines="3 4 9 10 11 12 13 14 15"
from inline_snapshot import snapshot, outsource
from inline_snapshot import external
def test_something():
assert [
outsource("long text\n" * times) for times in [50, 100, 1000]
] == snapshot(
[
external("362ad8374ed6*.txt"),
external("5755afea3f8d*.txt"),
external("f5a956460453*.txt"),
]
)
```
## API
::: inline_snapshot.outsource
options:
show_root_heading: true
::: inline_snapshot.external
options:
show_root_heading: true
## pytest options
It interacts with the following `--inline-snapshot` flags:
- `trim` removes every snapshots form the storage which is not referenced with `external(...)` in the code.
|
