pytest-ditto-pickle 2.0.0b1__py3-none-any.whl

ditto_pickle/recorders.py

@@ -0,0 +1,28 @@
+"""The pickle recorder.
+
+Loading pickle data can execute arbitrary code. Only load snapshots you trust.
+"""
+
+import pickle as _pickle
+from pathlib import Path
+from typing import Any
+
+from ditto.recorders import Recorder
+
+
+__all__ = ("pickle",)
+
+
+def _save(data: Any, filepath: Path) -> None:
+    with open(filepath, "wb") as f:
+        _pickle.dump(data, f)
+
+
+def _load(filepath: Path) -> Any:
+    with open(filepath, "rb") as f:
+        return _pickle.load(f)
+
+
+# The identifier is `pkl`, not the recorder's name, `pickle`: it is the file
+# extension pytest-ditto 1.x used, so 1.x snapshots keep loading.
+pickle: Recorder[Any] = Recorder(identifier="pkl", save=_save, load=_load)

pytest_ditto_pickle-2.0.0b1.dist-info/METADATA

@@ -0,0 +1,74 @@
+Metadata-Version: 2.5
+Name: pytest-ditto-pickle
+Version: 2.0.0b1
+Summary: pytest-ditto plugin for pickle snapshots.
+Project-URL: Homepage, https://github.com/owlowlyowl/pytest-ditto
+Project-URL: Source, https://github.com/owlowlyowl/pytest-ditto/tree/main/plugins/pickle
+Author-email: Lachlan Taylor <95459213+owlowlyowl@users.noreply.github.com>
+Maintainer-email: Lachlan Taylor <95459213+owlowlyowl@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: pickle,pytest,snapshot,testing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.12
+Requires-Dist: pytest-ditto<3,>=2.0.0b1
+Description-Content-Type: text/markdown
+
+# pytest-ditto-pickle
+
+Extension plugin for [`pytest-ditto`](https://github.com/owlowlyowl/pytest-ditto) that records snapshots with Python's `pickle`.
+
+> [!WARNING]
+> Loading pickle data can execute arbitrary code. Only load snapshots you
+> trust, and never load a `.pkl` snapshot from an untrusted source, such as a
+> pull request from someone you don't know. Review changes to `.pkl` files as
+> carefully as changes to code.
+
+pytest-ditto records snapshots as strict JSON by default. Use pickle only when
+a value can't be represented in JSON, or YAML, or one of the other recorders,
+and you accept the risk above.
+
+## Installation
+```bash
+pip install pytest-ditto-pickle
+```
+
+pytest-ditto has no `pickle` extra: install this package by name, deliberately.
+
+## Usage
+
+Select the recorder explicitly on each test, with `@ditto.pickle` or its
+long form, `@ditto.record("pickle")`:
+
+```python
+import datetime
+
+import ditto
+
+
+@ditto.pickle
+def test_schedule(snapshot):
+    schedule = {"days": {"mon", "wed"}, "start": datetime.time(9, 30)}
+    assert snapshot(schedule, key="schedule") == schedule
+```
+
+## Snapshots from pytest-ditto 1.x
+
+pytest-ditto 1.x used pickle by default and saved snapshots with the `.pkl`
+extension. This recorder keeps that extension and file format, so a 1.x
+`.pkl` file loads unchanged.
+
+pytest-ditto 2.0 names snapshot files differently, though, so 2.0 won't find a
+1.x file where 1.x left it. See the pytest-ditto upgrade guide for the new
+names.

pytest_ditto_pickle-2.0.0b1.dist-info/RECORD

@@ -0,0 +1,7 @@
+ditto_pickle/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ditto_pickle/recorders.py,sha256=ELSAI3DdL0U-clZ5xyzAsEccMPDAx89J2hqslP2MHvc,681
+pytest_ditto_pickle-2.0.0b1.dist-info/METADATA,sha256=JjKSyrFO-_ddk_HSj8UuAJiBrU_7iDovTWYksVdxZPw,2678
+pytest_ditto_pickle-2.0.0b1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+pytest_ditto_pickle-2.0.0b1.dist-info/entry_points.txt,sha256=fQvD1D-TFeLZwHRQJ636MZBTcoO7rm2CXTsqXi3-zuQ,57
+pytest_ditto_pickle-2.0.0b1.dist-info/licenses/LICENSE,sha256=Dllo6ok5zVKUEUmEVqsGbGwBoDYtBpQY_e2mxW1qrvQ,1069
+pytest_ditto_pickle-2.0.0b1.dist-info/RECORD,,

pytest_ditto_pickle-2.0.0b1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

pytest_ditto_pickle-2.0.0b1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[ditto_recorders]
+pickle = ditto_pickle.recorders:pickle

pytest_ditto_pickle-2.0.0b1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 pytest-ditto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.