patchdiff 0.3.7__tar.gz → 0.3.8__tar.gz

{patchdiff-0.3.7 → patchdiff-0.3.8}/.github/workflows/benchmark.yml

@@ -10,18 +10,18 @@ jobs:
     name: Benchmarks
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v7
 
       - name: Set up Python 3.14
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.14"
 
       - name: Install dependencies
-        run: uv sync
+        run: uv sync --group observ
 
       # On PRs: run benchmarks twice (PR code vs master code) and compare
       - name: Run benchmarks
@@ -49,8 +49,8 @@ jobs:
 
       - name: Upload benchmarks
         if: always()
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: Benchmarks
           path: .benchmarks/
-          include-hidden-files: true
+          include-hidden-files: true

patchdiff-0.3.8/.github/workflows/ci.yml

@@ -0,0 +1,103 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - "v*"
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    name: Lint and test on ${{ matrix.name }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Linux py38
+            pyversion: "3.8"
+          - name: Linux py39
+            pyversion: "3.9"
+          - name: Linux py310
+            pyversion: "3.10"
+          - name: Linux py311
+            pyversion: "3.11"
+          - name: Linux py312
+            pyversion: "3.12"
+          - name: Linux py313
+            pyversion: "3.13"
+          - name: Linux py314
+            pyversion: "3.14"
+    steps:
+      - uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Set up Python ${{ matrix.pyversion }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.pyversion }}
+      - name: Install dependencies
+        run: uv sync --group observ
+      - name: Lint
+        run: uv run ruff check
+      - name: Format
+        run: uv run ruff format --check
+      - name: Test
+        run: uv run pytest -v --cov=patchdiff --cov-report=term-missing
+
+  build:
+    name: Build and test wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.9"
+      - name: Install dependencies
+        run: uv sync --group observ
+      - name: Build wheel
+        run: uv build
+      - name: Twine check
+        run: uvx twine check dist/*
+      - name: Upload wheel artifact
+        uses: actions/upload-artifact@v6
+        with:
+          path: dist
+          name: dist
+
+  publish:
+    name: Publish to Github and Pypi
+    runs-on: ubuntu-latest
+    needs: [test, build]
+    if: success() && startsWith(github.ref, 'refs/tags/v')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/patchdiff
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v6
+      - name: Download wheel artifact
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: |
+            dist/*.tar.gz
+            dist/*.whl
+          draft: true
+          prerelease: false
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

{patchdiff-0.3.7 → patchdiff-0.3.8}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: patchdiff
-Version: 0.3.7
+Version: 0.3.8
 Summary: MIT
 Project-URL: Homepage, https://github.com/fork-tongue/patchdiff
 Author-email: Korijn van Golen <korijn@gmail.com>, Berend Klein Haneveld <berendkleinhaneveld@gmail.com>
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 
 [![PyPI version](https://badge.fury.io/py/patchdiff.svg)](https://badge.fury.io/py/patchdiff)
@@ -52,3 +52,54 @@ print(to_json(ops, indent=4))
 #     }
 # ]
 ```
+
+## Proxy-based patch generation
+
+For better performance, `produce()` can be used which generates patches by tracking mutations on a proxy object (inspired by [Immer](https://immerjs.github.io/immer/produce)):
+
+```python
+from patchdiff import produce
+
+base = {"count": 0, "items": [1, 2, 3]}
+
+def recipe(draft):
+    """Mutate the draft object - changes are tracked automatically."""
+    draft["count"] = 5
+    draft["items"].append(4)
+    draft["new_field"] = "hello"
+
+result, patches, reverse_patches = produce(base, recipe)
+
+# base is unchanged (immutable by default)
+assert base == {"count": 0, "items": [1, 2, 3]}
+
+# result contains the changes
+assert result == {"count": 5, "items": [1, 2, 3, 4], "new_field": "hello"}
+
+# patches describe what changed
+print(patches)
+# [
+#     {"op": "replace", "path": "/count", "value": 5},
+#     {"op": "add", "path": "/items/-", "value": 4},
+#     {"op": "add", "path": "/new_field", "value": "hello"}
+# ]
+```
+
+When immutability is not needed, it is possible to apply the ops directly, improving performance even further by not having to make a `deepcopy` of the given state. 
+
+```python
+from observ import reactive
+from patchdiff import produce
+
+state = reactive({"count": 0})
+
+# Mutate in place and get patches for undo/redo
+result, patches, reverse = produce(
+    state, 
+    lambda draft: draft.update({"count": 5}), 
+    in_place=True,
+)
+
+assert result is state  # Same object
+assert state["count"] == 5  # State was mutated, watchers triggered
+```

patchdiff-0.3.8/README.md

@@ -0,0 +1,96 @@
+[![PyPI version](https://badge.fury.io/py/patchdiff.svg)](https://badge.fury.io/py/patchdiff)
+[![CI status](https://github.com/fork-tongue/patchdiff/workflows/CI/badge.svg)](https://github.com/fork-tongue/patchdiff/actions)
+
+# Patchdiff 🔍
+
+Based on [rfc6902](https://github.com/chbrown/rfc6902) this library provides a simple API to generate bi-directional diffs between composite python datastructures composed out of lists, sets, tuples and dicts. The diffs are jsonpatch compliant, and can optionally be serialized to json format. Patchdiff can also be used to apply lists of patches to objects, both in-place or on a deepcopy of the input.
+
+## Install
+
+`pip install patchdiff`
+
+## Quick-start
+
+```python
+from patchdiff import apply, diff, iapply, to_json
+
+input = {"a": [5, 7, 9, {"a", "b", "c"}], "b": 6}
+output = {"a": [5, 2, 9, {"b", "c"}], "b": 6, "c": 7}
+
+ops, reverse_ops = diff(input, output)
+
+assert apply(input, ops) == output
+assert apply(output, reverse_ops) == input
+
+iapply(input, ops)  # apply in-place
+assert input == output
+
+print(to_json(ops, indent=4))
+# [
+#     {
+#         "op": "add",
+#         "path": "/c",
+#         "value": 7
+#     },
+#     {
+#         "op": "replace",
+#         "path": "/a/1",
+#         "value": 2
+#     },
+#     {
+#         "op": "remove",
+#         "path": "/a/3/a"
+#     }
+# ]
+```
+
+## Proxy-based patch generation
+
+For better performance, `produce()` can be used which generates patches by tracking mutations on a proxy object (inspired by [Immer](https://immerjs.github.io/immer/produce)):
+
+```python
+from patchdiff import produce
+
+base = {"count": 0, "items": [1, 2, 3]}
+
+def recipe(draft):
+    """Mutate the draft object - changes are tracked automatically."""
+    draft["count"] = 5
+    draft["items"].append(4)
+    draft["new_field"] = "hello"
+
+result, patches, reverse_patches = produce(base, recipe)
+
+# base is unchanged (immutable by default)
+assert base == {"count": 0, "items": [1, 2, 3]}
+
+# result contains the changes
+assert result == {"count": 5, "items": [1, 2, 3, 4], "new_field": "hello"}
+
+# patches describe what changed
+print(patches)
+# [
+#     {"op": "replace", "path": "/count", "value": 5},
+#     {"op": "add", "path": "/items/-", "value": 4},
+#     {"op": "add", "path": "/new_field", "value": "hello"}
+# ]
+```
+
+When immutability is not needed, it is possible to apply the ops directly, improving performance even further by not having to make a `deepcopy` of the given state. 
+
+```python
+from observ import reactive
+from patchdiff import produce
+
+state = reactive({"count": 0})
+
+# Mutate in place and get patches for undo/redo
+result, patches, reverse = produce(
+    state, 
+    lambda draft: draft.update({"count": 5}), 
+    in_place=True,
+)
+
+assert result is state  # Same object
+assert state["count"] == 5  # State was mutated, watchers triggered
+```