hdiffpatch 0.1.0__tar.gz

hdiffpatch-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright CURRENT_YEAR_HERE YOUR_NAME_HERE
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hdiffpatch-0.1.0/PKG-INFO

@@ -0,0 +1,376 @@
+Metadata-Version: 2.1
+Name: hdiffpatch
+Version: 0.1.0
+Summary: Python wrapper around HDiffPatch C++ library for efficient binary diff/patch operations.
+Home-page: https://github.com/BrianPugh/hdiffpatch-python
+License: Apache-2.0
+Keywords: binary,diff,patch,compression,hdiffpatch,delta,update
+Author: Brian Pugh
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Cython
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Archiving :: Compression
+Classifier: Topic :: Utilities
+Requires-Dist: attrs (>=21.3.0)
+Project-URL: Repository, https://github.com/BrianPugh/hdiffpatch-python
+Description-Content-Type: text/markdown
+
+**hdiffpatch-python** is a Python wrapper around the [HDiffPatch](https://github.com/sisong/HDiffPatch) C++ library, providing binary diff and patch operations with compression support.
+
+<div align="center">
+
+![Python compat](https://img.shields.io/badge/%3E=python-3.9-blue.svg)
+[![PyPi](https://img.shields.io/pypi/v/hdiffpatch-python.svg)](https://pypi.python.org/pypi/hdiffpatch-python)
+[![GHA Status](https://github.com/BrianPugh/hdiffpatch-python/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/BrianPugh/hdiffpatch-python/actions?query=workflow%3Atests)
+[![Coverage](https://codecov.io/github/BrianPugh/hdiffpatch-python/coverage.svg?branch=main)](https://codecov.io/github/BrianPugh/hdiffpatch-python?branch=main)
+
+</div>
+
+## Installation
+
+**hdiffpatch** requires Python `>=3.9` and can be installed via:
+
+```bash
+pip install hdiffpatch
+```
+
+For development installation:
+
+```bash
+git clone https://github.com/BrianPugh/hdiffpatch-python.git
+cd hdiffpatch-python
+poetry install
+```
+
+## Quick Start
+
+**hdiffpatch** primarily provides 2 simple functions:
+
+* `diff` for creating a patch.
+* `apply` for applying a patch.
+
+### Basic Usage
+
+```python
+import hdiffpatch
+
+# Create binary data
+old_data = b"Hello, world!"
+new_data = b"Hello, HDiffPatch!"
+
+# Create a diff
+diff = hdiffpatch.diff(old_data, new_data)
+
+# Apply the diff
+result = hdiffpatch.apply(old_data, diff)
+assert result == new_data
+```
+
+### With Simple Compression
+
+```python
+import hdiffpatch
+
+old_data = b"Large binary data..." * 1000
+new_data = b"Modified binary data..." * 1000
+
+# Create a compressed diff
+diff = hdiffpatch.diff(old_data, new_data, compression="zlib")
+
+# Apply patch
+result = hdiffpatch.apply(old_data, diff)
+assert result == new_data
+```
+
+### With Advanced Compression Configuration
+
+```python
+import hdiffpatch
+
+old_data = b"Large binary data..." * 1000
+new_data = b"Modified binary data..." * 1000
+
+# Use configuration classes for fine-grained control
+config = hdiffpatch.ZlibConfig(level=9, window=12)
+
+diff = hdiffpatch.diff(old_data, new_data, compression=config)
+result = hdiffpatch.apply(old_data, diff)
+assert result == new_data
+```
+
+### Recompressing Diffs
+
+```python
+import hdiffpatch
+
+old_data = b"Large binary data..." * 1000
+new_data = b"Modified binary data..." * 1000
+
+# Create a diff with zlib compression
+diff_zlib = hdiffpatch.diff(old_data, new_data, compression="zlib")
+
+# Recompress the same diff with zstd
+diff_zstd = hdiffpatch.recompress(diff_zlib, compression="zstd")
+
+# Remove compression entirely
+diff_uncompressed = hdiffpatch.recompress(diff_zlib, compression="none")
+
+# Both diffs produce the same result when applied
+result1 = hdiffpatch.apply(old_data, diff_zlib)
+result2 = hdiffpatch.apply(old_data, diff_zstd)
+assert result1 == result2 == new_data
+```
+
+## API Reference
+
+### Core Functions
+
+```python
+def diff(old_data, new_data, compression="none", *, validate=True) -> bytes
+```
+
+Create a binary diff between two byte sequences.
+
+**Parameters:**
+
+* `old_data` (bytes): Original data.
+* `new_data` (bytes): Modified data.
+* `compression` (str or config object): Compression type as string (`"none"`, `"zlib"`, `"lzma"`, `"lzma2"`, `"zstd"`, `"bzip2"`, `"tamp"`) or a compression configuration object.
+* `validate` (bool): Test that the patch successfully converts `old_data` to `new_data`. This is a computationally inexpensive operation. Defaults to `True`.
+
+**Returns:** `bytes` - Binary diff data that can be used with `apply()` and `old_data` to generate `new_data`.
+
+---
+
+```python
+def apply(old_data, diff_data) -> bytes
+```
+
+Apply a binary patch to reconstruct new data.
+
+**Parameters:**
+
+* `old_data` (bytes): Original data.
+* `diff_data` (bytes): Patch data from `diff()`.
+
+**Returns:** `bytes` - Reconstructed data. The `new_data` that was passed to `diff()`.
+
+---
+
+```python
+def recompress(diff_data, compression=None) -> bytes
+```
+
+Recompress a diff with a different compression algorithm.
+
+**Parameters:**
+
+* `diff_data` (bytes): The diff data to recompress.
+* `compression` (str or config object, optional): Target compression type as string (`"none"`, `"zlib"`, `"lzma"`, `"lzma2"`, `"zstd"`, `"bzip2"`, `"tamp"`) or a compression configuration object. If None, removes compression.
+
+**Returns:** `bytes` - The recompressed diff data
+
+### Compression Configuration
+
+For advanced compression control, **hdiffpatch** provides configuration classes for each compression algorithm:
+
+#### ZStdConfig
+
+Fine-grained control over Zstandard compression:
+
+```python
+# Basic configuration
+config = hdiffpatch.ZStdConfig(level=15, window=20, workers=2)
+
+# Preset configurations
+config = hdiffpatch.ZStdConfig.fast()             # Optimized for speed
+config = hdiffpatch.ZStdConfig.balanced()         # Balanced speed/compression
+config = hdiffpatch.ZStdConfig.best_compression() # Maximum compression
+config = hdiffpatch.ZStdConfig.minimal_memory()   # Minimal memory usage
+
+# Use with diff
+diff = hdiffpatch.diff(old_data, new_data, compression=config)
+```
+
+**Parameters:**
+
+* `level` (1-22): Compression level, higher = better compression
+* `window` (10-27): Window size as log2, larger = better compression
+* `workers` (0-200): Number of threads, 0 = single-threaded
+
+#### ZlibConfig
+
+Fine-grained control over zlib compression:
+
+```python
+# Basic configuration
+config = hdiffpatch.ZlibConfig(
+    level=9,
+    memory_level=8,
+    window=15,
+    strategy=hdiffpatch.ZlibStrategy.DEFAULT
+)
+
+# Preset configurations
+config = hdiffpatch.ZlibConfig.fast()
+config = hdiffpatch.ZlibConfig.balanced()
+config = hdiffpatch.ZlibConfig.best_compression()
+config = hdiffpatch.ZlibConfig.minimal_memory()
+config = hdiffpatch.ZlibConfig.png_optimized()    # Optimized for PNG-like data
+```
+
+**Parameters:**
+
+* `level` (0-9): Compression level
+* `memory_level` (1-9): Memory usage level
+* `window` (9-15): Window size as power of 2
+* `strategy`: Compression strategy (`DEFAULT`, `FILTERED`, `HUFFMAN_ONLY`, `RLE`, `FIXED`)
+
+#### LzmaConfig and Lzma2Config
+
+Fine-grained control over LZMA compression:
+
+```python
+# LZMA configuration
+config = hdiffpatch.LzmaConfig(level=9, window=23, thread_num=1)
+
+# LZMA2 configuration (supports more threads)
+config = hdiffpatch.Lzma2Config(level=9, window=23, thread_num=4)
+
+# Preset configurations available for both
+config = hdiffpatch.LzmaConfig.fast()
+config = hdiffpatch.LzmaConfig.balanced()
+config = hdiffpatch.LzmaConfig.best_compression()
+config = hdiffpatch.LzmaConfig.minimal_memory()
+```
+
+**Parameters:**
+
+* `level` (0-9): Compression level
+* `window` (12-30): Window size as log2
+* `thread_num`: Number of threads (1-2 for LZMA, 1-64 for LZMA2)
+
+#### BZip2Config
+
+Fine-grained control over bzip2 compression:
+
+```python
+config = hdiffpatch.BZip2Config(level=9, work_factor=30)
+
+# Preset configurations
+config = hdiffpatch.BZip2Config.fast()
+config = hdiffpatch.BZip2Config.balanced()
+config = hdiffpatch.BZip2Config.best_compression()
+config = hdiffpatch.BZip2Config.minimal_memory()
+```
+
+**Parameters:**
+
+* `level` (1-9): Compression level
+* `work_factor` (0-250): Work factor for worst-case scenarios
+
+#### TampConfig
+
+Fine-grained control over [Tamp](https://github.com/BrianPugh/tamp) compression (embedded-friendly):
+
+```python
+config = hdiffpatch.TampConfig(window=10)
+
+# Preset configurations
+config = hdiffpatch.TampConfig.fast()
+config = hdiffpatch.TampConfig.balanced()
+config = hdiffpatch.TampConfig.best_compression()
+config = hdiffpatch.TampConfig.minimal_memory()
+```
+
+**Parameters:**
+
+* `window` (8-15): Window size as power of 2
+
+### Exceptions
+
+```python
+hdiffpatch.HDiffPatchError
+```
+
+## Compression Performance
+
+Different compression algorithms offer trade-offs between compression ratio and speed:
+
+* **`zlib`**: Good balance of speed and compression. Very common.
+* **`zstd`**: Fast compression with good ratios.
+* **`lzma`/`lzma2`**: Very high compression ratios, slower.
+* **`bzip2`**: Good compression, moderate speed
+* **`tamp`**: Embedded-friendly compression, minimal memory usage.
+
+### Basic Compression Comparison
+
+```python
+import hdiffpatch
+
+# Large repetitive data
+old_data = b"A" * 10000 + b"B" * 10000
+new_data = b"A" * 10000 + b"C" * 10000
+
+# Compare compression effectiveness
+for compression in ["none", "zlib", "zstd", "lzma", "bzip2", "tamp"]:
+    diff = hdiffpatch.diff(old_data, new_data, compression=compression)
+    print(f"{compression}: {len(diff)} bytes")
+```
+
+### Advanced Configuration Comparison
+
+```python
+import hdiffpatch
+
+# Compare different configuration approaches
+configs = {
+    "zstd_fast": hdiffpatch.ZStdConfig.fast(),
+    "zstd_best": hdiffpatch.ZStdConfig.best_compression(),
+    "zlib_balanced": hdiffpatch.ZlibConfig.balanced(),
+    "lzma2_custom": hdiffpatch.Lzma2Config(level=6, window=20, thread_num=4),
+}
+
+for name, config in configs.items():
+    diff = hdiffpatch.diff(old_data, new_data, compression=config)
+    print(f"{name}: {len(diff)} bytes")
+```
+
+### Real-World Example: MicroPython Firmware
+
+Here's a comprehensive comparison using actual MicroPython firmware files with a 12-bit window size (4096 bytes). This window size was chosen because it is typically a good trade-off between memory-usage and compression-performance for embedded targets.
+
+* [RPI_PICO-20241129-v1.24.1.uf2](https://micropython.org/resources/firmware/RPI_PICO-20241129-v1.24.1.uf2): 651 KB
+* [RPI_PICO-20250415-v1.25.0.uf2](https://micropython.org/resources/firmware/RPI_PICO-20250415-v1.25.0.uf2): 652 KB
+
+Since we're using compression for the diff, a natural question would be: "If I'm adding a decompression library to my target project, then how much smaller is the patch compared to just compressing the firmware?"
+To answer this question, we compare the size of the compressed patch to the compressed firmware.
+
+| Algorithm | Size (HDiffPatch) | Size (firmware) | Improvement |
+|-----------|-------------------|-----------------|-------------|
+| none      |          209.7 KB |        652.0 KB | 3.11x |
+| tamp      |          143.1 KB |        322.8 KB | 2.26x |
+| zstd      |          133.4 KB |        277.6 KB | 2.08x |
+| zlib      |          125.5 KB |        251.8 KB | 2.01x |
+| bzip2     |          128.6 KB |        246.2 KB | 1.91x |
+| lzma      |          116.9 KB |        222.7 KB | 1.91x |
+
+In this example, using **hdiffpatch** resulted in a ~3x smaller update when compared to a naive uncompressed firmware update, and ~2x smaller when comparing against an equivalently-compressed firmware update.
+
+To reproduce these results:
+
+```bash
+poetry run python tools/micropython-binary-demo.py
+```
+