pytest-ditto-pickle 2.0.0b1__tar.gz

pytest_ditto_pickle-2.0.0b1/.gitignore

@@ -0,0 +1,49 @@
+# tests/ci/.ditto and the root ditto.lock are pytest-ditto's own committed,
+# PR-reviewed baseline (see docs/src/guides/lock-file.md), and each first-party
+# plugin has its own under plugins/<name>/ — everywhere else .ditto/ditto.lock
+# are ephemeral local test-run artifacts.
+.ditto
+!/tests/ci/.ditto/
+!/plugins/*/tests/ci/.ditto/
+ditto.lock
+!/ditto.lock
+!/plugins/*/ditto.lock
+.tmp/
+tmp.py
+ditto-tui.html
+
+# Python
+__pycache__
+# Written by the hatch-vcs build hook on every build and editable install.
+src/ditto/_version.py
+*.egg-info
+*.pyc
+
+# Testing
+.pytest_cache
+.pytest
+.coverage
+.hypothesis
+
+# Linting
+.ruff_cache
+
+# IDE
+.idea/
+.vscode/
+.claude/
+
+# Build artifacts
+dist/
+archive/
+docs/site/
+
+# pixi environments
+.pixi/*
+!.pixi/config.toml
+
+# Dev
+.designs/
+.issues/
+.impl/
+/tests/release/synthetic_plugin/build/

pytest_ditto_pickle-2.0.0b1/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.

pytest_ditto_pickle-2.0.0b1/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,47 @@
+# 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/hatch_build.py

@@ -0,0 +1,30 @@
+"""Add the plugin's requirement on pytest-ditto to its dependencies.
+
+Plugins are released in lockstep with pytest-ditto, from the same git tag, so each
+requires at least the core it was released with: plugin X.Y.Z requires
+``pytest-ditto>=X.Y.Z,<3``. The local segment (``+sha`` on untagged commits) is
+dropped because PEP 440 doesn't allow it in a ``>=`` specifier. ``<3`` is the plugin
+contract's major version.
+
+The plugin's other dependencies are listed under
+``[tool.hatch.metadata.hooks.custom]`` in its ``pyproject.toml``. A wheel built from
+the sdist takes all of them from ``PKG-INFO`` and doesn't run this hook.
+
+Every plugin carries an identical copy of this file, so it ships in each sdist.
+"""
+
+from typing import Any
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+from packaging.version import Version
+
+CORE_MAJOR = 2
+
+
+class CoreFloorHook(MetadataHookInterface):
+    def update(self, metadata: dict[str, Any]) -> None:
+        floor = Version(metadata["version"]).public
+        metadata["dependencies"] = [
+            f"pytest-ditto>={floor},<{CORE_MAJOR + 1}",
+            *self.config.get("dependencies", []),
+        ]

pytest_ditto_pickle-2.0.0b1/pyproject.toml

@@ -0,0 +1,69 @@
+[project]
+name = "pytest-ditto-pickle"
+dynamic = ["version", "dependencies"]
+description = "pytest-ditto plugin for pickle snapshots."
+keywords = ["pytest", "testing", "pickle", "snapshot"]
+authors = [{ name = "Lachlan Taylor", email = "95459213+owlowlyowl@users.noreply.github.com" }]
+maintainers = [{ name = "Lachlan Taylor", email = "95459213+owlowlyowl@users.noreply.github.com" }]
+requires-python = ">=3.12"
+license = "MIT"
+readme = "README.md"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Software Development :: Testing",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/owlowlyowl/pytest-ditto"
+Source = "https://github.com/owlowlyowl/pytest-ditto/tree/main/plugins/pickle"
+
+[project.entry-points.ditto_recorders]
+# Named `pickle` (mark `ditto.pickle`) but persisted with identifier `pkl`,
+# the extension pytest-ditto 1.x used, so 1.x .pkl files load unchanged.
+pickle = "ditto_pickle.recorders:pickle"
+
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[tool.hatch.build]
+targets.wheel.packages = ["src/ditto_pickle"]
+targets.sdist.only-include = ["src", "README.md", "LICENSE", "hatch_build.py"]
+
+# hatch_build.py adds pytest-ditto>=<this version>,<3 to these.
+[tool.hatch.metadata.hooks.custom]
+dependencies = []
+
+# Versioned in lockstep with pytest-ditto, from the same git tag.
+[tool.hatch.version]
+source = "code"
+path = "../../version_builder.py"
+expression = "_version()"
+
+
+[tool.pytest.ini_options]
+minversion = "8.3"
+testpaths = "tests/ci"
+addopts = [
+  "-lv",
+  "--tb=short",
+  "--color=yes",
+  "--code-highlight=yes",
+  "--junit-xml=.pytest/test-results.xml",
+]
+junit_family = "xunit2"
+filterwarnings = [
+    "ignore::DeprecationWarning",
+]

pytest_ditto_pickle-2.0.0b1/src/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)