simulo-interfaces 0.13.0__tar.gz → 0.15.2__tar.gz

{simulo_interfaces-0.13.0/src/simulo_interfaces.egg-info → simulo_interfaces-0.15.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simulo-interfaces
-Version: 0.13.0
+Version: 0.15.2
 Summary: Type contracts for the Simulo SDK. Installed automatically as a dependency of the simulo package.
 Author-email: Simulo Team <team@simulo.ai>
 License: BSD-3-Clause

{simulo_interfaces-0.13.0 → simulo_interfaces-0.15.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simulo-interfaces"
-version = "0.13.0"
+version = "0.15.2"
 description = "Type contracts for the Simulo SDK. Installed automatically as a dependency of the simulo package."
 readme = "PYPI.md"
 requires-python = ">=3.11"

{simulo_interfaces-0.13.0 → simulo_interfaces-0.15.2}/src/simulo/interfaces/__init__.py

@@ -31,13 +31,21 @@ from simulo.interfaces.ids import (
     CheckpointId,
     Digest,
     JobId,
+    JobPublicId,
+    ModelPublicId,
     OrganizationId,
+    OutputPublicId,
     PackageId,
     ProjectId,
+    RecordingPublicId,
     ResourceId,
     ResourceUri,
     TagId,
     TrainedModelId,
+    parse_job_public_id,
+    parse_model_public_id,
+    parse_output_public_id,
+    parse_recording_public_id,
 )
 
 __all__ = [
@@ -56,6 +64,14 @@ __all__ = [
     "ProjectId",
     "PackageId",
     "JobId",
+    "JobPublicId",
+    "ModelPublicId",
+    "RecordingPublicId",
+    "OutputPublicId",
+    "parse_job_public_id",
+    "parse_model_public_id",
+    "parse_recording_public_id",
+    "parse_output_public_id",
     "ResourceId",
     "CheckpointId",
     "TrainedModelId",

simulo_interfaces-0.15.2/src/simulo/interfaces/ids.py

@@ -0,0 +1,134 @@
+"""Strongly-typed string identifiers for the platform domain model (Part B).
+
+``NewType`` aliases — zero runtime cost (each is the underlying ``str`` at
+runtime) but distinct to the type checker, so a ``ProjectId`` can never be
+passed where a ``JobId`` is expected.
+
+The ``*PublicId`` aliases identify grammar-validated human-facing references.
+Their parsers normalize only outer ASCII whitespace and ASCII letter case;
+Unicode whitespace, Unicode case folding, wildcards, and partial IDs are
+deliberately rejected.
+"""
+
+import re
+from typing import NewType
+
+OrganizationId = NewType("OrganizationId", str)
+ProjectId = NewType("ProjectId", str)
+PackageId = NewType("PackageId", str)
+JobId = NewType("JobId", str)
+ResourceId = NewType("ResourceId", str)
+CheckpointId = NewType("CheckpointId", str)
+TrainedModelId = NewType("TrainedModelId", str)
+TagId = NewType("TagId", str)
+ResourceUri = NewType("ResourceUri", str)  # e.g. "robot/so-arm-100:v3"
+Digest = NewType("Digest", str)  # content-addressed package source digest
+RecordingId = NewType("RecordingId", str)  # a job-produced MCAP recording (PR-0 wire contract)
+WorkerId = NewType("WorkerId", str)  # a claiming worker process (PR-0 wire contract)
+AssetId = NewType("AssetId", str)  # a catalog asset (USD Asset Catalogs wire contract, PR-1)
+AssetVersionId = NewType("AssetVersionId", str)  # one immutable asset version (PR-1)
+ArtifactId = NewType("ArtifactId", str)  # a job-produced output in the /artifacts projection (Plan B)
+
+JobPublicId = NewType("JobPublicId", str)
+ModelPublicId = NewType("ModelPublicId", str)
+RecordingPublicId = NewType("RecordingPublicId", str)
+OutputPublicId = NewType("OutputPublicId", str)
+
+_ASCII_WHITESPACE = " \t\n\r\v\f"
+_ASCII_LOWERCASE_TRANSLATION = str.maketrans(
+    "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+    "abcdefghijklmnopqrstuvwxyz",
+)
+_JOB_STEM_PATTERN = r"[a-z]{3,10}-[a-z]{3,10}-[0-9a-hjkmnp-tv-z]{6}"
+_CANONICAL_CHILD_COUNTER_PATTERN = r"(?:(?!0000)[0-9]{4}|[1-9][0-9]{4,})"
+_JOB_PUBLIC_ID_RE = re.compile(rf"job_{_JOB_STEM_PATTERN}\Z")
+_MODEL_PUBLIC_ID_RE = re.compile(rf"mdl_{_JOB_STEM_PATTERN}-{_CANONICAL_CHILD_COUNTER_PATTERN}\Z")
+_RECORDING_PUBLIC_ID_RE = re.compile(rf"rec_{_JOB_STEM_PATTERN}-{_CANONICAL_CHILD_COUNTER_PATTERN}\Z")
+_OUTPUT_PUBLIC_ID_RE = re.compile(rf"out_{_JOB_STEM_PATTERN}-{_CANONICAL_CHILD_COUNTER_PATTERN}\Z")
+_MAX_JOB_PUBLIC_ID_LENGTH = 32
+_MAX_CHILD_PUBLIC_ID_LENGTH = 64
+
+
+def _normalize_public_id(value: str, *, parser: str) -> str:
+    if not isinstance(value, str):
+        raise TypeError(f"{parser}() requires a str, got {type(value).__name__}.")
+    return value.strip(_ASCII_WHITESPACE).translate(_ASCII_LOWERCASE_TRANSLATION)
+
+
+def _parse_public_id(value: str, *, parser: str, pattern: re.Pattern[str], max_length: int) -> str:
+    normalized = _normalize_public_id(value, parser=parser)
+    if len(normalized) > max_length or pattern.fullmatch(normalized) is None:
+        raise ValueError(f"{parser}() received a non-canonical public ID.")
+    return normalized
+
+
+def parse_job_public_id(value: str) -> JobPublicId:
+    """Return a canonical Job ID such as ``job_quiet-cedar-7k3m4q``.
+
+    Only outer ASCII whitespace is trimmed and only ASCII ``A-Z`` is
+    lowercased. Matching is exact: prefixes, partial values, wildcards, and
+    non-ASCII input are rejected.
+    """
+
+    return JobPublicId(
+        _parse_public_id(
+            value,
+            parser="parse_job_public_id",
+            pattern=_JOB_PUBLIC_ID_RE,
+            max_length=_MAX_JOB_PUBLIC_ID_LENGTH,
+        )
+    )
+
+
+def parse_model_public_id(value: str) -> ModelPublicId:
+    """Return a canonical Model ID such as ``mdl_quiet-cedar-7k3m4q-0001``.
+
+    Only outer ASCII whitespace is trimmed and only ASCII ``A-Z`` is
+    lowercased. Matching is exact and non-ASCII input is rejected. Counters
+    use exactly four digits through ``9999`` and expand unpadded at ``10000``.
+    """
+
+    return ModelPublicId(
+        _parse_public_id(
+            value,
+            parser="parse_model_public_id",
+            pattern=_MODEL_PUBLIC_ID_RE,
+            max_length=_MAX_CHILD_PUBLIC_ID_LENGTH,
+        )
+    )
+
+
+def parse_recording_public_id(value: str) -> RecordingPublicId:
+    """Return a Recording ID such as ``rec_quiet-cedar-7k3m4q-0001``.
+
+    Only outer ASCII whitespace is trimmed and only ASCII ``A-Z`` is
+    lowercased. Matching is exact and non-ASCII input is rejected. Counters
+    use exactly four digits through ``9999`` and expand unpadded at ``10000``.
+    """
+
+    return RecordingPublicId(
+        _parse_public_id(
+            value,
+            parser="parse_recording_public_id",
+            pattern=_RECORDING_PUBLIC_ID_RE,
+            max_length=_MAX_CHILD_PUBLIC_ID_LENGTH,
+        )
+    )
+
+
+def parse_output_public_id(value: str) -> OutputPublicId:
+    """Return an Output ID such as ``out_quiet-cedar-7k3m4q-0001``.
+
+    Only outer ASCII whitespace is trimmed and only ASCII ``A-Z`` is
+    lowercased. Matching is exact and non-ASCII input is rejected. Counters
+    use exactly four digits through ``9999`` and expand unpadded at ``10000``.
+    """
+
+    return OutputPublicId(
+        _parse_public_id(
+            value,
+            parser="parse_output_public_id",
+            pattern=_OUTPUT_PUBLIC_ID_RE,
+            max_length=_MAX_CHILD_PUBLIC_ID_LENGTH,
+        )
+    )

{simulo_interfaces-0.13.0 → simulo_interfaces-0.15.2}/src/simulo/interfaces/platform/__init__.py

@@ -16,7 +16,10 @@ from simulo.interfaces.platform.artifacts import (
     MAX_OUTPUT_FLAG_CODE_CHARS,
     MAX_OUTPUT_FLAG_DETAIL_CHARS,
     MAX_OUTPUTS_BYTES,
+    OUTPUT_DROPPED_DETAILS,
     OUTPUT_FLAG_ANOMALY,
+    OUTPUT_FLAG_OUTPUT_DROPPED,
+    OUTPUTS_UNDELIVERED_CODE,
     WORKER_JOB_ARTIFACTS_PRESIGN_ROUTE_TEMPLATE,
     WORKER_JOB_ARTIFACTS_ROUTE_TEMPLATE,
     Artifact,
@@ -97,6 +100,34 @@ from simulo.interfaces.platform.callbacks import JobCallbackProtocol
 from simulo.interfaces.platform.debug import DebugSessionProtocol, ReplaySessionProtocol, VisualizationSessionProtocol
 from simulo.interfaces.platform.domain import Checkpoint, Job, Package, Project, Resource, Tag, TrainedModel
 from simulo.interfaces.platform.enums import ArtifactKind
+from simulo.interfaces.platform.job_events import (
+    MAX_PUBLIC_ASSET_FINDING_COUNT,
+    MAX_PUBLIC_JOB_EVENT_ATTEMPT,
+    MAX_PUBLIC_JOB_EVENT_BYTES,
+    MAX_PUBLIC_JOB_EVENT_ENTRIES,
+    MAX_PUBLIC_JOB_EVENT_QUIET_SECONDS,
+    MAX_PUBLIC_JOB_EVENT_WIRE_BYTES,
+    PUBLIC_JOB_EVENT_ATTEMPT_MISMATCH_CODE,
+    PUBLIC_JOB_EVENT_OFFSET_CONFLICT_CODE,
+    PUBLIC_JOB_EVENT_OFFSET_GAP_CODE,
+    PUBLIC_JOB_EVENT_SCHEMA_VERSION,
+    PUBLIC_JOB_SUPPORT_ID_HEX_CHARS,
+    PUBLIC_JOB_SUPPORT_ID_PREFIX,
+    WORKER_JOB_EVENTS_ROUTE_TEMPLATE,
+    JobAssetFindingData,
+    JobAssetFindingEvent,
+    JobPreparingData,
+    JobPreparingEvent,
+    JobRunningData,
+    JobRunningEvent,
+    JobStillWorkingData,
+    JobStillWorkingEvent,
+    PublicAssetFindingReason,
+    PublicJobEvent,
+    PublicJobEventCode,
+    PublicJobEventSeverity,
+    PublicJobPreparationPhase,
+)
 from simulo.interfaces.platform.manifest import (
     FINDING_CLASSIFICATIONS,
     MAX_PREFLIGHT_BODY_BYTES,
@@ -109,6 +140,60 @@ from simulo.interfaces.platform.manifest import (
     PreflightResponse,
     RuntimeManifest,
 )
+from simulo.interfaces.platform.policy_bundle import (
+    EXPORT_VALIDATION_JOB_TYPE,
+    JOB_EXPORTS_ROUTE_TEMPLATE,
+    MAX_POLICY_BUNDLE_UNCOMPRESSED_BYTES,
+    MAX_POLICY_NAME_TOKEN_CHARS,
+    POLICY_BUNDLE_ACTION_SCHEMA_FILE,
+    POLICY_BUNDLE_ARCHIVE_NAME_TEMPLATE,
+    POLICY_BUNDLE_ARTIFACT_KIND,
+    POLICY_BUNDLE_FILES,
+    POLICY_BUNDLE_MANIFEST_FILE,
+    POLICY_BUNDLE_MODEL_ONNX_FILE,
+    POLICY_BUNDLE_MODEL_PT_FILE,
+    POLICY_BUNDLE_NORMALIZATION_FILE,
+    POLICY_BUNDLE_OBSERVATION_SCHEMA_FILE,
+    POLICY_BUNDLE_OPTIONAL_FILES,
+    POLICY_BUNDLE_README_FILE,
+    POLICY_BUNDLE_REQUIRED_FILES,
+    POLICY_BUNDLE_REQUIREMENTS_FILE,
+    POLICY_BUNDLE_ROOT_DIR_TEMPLATE,
+    POLICY_BUNDLE_SCHEMA_VERSION,
+    POLICY_BUNDLE_TEST_VECTORS_FILE,
+    POLICY_BUNDLE_VERIFY_FILE,
+    POLICY_EQUIVALENCE_ABS_TOLERANCE,
+    POLICY_EQUIVALENCE_REL_TOLERANCE,
+    POLICY_GOLDEN_VECTOR_COUNT,
+    POLICY_NAME_TOKEN_FALLBACK,
+    POLICY_TENSOR_DTYPES,
+    POLICY_TEST_VECTOR_EXPECTED_OUTPUTS_KEY,
+    POLICY_TEST_VECTOR_INPUTS_KEY,
+    SUPPORTED_POLICY_BUNDLE_SCHEMA_MAJORS,
+    UNKNOWN,
+    PolicyActionComponent,
+    PolicyActionSchema,
+    PolicyBounds,
+    PolicyBundleManifest,
+    PolicyEquivalenceSpec,
+    PolicyExportFailureReason,
+    PolicyExportFormat,
+    PolicyExportValidation,
+    PolicyExportVerdict,
+    PolicyHistorySpec,
+    PolicyNormalization,
+    PolicyObservationComponent,
+    PolicyObservationSchema,
+    PolicySourceSpec,
+    PolicyTensorSpec,
+    Unknown,
+    is_supported_policy_bundle_schema,
+    policy_bundle_archive_name,
+    policy_bundle_root_dir,
+    policy_bundle_schema_major,
+    policy_name_token,
+    validate_policy_bundle,
+)
 from simulo.interfaces.platform.runs import (
     JOB_CANCEL_ROUTE_TEMPLATE,
     JOB_LIST_SCOPES,
@@ -164,6 +249,33 @@ from simulo.interfaces.platform.volume import VolumeProtocol
 __all__ = [
     # enums
     "ArtifactKind",
+    # closed public job-event contract (#656)
+    "PUBLIC_JOB_EVENT_SCHEMA_VERSION",
+    "WORKER_JOB_EVENTS_ROUTE_TEMPLATE",
+    "MAX_PUBLIC_JOB_EVENT_BYTES",
+    "MAX_PUBLIC_JOB_EVENT_WIRE_BYTES",
+    "MAX_PUBLIC_JOB_EVENT_ENTRIES",
+    "MAX_PUBLIC_JOB_EVENT_ATTEMPT",
+    "MAX_PUBLIC_JOB_EVENT_QUIET_SECONDS",
+    "MAX_PUBLIC_ASSET_FINDING_COUNT",
+    "PUBLIC_JOB_SUPPORT_ID_PREFIX",
+    "PUBLIC_JOB_SUPPORT_ID_HEX_CHARS",
+    "PUBLIC_JOB_EVENT_OFFSET_GAP_CODE",
+    "PUBLIC_JOB_EVENT_OFFSET_CONFLICT_CODE",
+    "PUBLIC_JOB_EVENT_ATTEMPT_MISMATCH_CODE",
+    "PublicJobEventSeverity",
+    "PublicJobEventCode",
+    "PublicJobPreparationPhase",
+    "PublicAssetFindingReason",
+    "JobPreparingData",
+    "JobRunningData",
+    "JobStillWorkingData",
+    "JobAssetFindingData",
+    "JobPreparingEvent",
+    "JobRunningEvent",
+    "JobStillWorkingEvent",
+    "JobAssetFindingEvent",
+    "PublicJobEvent",
     # domain dataclasses
     "Tag",
     "Project",
@@ -201,6 +313,9 @@ __all__ = [
     "MAX_OUTPUT_FLAG_CODE_CHARS",
     "MAX_OUTPUT_FLAG_DETAIL_CHARS",
     "OUTPUT_FLAG_ANOMALY",
+    "OUTPUT_FLAG_OUTPUT_DROPPED",
+    "OUTPUT_DROPPED_DETAILS",
+    "OUTPUTS_UNDELIVERED_CODE",
     "DECLARED_OUTPUT_MISSING_CODE",
     # job-run contract (run record schema + jobs HTTP API shape)
     "TERMINAL_JOB_STATUSES",
@@ -322,6 +437,62 @@ __all__ = [
     "ConvertedArchive",
     "AssetValidationFinalize",
     "AssetPublishOptions",
+    # portable policy export bundle contract (issue #654) — schema version,
+    # bundle layout, naming rule, export routes/job type, equivalence
+    # defaults, enums, explicit-unknown marker, manifest dataclasses, the
+    # export-validation result, and the cross-file coherence check
+    "POLICY_BUNDLE_SCHEMA_VERSION",
+    "SUPPORTED_POLICY_BUNDLE_SCHEMA_MAJORS",
+    "policy_bundle_schema_major",
+    "is_supported_policy_bundle_schema",
+    "POLICY_BUNDLE_MODEL_ONNX_FILE",
+    "POLICY_BUNDLE_MODEL_PT_FILE",
+    "POLICY_BUNDLE_MANIFEST_FILE",
+    "POLICY_BUNDLE_OBSERVATION_SCHEMA_FILE",
+    "POLICY_BUNDLE_ACTION_SCHEMA_FILE",
+    "POLICY_BUNDLE_NORMALIZATION_FILE",
+    "POLICY_BUNDLE_TEST_VECTORS_FILE",
+    "POLICY_BUNDLE_VERIFY_FILE",
+    "POLICY_BUNDLE_REQUIREMENTS_FILE",
+    "POLICY_BUNDLE_README_FILE",
+    "POLICY_BUNDLE_FILES",
+    "POLICY_BUNDLE_REQUIRED_FILES",
+    "POLICY_BUNDLE_OPTIONAL_FILES",
+    "MAX_POLICY_BUNDLE_UNCOMPRESSED_BYTES",
+    "POLICY_TEST_VECTOR_INPUTS_KEY",
+    "POLICY_TEST_VECTOR_EXPECTED_OUTPUTS_KEY",
+    "POLICY_BUNDLE_ARTIFACT_KIND",
+    "POLICY_BUNDLE_ROOT_DIR_TEMPLATE",
+    "POLICY_BUNDLE_ARCHIVE_NAME_TEMPLATE",
+    "MAX_POLICY_NAME_TOKEN_CHARS",
+    "POLICY_NAME_TOKEN_FALLBACK",
+    "policy_name_token",
+    "policy_bundle_root_dir",
+    "policy_bundle_archive_name",
+    "JOB_EXPORTS_ROUTE_TEMPLATE",
+    "EXPORT_VALIDATION_JOB_TYPE",
+    "POLICY_EQUIVALENCE_ABS_TOLERANCE",
+    "POLICY_EQUIVALENCE_REL_TOLERANCE",
+    "POLICY_GOLDEN_VECTOR_COUNT",
+    "POLICY_TENSOR_DTYPES",
+    "PolicyExportFormat",
+    "PolicyExportVerdict",
+    "PolicyExportFailureReason",
+    "PolicyExportValidation",
+    "Unknown",
+    "UNKNOWN",
+    "PolicyTensorSpec",
+    "PolicyBounds",
+    "PolicyHistorySpec",
+    "PolicySourceSpec",
+    "PolicyEquivalenceSpec",
+    "PolicyObservationComponent",
+    "PolicyActionComponent",
+    "PolicyBundleManifest",
+    "PolicyObservationSchema",
+    "PolicyActionSchema",
+    "PolicyNormalization",
+    "validate_policy_bundle",
     # protocols
     "RuntimeProtocol",
     "AssetProtocol",

simulo_interfaces-0.15.2/src/simulo/interfaces/platform/_payload.py

@@ -0,0 +1,15 @@
+"""Internal helpers for tolerant response-record reconstruction."""
+
+from collections.abc import Mapping
+from dataclasses import fields
+from typing import Any
+
+
+def known_payload_fields(record_type: Any, payload: Mapping[str, Any], *, owner: str) -> dict[str, Any]:
+    """Copy only fields declared by ``record_type`` from one response mapping."""
+
+    if not isinstance(payload, Mapping):
+        raise TypeError(f"{owner} requires a mapping, got {type(payload).__name__}.")
+    return {
+        definition.name: payload[definition.name] for definition in fields(record_type) if definition.name in payload
+    }