x4d-devkit 0.48.0rc9__tar.gz → 0.50.0__tar.gz

{x4d_devkit-0.48.0rc9 → x4d_devkit-0.50.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: x4d-devkit
-Version: 0.48.0rc9
+Version: 0.50.0
 Summary: Official X-4D external SDK and CLI for datasets, platform APIs, training bridges, and automation
 Author: windzu
 License-Expression: Apache-2.0

{x4d_devkit-0.48.0rc9 → x4d_devkit-0.50.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "x4d-devkit"
-version = "0.48.0rc9"
+version = "0.50.0"
 description = "Official X-4D external SDK and CLI for datasets, platform APIs, training bridges, and automation"
 readme = "README.md"
 license = "Apache-2.0"

x4d_devkit-0.50.0/tests/test_image_groups.py

@@ -0,0 +1,249 @@
+from copy import deepcopy
+
+import pytest
+
+from tests.image_fixtures import clip_payload, line_object
+from x4d_devkit._image_contract import canonical
+from x4d_devkit.image_clip import build_image_identity, parse_image_clip
+from x4d_devkit.image_groups import (
+    IMAGE_OBJECT_GROUPS_VERSION,
+    parse_image_object_groups,
+)
+from x4d_devkit.image_schema import parse_image_schema_body
+from x4d_devkit.image_schema_upgrade import additive_image_schema_changes
+from x4d_devkit.image_work_session import (
+    IMAGE_WORK_SESSION_VERSION,
+    build_image_submit,
+    image_candidate,
+    parse_image_submit,
+    parse_image_work_session,
+)
+
+
+def grouped_payload():
+    value = clip_payload()
+    body = value["label_schema"]["body"]
+    body["categories"][0]["groupable"] = True
+    value["label_schema"]["identity"] = parse_image_schema_body(body).identity.to_dict()
+    first = line_object()
+    second = deepcopy(first)
+    second["id"] = "line_b"
+    second["attributes"] = {"visible": True}
+    second["attribute_ranges"][0]["attributes"] = {"style": "b"}
+    value["image_annotation"]["objects"] = [first, second]
+    value["image_annotation"]["object_groups"] = {
+        "contract_version": IMAGE_OBJECT_GROUPS_VERSION,
+        "groups": [
+            {
+                "id": "group_1",
+                "image_id": "image_a",
+                "view_id": "objects",
+                "object_ids": ["line_a", "line_b"],
+            }
+        ],
+    }
+    value["identity"] = build_image_identity(value)
+    return value
+
+
+def test_relations_preserve_independent_objects_and_all_source_components():
+    value = grouped_payload()
+    original = deepcopy(value)
+    clip = parse_image_clip(value)
+    assert clip.to_dict() == original
+    session = parse_image_work_session(
+        {"contract_version": IMAGE_WORK_SESSION_VERSION, "clip": value}
+    )
+    request = build_image_submit(session, value["image_annotation"]).to_dict()
+    assert (
+        parse_image_submit(request).to_dict()["image_annotation"]
+        == original["image_annotation"]
+    )
+    candidate = image_candidate(session.clip, request["image_annotation"]).to_dict()
+    assert candidate == original
+    value["image_annotation"]["object_groups"]["groups"][0]["object_ids"].clear()
+    assert clip.to_dict() == original
+
+
+def test_relation_changes_enter_revision_without_changing_geometry_or_source():
+    value = grouped_payload()
+    before = parse_image_clip(value)
+    annotation = deepcopy(value["image_annotation"])
+    annotation["object_groups"]["groups"][0]["id"] = "changed_group_identity"
+    after = image_candidate(before, annotation).to_dict()
+    for name in ("source_revision", "schema_fingerprint"):
+        assert after["identity"][name] == value["identity"][name]
+    for name in ("annotation_revision", "clip_revision"):
+        assert after["identity"][name] != value["identity"][name]
+    assert after["image_annotation"]["objects"] == value["image_annotation"]["objects"]
+    assert (
+        after["image_annotation"]["completion"]
+        == value["image_annotation"]["completion"]
+    )
+    annotation["object_groups"]["groups"] = []
+    ungrouped = image_candidate(before, annotation).to_dict()
+    assert (
+        ungrouped["image_annotation"]["objects"] == value["image_annotation"]["objects"]
+    )
+    assert ungrouped["image_annotation"]["object_groups"]["groups"] == []
+
+
+def test_existing_documents_remain_byte_identical_and_do_not_infer_groups():
+    old = clip_payload()
+    assert canonical(parse_image_clip(old).to_dict()) == canonical(old)
+    assert (
+        "groupable"
+        not in parse_image_schema_body(old["label_schema"]["body"]).to_dict()[
+            "categories"
+        ][0]
+    )
+    value = grouped_payload()
+    del value["image_annotation"]["object_groups"]
+    value["identity"] = build_image_identity(value)
+    parsed = parse_image_clip(value).to_dict()
+    assert "object_groups" not in parsed["image_annotation"]
+    assert (
+        parsed["image_annotation"]["objects"][0]["geometry"]
+        == parsed["image_annotation"]["objects"][1]["geometry"]
+    )
+    assert canonical(parsed) == canonical(value)
+
+
+@pytest.mark.parametrize(
+    "change",
+    [
+        "unknown_member",
+        "one_member",
+        "empty_members",
+        "duplicate_member",
+        "duplicate_group",
+        "duplicate_membership",
+        "cross_image",
+        "cross_view",
+        "disallowed_category",
+        "missing_permission",
+        "false_permission",
+        "colliding_id",
+        "unknown_version",
+        "null_fragment",
+        "extra_fragment",
+        "extra_group",
+        "object_provenance",
+        "geometry_mismatch",
+        "removed_member",
+        "non_array_members",
+    ],
+)
+def test_invalid_relations_fail_with_paths_without_repair(change):
+    value = grouped_payload()
+    annotation = value["image_annotation"]
+    fragment = annotation["object_groups"]
+    group = fragment["groups"][0]
+    if change == "unknown_member":
+        group["object_ids"][1] = "missing"
+    elif change == "one_member":
+        group["object_ids"].pop()
+    elif change == "empty_members":
+        group["object_ids"] = []
+    elif change == "duplicate_member":
+        group["object_ids"][1] = "line_a"
+    elif change == "duplicate_group":
+        fragment["groups"].append(deepcopy(group))
+    elif change == "duplicate_membership":
+        fragment["groups"].append({**group, "id": "group_2"})
+    elif change == "cross_image":
+        group["image_id"] = "another_image"
+    elif change == "cross_view":
+        group["view_id"] = "semantics"
+    elif change == "disallowed_category":
+        annotation["objects"][1].update(
+            category_id="box",
+            attributes={},
+            attribute_ranges=[],
+            geometry={
+                "geometry_type": "box_2d",
+                "box": {"x_min": 1, "y_min": 2, "x_max": 10, "y_max": 20},
+            },
+        )
+    elif change == "missing_permission":
+        del value["label_schema"]["body"]["categories"][0]["groupable"]
+    elif change == "false_permission":
+        value["label_schema"]["body"]["categories"][0]["groupable"] = False
+    elif change == "colliding_id":
+        group["id"] = "line_a"
+    elif change == "unknown_version":
+        fragment["contract_version"] = "unknown"
+    elif change == "null_fragment":
+        annotation["object_groups"] = None
+    elif change == "extra_fragment":
+        fragment["origin"] = "split"
+    elif change == "extra_group":
+        group["origin"] = "split"
+    elif change == "object_provenance":
+        annotation["objects"][0]["split_from"] = "original"
+    elif change == "geometry_mismatch":
+        annotation["objects"][1]["geometry"]["geometry_type"] = "box_2d"
+    elif change == "removed_member":
+        annotation["objects"].pop()
+    elif change == "non_array_members":
+        group["object_ids"] = "line_a,line_b"
+    body = value["label_schema"]["body"]
+    value["label_schema"]["identity"] = parse_image_schema_body(body).identity.to_dict()
+    value["identity"] = build_image_identity(value)
+    original = deepcopy(value)
+    with pytest.raises(ValueError) as caught:
+        parse_image_clip(value)
+    assert caught.value.path
+    assert value == original
+
+
+@pytest.mark.parametrize("value", [None, 0, 1, "true", [], {}])
+def test_grouping_permission_is_an_explicit_boolean(value):
+    body = clip_payload()["label_schema"]["body"]
+    body["categories"][0]["groupable"] = value
+    with pytest.raises(ValueError) as caught:
+        parse_image_schema_body(body)
+    assert caught.value.path.endswith("groupable")
+
+
+def test_unknown_business_category_can_use_groups_without_a_catalogue():
+    value = grouped_payload()
+    body = value["label_schema"]["body"]
+    body["categories"][0]["id"] = "new_business_after_sdk_release"
+    body["task_views"][0]["category_ids"][0] = "new_business_after_sdk_release"
+    for row in value["image_annotation"]["objects"]:
+        row["category_id"] = "new_business_after_sdk_release"
+    value["label_schema"]["identity"] = parse_image_schema_body(body).identity.to_dict()
+    value["identity"] = build_image_identity(value)
+    assert parse_image_clip(value).to_dict() == value
+
+
+def test_empty_fragment_is_valid_and_is_not_injected_when_absent():
+    assert (
+        parse_image_object_groups(
+            {"contract_version": IMAGE_OBJECT_GROUPS_VERSION, "groups": []}
+        ).to_dict()["groups"]
+        == []
+    )
+    value = clip_payload()
+    annotation = deepcopy(value["image_annotation"])
+    annotation["object_groups"] = {
+        "contract_version": IMAGE_OBJECT_GROUPS_VERSION,
+        "groups": [],
+    }
+    assert (
+        image_candidate(parse_image_clip(value), annotation).to_dict()[
+            "image_annotation"
+        ]
+        == annotation
+    )
+    assert "object_groups" not in parse_image_clip(value).to_dict()["image_annotation"]
+
+
+def test_grouping_permission_changes_are_not_silently_additive_upgrades():
+    old = clip_payload()["label_schema"]["body"]
+    new = deepcopy(old)
+    new["version"] = "2.0.0"
+    new["categories"][0]["groupable"] = True
+    with pytest.raises(ValueError):
+        additive_image_schema_changes(old, new)

x4d_devkit-0.50.0/tests/test_project_discovery.py

@@ -0,0 +1,264 @@
+from __future__ import annotations
+
+from copy import deepcopy
+
+import pytest
+
+from x4d_devkit.client.projects import ProjectsAPI
+from x4d_devkit.project_discovery import (
+    PROJECT_DISCOVERY_VERSION,
+    ProjectDiscoveryError,
+    project_discovery_query,
+    validate_project_discovery_page,
+    validate_project_image_task,
+)
+
+
+def discovery_page(task_id="a_new_task", *, revision=None, page=1):
+    return {
+        "items": [
+            {
+                "id": 7,
+                "name": "Project",
+                "project_type": "2d",
+                "image_task": {
+                    "status": "registered",
+                    "id": task_id,
+                    "revision": revision or 1,
+                    "title": "Registered title",
+                },
+            }
+        ]
+        if page <= 2
+        else [],
+        "total": 1 if revision else 2,
+        "page": page,
+        "page_size": 1,
+        "discovery": {
+            "contract_version": PROJECT_DISCOVERY_VERSION,
+            "applied_filters": {
+                "image_task_id": task_id,
+                "image_task_revision": revision,
+            },
+            "facets": {
+                "image_task": {
+                    "options": [
+                        {
+                            "id": task_id,
+                            "title": "Registered title",
+                            "project_count": 2,
+                            "revisions": [
+                                {
+                                    "revision": 1,
+                                    "title": "Registered title",
+                                    "project_count": 1,
+                                },
+                                {
+                                    "revision": 2,
+                                    "title": "Registered title",
+                                    "project_count": 1,
+                                },
+                            ],
+                        }
+                    ],
+                    "unresolved_project_count": 1,
+                }
+            },
+        },
+    }
+
+
+class Client:
+    def __init__(self, value):
+        self.value, self.calls = value, []
+
+    def get(self, path, params=None):
+        self.calls.append((path, params))
+        return deepcopy(self.value)
+
+
+def test_new_task_needs_no_business_enum_and_retains_old_call_shape():
+    client = Client(discovery_page("new_after_sdk_release"))
+    result = ProjectsAPI(client).list(
+        1,
+        1,
+        None,
+        "2d",
+        image_task_id="new_after_sdk_release",
+        include_facets=["image_task", "image_task"],
+    )
+    assert result["items"][0]["image_task"]["id"] == "new_after_sdk_release"
+    assert client.calls == [
+        (
+            "/projects",
+            {
+                "page": 1,
+                "page_size": 1,
+                "project_type": "2d",
+                "image_task_id": "new_after_sdk_release",
+                "include_facets": ["image_task"],
+            },
+        )
+    ]
+    old = {"items": [], "total": 0, "page": 1, "page_size": 50}
+    client = Client(old)
+    assert ProjectsAPI(client).list() == old
+    assert client.calls == [("/projects", {"page": 1, "page_size": 50})]
+
+
+@pytest.mark.parametrize(
+    "kwargs",
+    [
+        {"image_task_id": "task"},
+        {"project_type": "3d", "include_facets": ["image_task"]},
+        {"project_type": "2d", "image_task_revision": 1},
+        {"project_type": "2d", "image_task_id": " task"},
+        {"project_type": "2d", "image_task_id": ""},
+        {"project_type": "2d", "image_task_id": "x" * 1025},
+        {"project_type": "2d", "image_task_id": "task", "image_task_revision": True},
+        {"project_type": "2d", "image_task_id": "task", "image_task_revision": 0},
+        {"project_type": "2d", "include_facets": "image_task"},
+        {"project_type": "2d", "include_facets": [""]},
+        {"project_type": "2d", "include_facets": ["private_json"]},
+    ],
+)
+def test_bad_query_is_rejected_before_transport(kwargs):
+    client = Client({})
+    with pytest.raises(ProjectDiscoveryError) as exc:
+        ProjectsAPI(client).list(**kwargs)
+    assert exc.value.code == "invalid_project_discovery_query"
+    assert client.calls == []
+
+
+def test_exact_revision_and_out_of_range_pages():
+    assert (
+        ProjectsAPI(Client(discovery_page(revision=2))).list(
+            page_size=1,
+            project_type="2d",
+            image_task_id="a_new_task",
+            image_task_revision=2,
+        )["total"]
+        == 1
+    )
+    assert (
+        ProjectsAPI(Client(discovery_page(page=3))).list(
+            page=3, page_size=1, project_type="2d", image_task_id="a_new_task"
+        )["items"]
+        == []
+    )
+
+
+def test_facet_scope_ignores_current_task_filter_and_counts_unresolved():
+    value = discovery_page()
+    value["discovery"]["applied_filters"]["image_task_id"] = None
+    value["total"], value["page_size"] = 3, 3
+    value["items"].extend(
+        [
+            {
+                "id": 8,
+                "name": "Another",
+                "project_type": "2d",
+                "image_task": {
+                    "status": "registered",
+                    "id": "a_new_task",
+                    "revision": 2,
+                    "title": "Registered title",
+                },
+            },
+            {
+                "id": 9,
+                "name": "Missing",
+                "project_type": "2d",
+                "image_task": {
+                    "status": "missing",
+                    "id": None,
+                    "revision": None,
+                    "title": None,
+                },
+            },
+        ]
+    )
+    assert (
+        ProjectsAPI(Client(value)).list(
+            page_size=3, project_type="2d", include_facets=["image_task"]
+        )["total"]
+        == 3
+    )
+    value["items"], value["total"] = [], 0
+    value["discovery"]["applied_filters"]["image_task_id"] = "not_registered"
+    assert (
+        ProjectsAPI(Client(value)).list(
+            page_size=3,
+            project_type="2d",
+            image_task_id="not_registered",
+            include_facets=["image_task"],
+        )["items"]
+        == []
+    )
+
+
+@pytest.mark.parametrize(
+    "mutation",
+    [
+        lambda value: value.pop("discovery"),
+        lambda value: value["discovery"].update(contract_version="unknown"),
+        lambda value: value["discovery"]["applied_filters"].update(image_task_id=None),
+        lambda value: value["discovery"]["applied_filters"].update(
+            image_task_revision=True
+        ),
+        lambda value: value["discovery"].update(facets={}),
+        lambda value: value.update(page=2),
+        lambda value: value.update(total=True),
+        lambda value: value.update(total=3),
+        lambda value: value.update(items=[]),
+        lambda value: value["items"][0].update(project_type="3d"),
+        lambda value: value["items"][0]["image_task"].update(id="other"),
+        lambda value: value["items"][0]["image_task"].update(revision=4),
+        lambda value: value["items"][0]["image_task"].update(title="invented"),
+        lambda value: value["discovery"]["facets"]["image_task"]["options"][0].update(
+            project_count=3
+        ),
+        lambda value: value["discovery"]["facets"]["image_task"]["options"][0][
+            "revisions"
+        ].reverse(),
+        lambda value: value["discovery"]["facets"]["image_task"].update(
+            unresolved_project_count=-1
+        ),
+    ],
+)
+def test_old_ignored_filters_and_invalid_response_never_escape_to_ui(mutation):
+    value = discovery_page()
+    mutation(value)
+    with pytest.raises(ProjectDiscoveryError):
+        ProjectsAPI(Client(value)).list(
+            page_size=1,
+            project_type="2d",
+            image_task_id="a_new_task",
+            include_facets=["image_task"],
+        )
+
+
+@pytest.mark.parametrize("status", ["registered", "missing", "invalid", "unavailable"])
+def test_binding_statuses_do_not_fill_defaults(status):
+    value = {"status": status, "id": None, "revision": None, "title": None}
+    if status in {"registered", "unavailable"}:
+        value.update(id="task", revision=1)
+    if status == "registered":
+        value["title"] = "Title"
+    assert validate_project_image_task(value) is value
+    broken = {**value, "revision": False}
+    with pytest.raises(ProjectDiscoveryError):
+        validate_project_image_task(broken)
+
+
+def test_optional_response_extensions_do_not_force_new_clients():
+    value = discovery_page()
+    value["discovery"]["future_optional"] = {"anything": True}
+    value["items"][0]["future_optional"] = "retained"
+    query = project_discovery_query(
+        project_type="2d", image_task_id="a_new_task", include_facets=["image_task"]
+    )
+    assert (
+        validate_project_discovery_page(value, query=query, page=1, page_size=1)
+        is value
+    )

{x4d_devkit-0.48.0rc9 → x4d_devkit-0.50.0}/tests/test_sdk_api.py

@@ -11,7 +11,7 @@ from x4d_devkit.eval.matching import MetricData
 
 
 def test_package_version_is_current_release():
-    assert x4d_devkit.__version__ == "0.48.0rc9"
+    assert x4d_devkit.__version__ == "0.50.0"
 
 
 def test_loader_exposes_and_enforces_only_current_schema(tmp_path):

{x4d_devkit-0.48.0rc9 → x4d_devkit-0.50.0}/x4d_devkit/_image_contract.py

@@ -26,10 +26,20 @@ def require(condition: bool, message: str, path: str) -> None:
         )
 
 
-def fields(value: Any, expected: set[str], path: str) -> None:
+def fields(
+    value: Any,
+    expected: set[str],
+    path: str,
+    *,
+    optional: frozenset[str] | set[str] = frozenset(),
+) -> None:
     require(
-        type(value) is dict and set(value) == expected,
-        f"expected exactly {sorted(expected)}",
+        type(value) is dict and expected <= set(value) <= expected | optional,
+        (
+            f"expected exactly {sorted(expected)}"
+            if not optional
+            else f"expected required {sorted(expected)} and only optional {sorted(optional)}"
+        ),
         path,
     )
 

{x4d_devkit-0.48.0rc9 → x4d_devkit-0.50.0}/x4d_devkit/client/__init__.py

@@ -30,6 +30,7 @@ from x4d_devkit.client.semantic_scene_authoring import (
     SemanticSceneAuthoringWorkSessionsAPI,
 )
 from x4d_devkit.client.projects import ProjectResolutionError, ProjectsAPI
+from x4d_devkit.project_discovery import ProjectDiscoveryError
 from x4d_devkit.client.reconstruction import (
     ReconstructionAPI,
     StaticRgbMapGeneration,
@@ -67,6 +68,7 @@ __all__ = [
     "PlatformAsset",
     "PlatformAssetReference",
     "ProjectResolutionError",
+    "ProjectDiscoveryError",
     "ProjectsAPI",
     "ReconstructionAPI",
     "RESOLVED_LABEL_SCHEMA_CONTEXT_VERSION",

{x4d_devkit-0.48.0rc9 → x4d_devkit-0.50.0}/x4d_devkit/client/projects.py

@@ -2,8 +2,14 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from collections.abc import Sequence
 from typing import TYPE_CHECKING
 
+from x4d_devkit.project_discovery import (
+    project_discovery_query,
+    validate_project_discovery_page,
+)
+
 if TYPE_CHECKING:
     from x4d_devkit.client.client import X4DClient
 
@@ -27,8 +33,14 @@ class ProjectsAPI:
     def list(
         self, page: int = 1, page_size: int = 50, search: str | None = None,
         project_type: str | None = None,
+        *, image_task_id: str | None = None, image_task_revision: int | None = None,
+        include_facets: Sequence[str] | None = None,
     ) -> dict:
-        """List all projects."""
+        """List accessible Projects, optionally discovering registered image tasks."""
+        query = project_discovery_query(
+            project_type=project_type, image_task_id=image_task_id,
+            image_task_revision=image_task_revision, include_facets=include_facets,
+        )
         params = {"page": page, "page_size": page_size}
         if search:
             params["search"] = search
@@ -36,7 +48,16 @@ class ProjectsAPI:
             if project_type not in {"2d", "3d"}:
                 raise ValueError("project_type must be 2d or 3d")
             params["project_type"] = project_type
-        return self._client.get("/projects", params=params)
+        if query.image_task_id is not None:
+            params["image_task_id"] = query.image_task_id
+        if query.image_task_revision is not None:
+            params["image_task_revision"] = query.image_task_revision
+        if query.include_facets:
+            params["include_facets"] = list(query.include_facets)
+        value = self._client.get("/projects", params=params)
+        if query.enabled:
+            validate_project_discovery_page(value, query=query, page=page, page_size=page_size)
+        return value
 
     def get(self, project_id: int) -> dict:
         """Get a project by ID."""

{x4d_devkit-0.48.0rc9 → x4d_devkit-0.50.0}/x4d_devkit/image_clip.py

@@ -25,6 +25,7 @@ from x4d_devkit._image_contract import (
     unique_ids,
 )
 from x4d_devkit.image_geometry import parse_image_attribute_ranges, parse_image_geometry
+from x4d_devkit.image_groups import validate_image_object_groups
 from x4d_devkit.image_schema import parse_image_schema_snapshot
 
 
@@ -243,6 +244,7 @@ def validate_image_annotations(
         value,
         {"contract_version", "clip_id", "objects", "descriptions", "completion"},
         "image_annotation",
+        optional={"object_groups"},
     )
     require(
         value["contract_version"] == IMAGE_ANNOTATION_CONTRACT_VERSION
@@ -328,6 +330,13 @@ def validate_image_annotations(
                 path + ".attribute_ranges",
             )
         occupied.add((row["image_id"], row["view_id"]))
+    if "object_groups" in value:
+        validate_image_object_groups(
+            value["object_groups"],
+            objects=objects,
+            categories=categories,
+            result_ids=set(objects) | set(descriptions),
+        )
     for name, row in descriptions.items():
         path = "image_annotation.descriptions." + name
         fields(row, {"id", "image_id", "view_id", "target_id", "fields"}, path)