> pytest test_something.py --inline-snapshot=create,report
│ │ │ ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
│ │ │ pytest: error: unrecognized arguments: --inline-snapshot=create,report
│ │ │ inifile: None
│ │ │ - rootdir: /tmp/tmp.5Pw6Hm4cD2
│ │ │ + rootdir: /tmp/tmp.D5RLo5RW6i
│ │ │
│ │ │ give a short report over which changes can be made to the snapshots
│ │ │> pytest test_something.py --inline-snapshot=short-report
│ │ │ ERROR: usage: __main__.py [options] [file_or_dir] [file_or_dir] [...]
│ │ │ __main__.py: error: unrecognized arguments: --inline-snapshot=short-report
│ │ │ inifile: None
│ │ │ - rootdir: /tmp/tmp.TCnIx7E8as
│ │ │ + rootdir: /tmp/tmp.8NR5g9aFV3
│ │ │
│ │ │ Info
│ │ │short-report exists mainly to show that snapshots have changed with enabled pytest assert-rewriting. │ │ │ This option will be replaced with report when this restriction is lifted.
│ │ │Shows a diff report over which changes can be made to the snapshots
│ │ │> pytest test_something.py --inline-snapshot=report
│ │ │ ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
│ │ │ pytest: error: unrecognized arguments: --inline-snapshot=report
│ │ │ inifile: None
│ │ │ - rootdir: /tmp/tmp.lNOeEheNtB
│ │ │ + rootdir: /tmp/tmp.CEDNqxopCd
│ │ │
│ │ │ Shows a diff report for each category and ask if you want to apply the changes
│ │ │> pytest test_something.py --inline-snapshot=review
│ │ │ ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
│ │ │ pytest: error: unrecognized arguments: --inline-snapshot=review
│ │ │ inifile: None
│ │ │ - rootdir: /tmp/tmp.qzZEZSdx9N
│ │ │ + rootdir: /tmp/tmp.Pw6zC17CKM
│ │ │
│ │ │ Disables all the snapshot logic. snapshot(x) will just return x and inline-snapshot will not be able to fix snapshots or to generate reports.
│ │ │ This can be used if you think that snapshot logic causes a problem in your tests. It is also the default for CI runs.
deprecation
│ │ │ ├── html2text {} │ │ │ │ @@ -86,43 +86,43 @@ │ │ │ │ def test_something(): │ │ │ │ assert 1 == snapshot() │ │ │ │ assert 2 <= snapshot(5) │ │ │ │ > pytest test_something.py --inline-snapshot=create,report │ │ │ │ ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...] │ │ │ │ pytest: error: unrecognized arguments: --inline-snapshot=create,report │ │ │ │ inifile: None │ │ │ │ - rootdir: /tmp/tmp.5Pw6Hm4cD2 │ │ │ │ + rootdir: /tmp/tmp.D5RLo5RW6i │ │ │ │ │ │ │ │ ********** ----iinnlliinnee--ssnnaappsshhoott==sshhoorrtt--rreeppoorrtt_?¶ ********** │ │ │ │ give a short report over which changes can be made to the snapshots │ │ │ │ > pytest test_something.py --inline-snapshot=short-report │ │ │ │ ERROR: usage: __main__.py [options] [file_or_dir] [file_or_dir] [...] │ │ │ │ __main__.py: error: unrecognized arguments: --inline-snapshot=short-report │ │ │ │ inifile: None │ │ │ │ - rootdir: /tmp/tmp.TCnIx7E8as │ │ │ │ + rootdir: /tmp/tmp.8NR5g9aFV3 │ │ │ │ │ │ │ │ Info │ │ │ │ short-report exists mainly to show that snapshots have changed with enabled │ │ │ │ pytest assert-rewriting. This option will be replaced with rreeppoorrtt when this │ │ │ │ restriction is lifted. │ │ │ │ ********** ----iinnlliinnee--ssnnaappsshhoott==rreeppoorrtt_?¶ ********** │ │ │ │ Shows a diff report over which changes can be made to the snapshots │ │ │ │ > pytest test_something.py --inline-snapshot=report │ │ │ │ ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...] │ │ │ │ pytest: error: unrecognized arguments: --inline-snapshot=report │ │ │ │ inifile: None │ │ │ │ - rootdir: /tmp/tmp.lNOeEheNtB │ │ │ │ + rootdir: /tmp/tmp.CEDNqxopCd │ │ │ │ │ │ │ │ ********** ----iinnlliinnee--ssnnaappsshhoott==rreevviieeww_?¶ ********** │ │ │ │ Shows a diff report for each category and ask if you want to apply the changes │ │ │ │ > pytest test_something.py --inline-snapshot=review │ │ │ │ ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...] │ │ │ │ pytest: error: unrecognized arguments: --inline-snapshot=review │ │ │ │ inifile: None │ │ │ │ - rootdir: /tmp/tmp.qzZEZSdx9N │ │ │ │ + rootdir: /tmp/tmp.Pw6zC17CKM │ │ │ │ │ │ │ │ ********** ----iinnlliinnee--ssnnaappsshhoott==ddiissaabbllee_?¶ ********** │ │ │ │ Disables all the snapshot logic. snapshot(x) will just return x and inline- │ │ │ │ snapshot will not be able to fix snapshots or to generate reports. This can be │ │ │ │ used if you think that snapshot logic causes a problem in your tests. It is │ │ │ │ also the default for CI runs. │ │ │ │ deprecation │ │ ├── ./usr/share/doc/python-inline-snapshot-doc/html/search/search_index.json │ │ │ ├── Pretty-printed │ │ │ │┄ Similarity: 0.9994407158836689% │ │ │ │┄ Differences: {"'docs'": "{253: {'text': 'Approve the changes of the given category. These flags can be " │ │ │ │┄ 'combined with report and review.
test_something.pyfrom inline_snapshot '
│ │ │ │┄ 'import snapshot\\n\\n\\ndef test_something():\\n assert 1 == snapshot()\\n '
│ │ │ │┄ 'assert 2 <= snapshot(5)\\n> pytest test_something.py '
│ │ │ │┄ '--inline-snapshot=create,report\\nERROR: usage: pytest [options] [file_or_dir] '
│ │ │ │┄ '[file_or_dir] [...] […]
│ │ │ │ @@ -1272,30 +1272,30 @@
│ │ │ │ {
│ │ │ │ "location": "pytest.html",
│ │ │ │ "text": "inline-snapshot provides one pytest option with different flags (create, fix, trim, update, short-report, report, disable).
Snapshot comparisons return always True if you use one of the flags create, fix or review. This is necessary because the whole test needs to be run to fix all snapshots like in this case:
from inline_snapshot import snapshot\n\n\ndef test_something():\n assert 1 == snapshot(5)\n assert 2 <= snapshot(5)\n
Note
Every flag with the exception of disable and short-report disables the pytest assert-rewriting.
",
│ │ │ │ "title": "pytest integration"
│ │ │ │ },
│ │ │ │ {
│ │ │ │ "location": "pytest.html#-inline-snapshotcreatefixtrimupdate",
│ │ │ │ - "text": "Approve the changes of the given category. These flags can be combined with report and review.
test_something.pyfrom inline_snapshot import snapshot\n\n\ndef test_something():\n assert 1 == snapshot()\n assert 2 <= snapshot(5)\n
> pytest test_something.py --inline-snapshot=create,report\nERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]\npytest: error: unrecognized arguments: --inline-snapshot=create,report\n inifile: None\n rootdir: /tmp/tmp.5Pw6Hm4cD2\n\n
",
│ │ │ │ + "text": "Approve the changes of the given category. These flags can be combined with report and review.
test_something.pyfrom inline_snapshot import snapshot\n\n\ndef test_something():\n assert 1 == snapshot()\n assert 2 <= snapshot(5)\n
> pytest test_something.py --inline-snapshot=create,report\nERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]\npytest: error: unrecognized arguments: --inline-snapshot=create,report\n inifile: None\n rootdir: /tmp/tmp.D5RLo5RW6i\n\n
",
│ │ │ │ "title": "--inline-snapshot=create,fix,trim,update"
│ │ │ │ },
│ │ │ │ {
│ │ │ │ "location": "pytest.html#-inline-snapshotshort-report",
│ │ │ │ - "text": "give a short report over which changes can be made to the snapshots
> pytest test_something.py --inline-snapshot=short-report\nERROR: usage: __main__.py [options] [file_or_dir] [file_or_dir] [...]\n__main__.py: error: unrecognized arguments: --inline-snapshot=short-report\n inifile: None\n rootdir: /tmp/tmp.TCnIx7E8as\n\n
Info
short-report exists mainly to show that snapshots have changed with enabled pytest assert-rewriting. This option will be replaced with report when this restriction is lifted.
",
│ │ │ │ + "text": "give a short report over which changes can be made to the snapshots
> pytest test_something.py --inline-snapshot=short-report\nERROR: usage: __main__.py [options] [file_or_dir] [file_or_dir] [...]\n__main__.py: error: unrecognized arguments: --inline-snapshot=short-report\n inifile: None\n rootdir: /tmp/tmp.8NR5g9aFV3\n\n
Info
short-report exists mainly to show that snapshots have changed with enabled pytest assert-rewriting. This option will be replaced with report when this restriction is lifted.
",
│ │ │ │ "title": "--inline-snapshot=short-report"
│ │ │ │ },
│ │ │ │ {
│ │ │ │ "location": "pytest.html#-inline-snapshotreport",
│ │ │ │ - "text": "Shows a diff report over which changes can be made to the snapshots
> pytest test_something.py --inline-snapshot=report\nERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]\npytest: error: unrecognized arguments: --inline-snapshot=report\n inifile: None\n rootdir: /tmp/tmp.lNOeEheNtB\n\n
",
│ │ │ │ + "text": "Shows a diff report over which changes can be made to the snapshots
> pytest test_something.py --inline-snapshot=report\nERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]\npytest: error: unrecognized arguments: --inline-snapshot=report\n inifile: None\n rootdir: /tmp/tmp.CEDNqxopCd\n\n
",
│ │ │ │ "title": "--inline-snapshot=report"
│ │ │ │ },
│ │ │ │ {
│ │ │ │ "location": "pytest.html#-inline-snapshotreview",
│ │ │ │ - "text": "Shows a diff report for each category and ask if you want to apply the changes
> pytest test_something.py --inline-snapshot=review\nERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]\npytest: error: unrecognized arguments: --inline-snapshot=review\n inifile: None\n rootdir: /tmp/tmp.qzZEZSdx9N\n\n
",
│ │ │ │ + "text": "Shows a diff report for each category and ask if you want to apply the changes
> pytest test_something.py --inline-snapshot=review\nERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]\npytest: error: unrecognized arguments: --inline-snapshot=review\n inifile: None\n rootdir: /tmp/tmp.Pw6zC17CKM\n\n
",
│ │ │ │ "title": "--inline-snapshot=review"
│ │ │ │ },
│ │ │ │ {
│ │ │ │ "location": "pytest.html#-inline-snapshotdisable",
│ │ │ │ "text": "Disables all the snapshot logic. snapshot(x) will just return x and inline-snapshot will not be able to fix snapshots or to generate reports. This can be used if you think that snapshot logic causes a problem in your tests. It is also the default for CI runs.
deprecation
This option was previously called --inline-snapshot-disable
",
│ │ │ │ "title": "--inline-snapshot=disable"
│ │ │ │ },