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
95
96
97
|
Default configuration:
``` toml
[tool.inline-snapshot]
hash-length=15
default-flags=["report"]
default-flags-tui=["create", "review"]
default-flags-ide=["create", "report"]
format-command=""
show-updates=false
default-storage="uuid"
[tool.inline-snapshot.shortcuts]
review=["review"]
fix=["create","fix"]
```
!!! note
The default flags are different if you use *cpython<3.11* due to [technical limitations](limitations.md#pytest-assert-rewriting-is-disabled):
``` toml
[tool.inline-snapshot]
default-flags=["short-report"]
default-flags-tui=["short-report"]
default-flags-ide=["short-report"]
```
Changing these flags will disable pytest assert rewriting for older python versions.
* **hash-length:** specifies the length of the hash used by `external()` in the code representation.
This does not affect the hash length used to store the data.
The hash should be long enough to avoid hash collisions.
* **default-flags:** defines which flags should be used if there are no flags specified with `--inline-snapshot=...` and *default-flags-ide* or *default-flags-tui* are note used.
You can also use the environment variable `INLINE_SNAPSHOT_DEFAULT_FLAGS=...` to specify the flags and to override those in the configuration file.
* **default-flags-tui:** defines which flags should be used if you run pytest in an interactive terminal.
inline-snapshot creates all snapshots by default in this case and asks when there are values to change.
This feature requires *cpython>=3.11*
* **default-flags-ide:** [(insider only)](insiders.md) defines which flags should be used if you run your tests with the "run test" button in [PyCharm](pycharm.md).
inline-snapshot creates in this case all snapshots by default and reports other changes.
The *review* flag is not supported here because inline-snapshot is not able to read user input.
!!! Danger
You can use `["create","fix"]` if this fits your work flow, but keep in mind that this will change your snapshot values every time you press the "run test" button and you will have to undo these changes if they are incorrect.
What you can do instead is to replace the incorrect values with `...` and run your test again. The change from `...` to the new value is part of the *create* category, which is enabled by default.
* **shortcuts:** allows you to define custom commands to simplify your workflows.
`--fix` and `--review` are defined by default, but this configuration can be changed to fit your needs.
* **storage-dir:** allows you to define the directory where inline-snapshot stores data files such as external snapshots stored with the `hash:` protocol.
By default, it will be `<pytest_config_dir>/.inline-snapshot`,
where `<pytest_config_dir>` is replaced by the directory containing the Pytest configuration file, if any.
External snapshots will be stored in the `external` subfolder of the storage directory.
* **format-command:[](){#format-command}** allows you to specify a custom command which is used to format the python code after code is changed.
=== "ruff format"
``` toml
[tool.inline-snapshot]
format-command="ruff format --stdin-filename {filename}"
```
=== "ruff format & lint"
``` toml
[tool.inline-snapshot]
format-command="ruff check --fix-only --stdin-filename {filename} | ruff format --stdin-filename {filename}"
```
=== "black"
``` toml
[tool.inline-snapshot]
format-command="black --stdin-filename {filename} -"
```
=== "no command (default)"
inline-snapshot will format only the snapshot values with black when you specify no format command, but requires black to be installed with `inline-snapshot[black]`.
The placeholder `{filename}` can be used to specify the filename if it is needed to find the correct formatting options for this file.
!!! important
The command should **not** format the file on disk. The current file content (with the new code changes) is passed to *stdin* and the formatted content should be written to *stdout*.
* **show-updates:**[](){#show-updates} shows updates in reviews and reports.
* **default-storage:**[](){#default-storage} defines the default storage protocol to be used when creating snapshots without an explicit storage protocol, such as `external()`.
Possible values are `hash` and `uuid`.
External snapshots created by `outsource()` do not currently support this setting due to some internal limitations and will always use the old `hash` protocol.
* **test-dir:**[](){#test-dir} can be used to define where your tests are located.
The default is `<pytest_config_dir>/tests` if it exists,
where `<pytest_config_dir>` is replaced by the directory containing the Pytest configuration file, if any.
This directory is used to search through all test files for `external()` calls and to check whether the currently saved external objects are still used in the source.
It is therefore required if you want to *trim* unused externals.
You can also specify a list of folders.
|
