accordsync-core 0.3.0__tar.gz

accordsync_core-0.3.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+/interop/node/node_modules/

accordsync_core-0.3.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

accordsync_core-0.3.0/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.5
+Name: accordsync-core
+Version: 0.3.0
+Summary: Accord's merge core: hybrid logical clocks, operations, lww, counter, set and conflict.
+Project-URL: Homepage, https://accord.benhattab.pro
+Project-URL: Source, https://github.com/crossben/accordsync-python
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: crdt,local-first,offline-first,sync
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# accordsync-core
+
+**Accord's merge core for Python: hybrid logical clocks, operations and the four merge strategies.**
+
+Pure Python, no I/O, no dependencies. Most programs use the client
+[`accordsync`](https://pypi.org/project/accordsync/) or the server
+[`accordsync-server`](https://pypi.org/project/accordsync-server/), which depend on it. Python 3.11+.
+
+```sh
+pip install accordsync-core
+```
+
+| Strategy | Merges by |
+| --- | --- |
+| `lww()` | Highest hybrid logical clock wins. |
+| `counter()` | Sum of every increment; none is ever lost. |
+| `set_()` | Add-wins set: a remove only removes what its writer had seen. |
+| `conflict()` | Concurrent values are all kept and the field is flagged; a resolution supersedes exactly the values its writer saw. |
+
+`set_()` has a trailing underscore so it does not shadow Python's `set`.
+
+```python
+import time
+
+from accordsync_core import LocalWriter, conflict, counter, define_schema
+
+schema = define_schema({"dossier": {"visits": counter(), "status": conflict()}})
+
+
+def now() -> int:
+    return time.time_ns() // 1_000_000
+
+
+a = LocalWriter(schema, "phone-a", now)
+b = LocalWriter(schema, "phone-b", now)
+
+# Each device writes offline...
+from_a = [a.inc("dossier:1", "visits", 1), a.assign("dossier:1", "status", "approved")]
+from_b = [b.inc("dossier:1", "visits", 2), b.assign("dossier:1", "status", "rejected")]
+
+# ...then they exchange ops, in any order, as often as the network repeats them.
+for op in from_b + from_b:
+    a.receive(op)
+for op in reversed(from_a):
+    b.receive(op)
+
+assert a.replica.snapshot() == b.replica.snapshot()
+print(a.replica.read("dossier:1"))
+# {'visits': 3, 'status': {'conflicted': [{'value': 'approved', 'opId': 'phone-a:2'},
+#                                         {'value': 'rejected', 'opId': 'phone-b:2'}]}}
+```
+
+It merges byte for byte like [`@accordsync/core`](https://www.npmjs.com/package/@accordsync/core):
+the test suite runs the shared golden vectors in every delivery order, and random scenarios
+generated by the TypeScript core must produce identical snapshots here.
+
+Docs: [accord.benhattab.pro/docs/schema](https://accord.benhattab.pro/docs/schema/) ·
+Source: [crossben/accordsync-python](https://github.com/crossben/accordsync-python) · Licence: Apache-2.0

accordsync_core-0.3.0/README.md

@@ -0,0 +1,58 @@
+# accordsync-core
+
+**Accord's merge core for Python: hybrid logical clocks, operations and the four merge strategies.**
+
+Pure Python, no I/O, no dependencies. Most programs use the client
+[`accordsync`](https://pypi.org/project/accordsync/) or the server
+[`accordsync-server`](https://pypi.org/project/accordsync-server/), which depend on it. Python 3.11+.
+
+```sh
+pip install accordsync-core
+```
+
+| Strategy | Merges by |
+| --- | --- |
+| `lww()` | Highest hybrid logical clock wins. |
+| `counter()` | Sum of every increment; none is ever lost. |
+| `set_()` | Add-wins set: a remove only removes what its writer had seen. |
+| `conflict()` | Concurrent values are all kept and the field is flagged; a resolution supersedes exactly the values its writer saw. |
+
+`set_()` has a trailing underscore so it does not shadow Python's `set`.
+
+```python
+import time
+
+from accordsync_core import LocalWriter, conflict, counter, define_schema
+
+schema = define_schema({"dossier": {"visits": counter(), "status": conflict()}})
+
+
+def now() -> int:
+    return time.time_ns() // 1_000_000
+
+
+a = LocalWriter(schema, "phone-a", now)
+b = LocalWriter(schema, "phone-b", now)
+
+# Each device writes offline...
+from_a = [a.inc("dossier:1", "visits", 1), a.assign("dossier:1", "status", "approved")]
+from_b = [b.inc("dossier:1", "visits", 2), b.assign("dossier:1", "status", "rejected")]
+
+# ...then they exchange ops, in any order, as often as the network repeats them.
+for op in from_b + from_b:
+    a.receive(op)
+for op in reversed(from_a):
+    b.receive(op)
+
+assert a.replica.snapshot() == b.replica.snapshot()
+print(a.replica.read("dossier:1"))
+# {'visits': 3, 'status': {'conflicted': [{'value': 'approved', 'opId': 'phone-a:2'},
+#                                         {'value': 'rejected', 'opId': 'phone-b:2'}]}}
+```
+
+It merges byte for byte like [`@accordsync/core`](https://www.npmjs.com/package/@accordsync/core):
+the test suite runs the shared golden vectors in every delivery order, and random scenarios
+generated by the TypeScript core must produce identical snapshots here.
+
+Docs: [accord.benhattab.pro/docs/schema](https://accord.benhattab.pro/docs/schema/) ·
+Source: [crossben/accordsync-python](https://github.com/crossben/accordsync-python) · Licence: Apache-2.0

accordsync_core-0.3.0/pyproject.toml

@@ -0,0 +1,30 @@
+[project]
+name = "accordsync-core"
+version = "0.3.0"
+description = "Accord's merge core: hybrid logical clocks, operations, lww, counter, set and conflict."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+keywords = ["offline-first", "sync", "crdt", "local-first"]
+dependencies = [
+]
+
+[project.urls]
+Homepage = "https://accord.benhattab.pro"
+Source = "https://github.com/crossben/accordsync-python"
+
+[build-system]
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/accordsync_core"]
+
+[tool.ruff]
+extend = "../../pyproject.toml"
+src = ["src", "tests"]
+
+[tool.ruff.lint.per-file-ignores]
+# Seeded generators are the point of the law and vector tests; the awkward characters are on purpose.
+"tests/**" = ["S311", "RUF001"]

accordsync_core-0.3.0/src/accordsync_core/__init__.py

@@ -0,0 +1,90 @@
+"""Accord's merge core: hybrid logical clocks, operations and the four merge strategies."""
+
+from .canonical import canonical_json
+from .errors import AccordError, ClockSkewError
+from .hlc import MAX_COUNTER, MAX_SAFE_INTEGER, Hlc, assert_node, compare_hlc
+from .op import (
+    AddOp,
+    AssignOp,
+    IncOp,
+    JsonValue,
+    Op,
+    OpId,
+    OpKind,
+    ParsedOpId,
+    RemoveOp,
+    SetElement,
+    compare_op_ids,
+    parse_op_id,
+    record_type,
+)
+from .replica import ApplyResult, FieldRef, RecordSnapshot, Replica
+from .schema import (
+    KINDS,
+    RecordFields,
+    Schema,
+    Strategy,
+    StrategyName,
+    conflict,
+    counter,
+    define_schema,
+    fields_of,
+    lww,
+    set_,
+    strategy_for,
+)
+from .strategies import ABSENT, FieldSnapshot
+from .wire import WireOp, decode_op, encode_op
+from .writer import DEFAULT_MAX_SKEW_MS, LocalWriter
+
+PROTOCOL_VERSION = 1
+"""The Accord sync protocol this package speaks (docs/protocol.md in the Accord repository).
+A breaking change to the wire format bumps it."""
+
+__all__ = [
+    "ABSENT",
+    "DEFAULT_MAX_SKEW_MS",
+    "KINDS",
+    "MAX_COUNTER",
+    "MAX_SAFE_INTEGER",
+    "PROTOCOL_VERSION",
+    "AccordError",
+    "AddOp",
+    "ApplyResult",
+    "AssignOp",
+    "ClockSkewError",
+    "FieldRef",
+    "FieldSnapshot",
+    "Hlc",
+    "IncOp",
+    "JsonValue",
+    "LocalWriter",
+    "Op",
+    "OpId",
+    "OpKind",
+    "ParsedOpId",
+    "RecordFields",
+    "RecordSnapshot",
+    "RemoveOp",
+    "Replica",
+    "Schema",
+    "SetElement",
+    "Strategy",
+    "StrategyName",
+    "WireOp",
+    "assert_node",
+    "canonical_json",
+    "compare_hlc",
+    "compare_op_ids",
+    "conflict",
+    "counter",
+    "decode_op",
+    "define_schema",
+    "encode_op",
+    "fields_of",
+    "lww",
+    "parse_op_id",
+    "record_type",
+    "set_",
+    "strategy_for",
+]

accordsync_core-0.3.0/src/accordsync_core/_text.py

@@ -0,0 +1,15 @@
+"""String helpers that make Python strings behave like JavaScript's UTF-16 strings."""
+
+
+def utf16_key(s: str) -> bytes:
+    """Sort key giving JavaScript's `a < b` order: by UTF-16 code unit, not by code point.
+
+    The two differ for characters above U+FFFF (surrogate pairs, 0xD800...) against U+E000-U+FFFF.
+    `surrogatepass` keeps lone surrogates, which JSON may carry and JavaScript strings may hold.
+    """
+    return s.encode("utf-16-be", "surrogatepass")
+
+
+def utf16_len(s: str) -> int:
+    """`s.length` in JavaScript: the number of UTF-16 code units."""
+    return len(utf16_key(s)) // 2

accordsync_core-0.3.0/src/accordsync_core/canonical.py

@@ -0,0 +1,122 @@
+"""Canonical JSON, byte for byte what the TypeScript core's `canonicalJson` prints.
+
+That is `JSON.stringify` of objects built from code-unit-sorted keys, so this reproduces
+JavaScript rather than Python's `json` module:
+- keys that are array indices ("0".."4294967294", no leading zeros) come first in numeric order,
+  because JavaScript objects always order them that way; the others follow by UTF-16 code unit;
+- numbers print as JavaScript prints them: `1` not `1.0`, `0` for `-0.0`, `1e-7`, `1e+21`;
+- strings escape exactly like `JSON.stringify` (lone surrogates as `\\udXXX`, the rest raw).
+"""
+
+import math
+import re
+from collections.abc import Iterable, Mapping
+from decimal import Decimal
+
+from ._text import utf16_key
+
+MAX_ARRAY_INDEX = 4294967294
+_ARRAY_INDEX = re.compile(r"0|[1-9][0-9]*")
+_SHORT_ESCAPES = {'"': '\\"', "\\": "\\\\", "\b": "\\b", "\f": "\\f", "\n": "\\n", "\r": "\\r"}
+_SHORT_ESCAPES["\t"] = "\\t"
+
+
+def canonical_json(value: object) -> str:
+    out: list[str] = []
+    _write(out, value)
+    return "".join(out)
+
+
+def _write(out: list[str], value: object) -> None:
+    # `bool` first: it is a subclass of `int`.
+    if value is None:
+        out.append("null")
+    elif type(value) is bool:
+        out.append("true" if value else "false")
+    elif isinstance(value, int | float):
+        out.append(js_number(value))
+    elif isinstance(value, str):
+        out.append(js_string(value))
+    elif isinstance(value, list | tuple):
+        out.append("[")
+        for i, v in enumerate(value):
+            if i:
+                out.append(",")
+            _write(out, v)
+        out.append("]")
+    elif isinstance(value, Mapping):
+        out.append("{")
+        for i, k in enumerate(js_key_order(value.keys())):
+            if i:
+                out.append(",")
+            out.append(js_string(k))
+            out.append(":")
+            _write(out, value[k])
+        out.append("}")
+    else:
+        raise TypeError(f"canonical_json: not a JSON value: {type(value).__name__}")
+
+
+def js_key_order(keys: Iterable[object]) -> list[str]:
+    """The order JavaScript gives the keys of an object built from code-unit-sorted entries."""
+    indices: list[str] = []
+    others: list[str] = []
+    for k in keys:
+        if not isinstance(k, str):
+            raise TypeError(f"canonical_json: object keys must be strings, got {k!r}")
+        if _ARRAY_INDEX.fullmatch(k) and int(k) <= MAX_ARRAY_INDEX:
+            indices.append(k)
+        else:
+            others.append(k)
+    indices.sort(key=int)
+    others.sort(key=utf16_key)
+    return indices + others
+
+
+def js_number(n: int | float) -> str:
+    """A number as JavaScript's `String(n)` / `JSON.stringify` prints it."""
+    if isinstance(n, int):
+        # JavaScript numbers are doubles: an integer past 2^53 prints as the double it rounds to.
+        if abs(n) <= 2**53:
+            return str(n)
+        n = float(n)
+    if not math.isfinite(n):
+        return "null"
+    if n == 0:
+        return "0"  # also -0.0
+    sign = "-" if n < 0 else ""
+    # repr gives the shortest digits that round-trip, as JavaScript does; only the layout differs.
+    # The value is 0.DIGITS x 10^point (the k digits and n of ECMAScript's Number::toString).
+    t = Decimal(repr(abs(n))).normalize().as_tuple()
+    digits = "".join(map(str, t.digits))
+    point = len(digits) + int(t.exponent)
+    k = len(digits)
+    if k <= point <= 21:
+        return sign + digits + "0" * (point - k)
+    if 0 < point <= 21:
+        return sign + digits[:point] + "." + digits[point:]
+    if -6 < point <= 0:
+        return sign + "0." + "0" * -point + digits
+    e = point - 1
+    e_str = f"e+{e}" if e >= 0 else f"e-{-e}"
+    if k == 1:
+        return sign + digits + e_str
+    return sign + digits[0] + "." + digits[1:] + e_str
+
+
+def js_string(s: str) -> str:
+    """A string as `JSON.stringify` prints it."""
+    # Re-pair surrogates first: a high and a low surrogate side by side are one character to
+    # JavaScript, printed raw; only lone surrogates are escaped.
+    s = s.encode("utf-16-be", "surrogatepass").decode("utf-16-be", "surrogatepass")
+    out = ['"']
+    for ch in s:
+        c = ord(ch)
+        if ch in _SHORT_ESCAPES:
+            out.append(_SHORT_ESCAPES[ch])
+        elif c < 0x20 or 0xD800 <= c <= 0xDFFF:
+            out.append(f"\\u{c:04x}")
+        else:
+            out.append(ch)
+    out.append('"')
+    return "".join(out)

accordsync_core-0.3.0/src/accordsync_core/errors.py

@@ -0,0 +1,9 @@
+"""Errors raised by the core."""
+
+
+class AccordError(ValueError):
+    """Invalid input: a malformed op, a write that does not fit the schema, a bad snapshot."""
+
+
+class ClockSkewError(AccordError):
+    """A remote clock too far ahead of this device's physical time."""