lorebase-client 0.3.1__tar.gz → 0.4.0__tar.gz

{lorebase_client-0.3.1 → lorebase_client-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: lorebase-client
-Version: 0.3.1
+Version: 0.4.0
 Summary: Lorebase client: typed sync and async HTTP client for the Keeper API
 Project-URL: Homepage, https://github.com/aantenore/lorebase
 Project-URL: Documentation, https://aantenore.github.io/lorebase/

{lorebase_client-0.3.1 → lorebase_client-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lorebase-client"
-version = "0.3.1"
+version = "0.4.0"
 description = "Lorebase client: typed sync and async HTTP client for the Keeper API"
 requires-python = ">=3.12"
 readme = "README.md"

{lorebase_client-0.3.1 → lorebase_client-0.4.0}/src/lorebase_client/__init__.py

@@ -45,7 +45,7 @@ from lorebase_client.errors import (
     error_from_response,
 )
 
-__version__ = "0.3.1"
+__version__ = "0.4.0"
 
 __all__ = [
     "ENV_API_KEY",

{lorebase_client-0.3.1 → lorebase_client-0.4.0}/src/lorebase_client/aclient.py

@@ -710,9 +710,21 @@ class Records(_Resource):
         at: str | None = None,
         links: bool = False,
         lineage: bool = False,
+        conflicts: bool = False,
     ) -> m.RecordResponse:
+        """One Record. `conflicts` adds `conflict_in_progress`: the open Conflicts about it
+        in Proposals into the branch read (branch head only)."""
         return await self._c.send(
-            ep.get_record(domain, kind, key, branch=branch, at=at, links=links, lineage=lineage)
+            ep.get_record(
+                domain,
+                kind,
+                key,
+                branch=branch,
+                at=at,
+                links=links,
+                lineage=lineage,
+                conflicts=conflicts,
+            )
         )
 
     async def history(

{lorebase_client-0.3.1 → lorebase_client-0.4.0}/src/lorebase_client/client.py

@@ -721,9 +721,21 @@ class Records(_Resource):
         at: str | None = None,
         links: bool = False,
         lineage: bool = False,
+        conflicts: bool = False,
     ) -> m.RecordResponse:
+        """One Record. `conflicts` adds `conflict_in_progress`: the open Conflicts about it
+        in Proposals into the branch read (branch head only)."""
         return self._c.send(
-            ep.get_record(domain, kind, key, branch=branch, at=at, links=links, lineage=lineage)
+            ep.get_record(
+                domain,
+                kind,
+                key,
+                branch=branch,
+                at=at,
+                links=links,
+                lineage=lineage,
+                conflicts=conflicts,
+            )
         )
 
     def history(

{lorebase_client-0.3.1 → lorebase_client-0.4.0}/src/lorebase_client/endpoints.py

@@ -471,6 +471,7 @@ def get_record(
     at: str | None = None,
     links: bool = False,
     lineage: bool = False,
+    conflicts: bool = False,
 ) -> Call[m.RecordResponse]:
     return Call(
         "GET",
@@ -481,6 +482,7 @@ def get_record(
             "at": at,
             "links": links or None,
             "lineage": lineage or None,
+            "conflicts": conflicts or None,
         },
         safe=True,
         cacheable=True,

{lorebase_client-0.3.1 → lorebase_client-0.4.0}/src/lorebase_client/models.py

@@ -547,8 +547,22 @@ class Served(Model):
     served_from: ServedFrom
 
 
+class ConflictInProgress(Model):
+    """A Conflict about a Record that waits for a decision in an open Proposal into the
+    branch read; `attribute` is None when the whole Record is contested."""
+
+    proposal_id: str
+    conflict_id: str
+    code: str
+    attribute: str | None = None
+    competing_hash: str | None = None
+
+
 class RecordResponse(Served):
+    """A Record. `conflict_in_progress` is set when the read asked for it (`conflicts`)."""
+
     record: RecordItem
+    conflict_in_progress: list[ConflictInProgress] | None = None
 
 
 class RecordPage(Served):
@@ -1155,14 +1169,35 @@ class Attempt(Model):
     auto_resolutions: list[dict[str, Any]]
 
 
+class SideProvenance(Model):
+    """Who or what last changed the Attribute of a Conflict on one side, and when."""
+
+    provenance_id: str
+    at: datetime
+    actor: str | None = None
+    origin: str | None = None
+    source: str | None = None
+    principal: str | None = None
+    labels: list[str] = Field(default_factory=list)
+
+
+class ConflictProvenance(Model):
+    """The provenance of the two competing sides; `None` for a side of unknown Lineage."""
+
+    ours: SideProvenance | None = None
+    theirs: SideProvenance | None = None
+
+
 class ConflictItem(Model):
-    """A Conflict: `id`, `status` and the members the merge engine reports."""
+    """A Conflict: `id`, `status` and the members the merge engine reports. `provenance` is
+    set on Attribute Conflicts whose merge knew who changed a side."""
 
     model_config = ConfigDict(extra="allow")
 
     id: str
     status: ConflictStatus
     resolution: dict[str, Any] | None = None
+    provenance: ConflictProvenance | None = None
 
 
 class Conflicts(Attempt):

{lorebase_client-0.3.1 → lorebase_client-0.4.0}/tests/test_contract.py

@@ -64,6 +64,7 @@ RESPONSES: dict[type[m.Model], str] = {
     m.ExtractionEvidence: "ExtractionEvidenceOut",
     m.ValueLineage: "ValueLineageOut",
     m.RecordLineage: "RecordLineageOut",
+    m.ConflictInProgress: "ConflictInProgressOut",
     m.RecordResponse: "RecordResponse",
     m.RecordPage: "RecordPage",
     m.AggregateCount: "AggregateCount",
@@ -117,6 +118,8 @@ RESPONSES: dict[type[m.Model], str] = {
     m.Approval: "ApprovalOut",
     m.Resolution: "ResolutionOut",
     m.Attempt: "AttemptOut",
+    m.SideProvenance: "SideProvenanceOut",
+    m.ConflictProvenance: "ConflictProvenanceOut",
     m.ConflictItem: "ConflictOut",
     m.Conflicts: "ConflictsOut",
     m.Proposal: "lorebase_keeper__routes__proposals__ProposalOut",

{lorebase_client-0.3.1 → lorebase_client-0.4.0}/tests/test_requests.py

@@ -590,6 +590,35 @@ RECORD = {
 }
 
 
+def test_a_record_read_can_ask_for_pending_conflicts(
+    http: respx.MockRouter, sleeps: Sleeps
+) -> None:
+    pending = {
+        "proposal_id": "prp_1",
+        "conflict_id": "ab" * 32,
+        "code": "DV1",
+        "attribute": "risk_score",
+        "competing_hash": "cd" * 32,
+    }
+    route = http.get("/domains/supply/kinds/Part/records/P-1").mock(
+        side_effect=lambda request: httpx.Response(
+            200,
+            json={**RECORD, "conflict_in_progress": [pending]}
+            if "conflicts" in request.url.params
+            else RECORD,
+        )
+    )
+    with make(sleeps) as client:
+        plain = client.records.get("supply", "Part", "P-1")
+        asked = client.records.get("supply", "Part", "P-1", conflicts=True)
+    assert "conflicts" not in route.calls[0].request.url.params
+    assert route.calls[1].request.url.params["conflicts"] == "true"
+    assert plain.conflict_in_progress is None
+    assert asked.conflict_in_progress is not None
+    [marker] = asked.conflict_in_progress
+    assert marker.model_dump() == pending
+
+
 def test_etag_cache_revalidates_and_serves_the_cached_body(
     http: respx.MockRouter, sleeps: Sleeps
 ) -> None: