plato-sdk-v2 2.8.8__py3-none-any.whl → 2.9.1__py3-none-any.whl

plato/worlds/markers.py

@@ -0,0 +1,63 @@
+"""Annotation markers for Plato world configurations."""
+
+from __future__ import annotations
+
+
+class Agent:
+    """Annotation marker for agent fields.
+
+    Usage:
+        coder: Annotated[AgentConfig, Agent(description="Coding agent")]
+    """
+
+    def __init__(self, description: str = "", required: bool = True):
+        self.description = description
+        self.required = required
+
+
+class Secret:
+    """Annotation marker for secret fields.
+
+    Usage:
+        api_key: Annotated[str | None, Secret(description="API key")] = None
+    """
+
+    def __init__(self, description: str = "", required: bool = False):
+        self.description = description
+        self.required = required
+
+
+class Env:
+    """Annotation marker for single environment fields.
+
+    Environments are VMs that run alongside the world's runtime.
+    They can be specified by artifact ID, simulator name, or resource config.
+
+    Usage:
+        database: Annotated[EnvConfig, Env(description="Database server")] = EnvFromArtifact(
+            artifact_id="abc123",
+            alias="database",
+        )
+    """
+
+    def __init__(self, description: str = "", required: bool = True):
+        self.description = description
+        self.required = required
+
+
+class EnvList:
+    """Annotation marker for a list of arbitrary environments.
+
+    Use this when the world accepts a dynamic list of environments
+    rather than named, fixed environment fields.
+
+    Usage:
+        envs: Annotated[
+            list[EnvFromSimulator | EnvFromArtifact | EnvFromResource],
+            EnvList(description="Environments to create for this task"),
+            Field(discriminator="type"),
+        ] = []
+    """
+
+    def __init__(self, description: str = ""):
+        self.description = description

plato/worlds/models.py

@@ -0,0 +1,23 @@
+"""Data models for Plato worlds."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class Observation(BaseModel):
+    """Observation returned from reset/step."""
+
+    data: dict[str, Any] = Field(default_factory=dict)
+
+    model_config = {"extra": "allow"}
+
+
+class StepResult(BaseModel):
+    """Result of a step."""
+
+    observation: Observation
+    done: bool = False
+    info: dict[str, Any] = Field(default_factory=dict)

plato/worlds/schema.py

@@ -0,0 +1,154 @@
+"""JSON schema generation for Plato world configurations."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from plato.worlds.markers import Agent, Env, EnvList, Secret
+
+if TYPE_CHECKING:
+    from plato.worlds.config import RunConfig
+
+
+def get_field_annotations(config_cls: type[RunConfig]) -> dict[str, Agent | Secret | Env | EnvList | None]:
+    """Get Agent/Secret/Env/EnvList annotations for each field.
+
+    Args:
+        config_cls: The RunConfig subclass to inspect
+
+    Returns:
+        Dict mapping field name to annotation marker (or None if no marker)
+    """
+    result: dict[str, Agent | Secret | Env | EnvList | None] = {}
+
+    for field_name, field_info in config_cls.model_fields.items():
+        marker = None
+
+        for meta in field_info.metadata:
+            if isinstance(meta, (Agent, Secret, Env, EnvList)):
+                marker = meta
+                break
+
+        result[field_name] = marker
+
+    return result
+
+
+def get_world_config_schema(config_cls: type[RunConfig]) -> dict[str, Any]:
+    """Get JSON schema for a world config with agents, secrets, and envs separated.
+
+    Args:
+        config_cls: The RunConfig subclass to generate schema for
+
+    Returns:
+        JSON schema dict with properties, required, agents, secrets, and envs fields
+    """
+    full_schema = config_cls.model_json_schema()
+    full_schema.pop("title", None)
+
+    annotations = get_field_annotations(config_cls)
+    properties = full_schema.get("properties", {})
+
+    world_properties: dict[str, Any] = {}
+    agents: list[dict[str, Any]] = []
+    secrets: list[dict[str, Any]] = []
+    envs: list[dict[str, Any]] = []
+    env_list_field: dict[str, Any] | None = None
+
+    # Skip runtime fields
+    runtime_fields = {"session_id", "otel_url", "upload_url", "plato_session", "checkpoint", "state"}
+
+    for field_name, prop_schema in properties.items():
+        if field_name in runtime_fields:
+            continue
+
+        marker = annotations.get(field_name)
+
+        if isinstance(marker, Agent):
+            agents.append(
+                {
+                    "name": field_name,
+                    "description": marker.description,
+                    "required": marker.required,
+                }
+            )
+        elif isinstance(marker, Secret):
+            secrets.append(
+                {
+                    "name": field_name,
+                    "description": marker.description,
+                    "required": marker.required,
+                }
+            )
+        elif isinstance(marker, Env):
+            # Get default value for this env field
+            field_info = config_cls.model_fields.get(field_name)
+            default_value = None
+            if field_info and field_info.default is not None:
+                default_env = field_info.default
+                if hasattr(default_env, "model_dump"):
+                    default_value = default_env.model_dump()
+                elif isinstance(default_env, dict):
+                    default_value = default_env
+
+            envs.append(
+                {
+                    "name": field_name,
+                    "description": marker.description,
+                    "required": marker.required,
+                    "default": default_value,
+                }
+            )
+        elif isinstance(marker, EnvList):
+            env_list_field = {
+                "name": field_name,
+                "description": marker.description,
+            }
+        else:
+            world_properties[field_name] = prop_schema
+
+    # Compute required fields (excluding runtime and annotated fields)
+    required = [r for r in full_schema.get("required", []) if r not in runtime_fields and annotations.get(r) is None]
+
+    result: dict[str, Any] = {
+        "properties": world_properties,
+        "required": required,
+        "agents": agents,
+        "secrets": secrets,
+        "envs": envs,
+    }
+
+    # Include $defs if present (for nested type references)
+    if "$defs" in full_schema:
+        result["$defs"] = full_schema["$defs"]
+
+    # Add env_list if present (for worlds with arbitrary environment lists)
+    if env_list_field:
+        result["env_list"] = env_list_field
+
+    return result
+
+
+def get_world_schema(world_cls: type) -> dict[str, Any]:
+    """Get full schema for a world including config, agents, secrets, and envs.
+
+    Args:
+        world_cls: The BaseWorld subclass to generate schema for
+
+    Returns:
+        JSON schema dict with all schema sections
+    """
+    config_class = world_cls.get_config_class()
+    schema = get_world_config_schema(config_class)
+
+    return {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": schema.get("properties", {}),
+        "required": schema.get("required", []),
+        "agents": schema.get("agents", []),
+        "secrets": schema.get("secrets", []),
+        "envs": schema.get("envs", []),
+        "$defs": schema.get("$defs"),
+        "env_list": schema.get("env_list"),
+    }

{plato_sdk_v2-2.8.8.dist-info → plato_sdk_v2-2.9.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plato-sdk-v2
-Version: 2.8.8
+Version: 2.9.1
 Summary: Python SDK for the Plato API
 Author-email: Plato <support@plato.so>
 License-Expression: MIT

{plato_sdk_v2-2.8.8.dist-info → plato_sdk_v2-2.9.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
 plato/__init__.py,sha256=a9E0KS1602GWHHStnf7wDEuvPCvh2GpPh0Sf8oKZx5Q,1795
 plato/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plato/_generated/__init__.py,sha256=QYMNzMRKMtV-VVoZAH6LWQGUdf0juNNaYQNUoUf_DtU,738
+plato/_generated/__init__.py,sha256=fu4NDoHmSX5gCLo8mYxDWyv9fcFcoJ8H-IkKzAeYsC0,738
 plato/_generated/client.py,sha256=_oMKXyAShQVddCaIKnfB2zPkRsDlCwLp-N3RFoKq_v8,5489
 plato/_generated/errors.py,sha256=goTGrZ4rrujGZ-BoOonoyaGwdGDkGO6GyeubIkQVv9E,4197
 plato/_generated/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -192,7 +192,7 @@ plato/_generated/api/v1/testcases/get_organization_test_case_assignments.py,sha2
 plato/_generated/api/v1/testcases/get_testcase.py,sha256=EydIk-2zdS6XT9-btLWCE5i-N2lT7AlAe5amQQJNn-c,866
 plato/_generated/api/v1/testcases/get_testcase_metadata_for_scoring.py,sha256=i4xUaUisTUKsKnaV8sv2B-H1lgyBd9vKxR1TpOtvbcw,1948
 plato/_generated/api/v1/testcases/get_testcase_sets.py,sha256=NSqnYWvj_G3ivnuuV797g85NGzHXi3z-UlvvRoFMwRM,1375
-plato/_generated/api/v1/testcases/get_testcases.py,sha256=AjsC2aw1VJOtGEe-Km36uVktdxR6IRahhbHCjeAUxcY,5756
+plato/_generated/api/v1/testcases/get_testcases.py,sha256=KV8H4Yf3PYMqMpHIDGty59CHPqPdHvcPNZ-WD2H17Z4,6586
 plato/_generated/api/v1/testcases/get_testcases_in_set.py,sha256=TJK2KHmGC5lNmBPoAXbZ6FktUael9v8Ecl4M8XAhceg,1501
 plato/_generated/api/v1/testcases/mark_organization_test_case_completed.py,sha256=bbtE5PWIA9X0EkyrSXE8YN0gp6x6sfno0rc02AK_-l0,1521
 plato/_generated/api/v1/testcases/update_testcase.py,sha256=-kTW31ioDzQvr2AmOv9gHL7jN6K9qhGyjnJfNHETwhA,1699
@@ -315,7 +315,7 @@ plato/_generated/api/v2/work_orders/get_work_order.py,sha256=dOOTdoS_tJSoLKYlvUb
 plato/_generated/api/v2/work_orders/list_work_orders.py,sha256=buAOqkAbCma9aODSEKRt0es36oVDdv_Y4jb-EkkC668,2026
 plato/_generated/api/version/__init__.py,sha256=dQXTYrXjD1RZcvWwnlqXWAZ-eAV-V-6JSNuY7uaca7o,70
 plato/_generated/api/version/check.py,sha256=HTVNw0oi9gbvX4pOVoH4y4JywCxdl1pJTCk2PjJFwJ4,778
-plato/_generated/models/__init__.py,sha256=goJEywXdEra3Su3zZ2qknqMomKvQM88zNLU-MbdgwNE,173217
+plato/_generated/models/__init__.py,sha256=7YoPXRoeRyVIPvRE5zMBg3OKSF69CmaMyJrXGJ0uFBs,173719
 plato/_sims_generator/__init__.py,sha256=Km4QOl9wxjQ5dgpdhk9QnBFJFFc9eq3rPbMWIQRjIn0,1602
 plato/_sims_generator/cli.py,sha256=mzolN-dxfMkVAdA-vC0esnai-cGg-i4ozOw8dACefV4,2709
 plato/_sims_generator/instruction.py,sha256=Na9M-jIdBPhp_fLuBPTicoFnWriRyi8YiZ-eQBj64HI,6644
@@ -332,11 +332,13 @@ plato/_sims_generator/templates/python/tag_init.py.jinja,sha256=WB_9cv0JKIVg5TOX
 plato/_sims_generator/templates/python/version_init.py.jinja,sha256=sGvFcYVfzXFyQDAe0PSOrg9yys93KE0XInFQNb1TvCY,179
 plato/agents/__init__.py,sha256=Cxc-HUMwRGQ4D1hHnFo9vt2AV5upPRYP4e3y8X6Hzr0,3052
 plato/agents/artifacts.py,sha256=ljeI0wzsp7Q6uKqMb-k7kTb680Vizs54ohtM-d7zvOg,2929
-plato/agents/base.py,sha256=vUbPQuNSo6Ka2lIB_ZOXgi4EoAjtAD7GIj9LnNotam0,4577
+plato/agents/base.py,sha256=5vRIENOr4hzDSMgcKJFggbIdf9pS0OXLb1KAIjUmFJM,4423
 plato/agents/build.py,sha256=CNMbVQFs2_pYit1dA29Davve28Yi4c7TNK9wBB7odrE,1621
-plato/agents/config.py,sha256=GWXEAbruNVI2q3XIWpQ9vGLK2wGhsFPYA-oekmAlrg8,5392
-plato/agents/otel.py,sha256=A2LkkjBtjSe0eztr9UvYvSUOwfmShCgPg3OUN8nOyIo,9159
+plato/agents/config.py,sha256=1OcidjteU-kPUZhFnYwscsboEBliC8LcpxpkFKumCuI,3608
+plato/agents/markers.py,sha256=fZSke6Btm2IFsTFhRQMrRcr6W2c594FwD3n45vb6JRQ,559
+plato/agents/otel.py,sha256=_aEKZbLard8jdUAIZDS46LSutdcT8J7vY-FrN8c4SUE,7247
 plato/agents/runner.py,sha256=Y-e5fCfPJpG1Wo1ICLco8kHzm7u-kbzwgbvLH3XBN-w,7969
+plato/agents/schema.py,sha256=FuBfDu0mrSXgyI3-egFOvCQmRk6VsWUCN1YZ9t8vYbI,2747
 plato/agents/trajectory.py,sha256=WdiBmua0KvCrNaM3qgPI7-7B4xmSkfbP4oZ_9_8qHzU,10529
 plato/chronos/__init__.py,sha256=RHMvSrQS_-vkKOyTRuAkp2gKDP1HEuBLDnw8jcZs1Jg,739
 plato/chronos/client.py,sha256=YcOGtHWERyOD9z8LKt8bRMVL0cEwL2hiAP4qQgdZlUI,5495
@@ -426,11 +428,11 @@ plato/chronos/api/worlds/create_world.py,sha256=H6yl5QIazNXgryOR5rvscSIMf8Y9kjc6
 plato/chronos/api/worlds/delete_world.py,sha256=UETu3Zk0e2VkDdAyMilv1ev-0g_j-oujH1Dc8DBqQOc,1239
 plato/chronos/api/worlds/get_world.py,sha256=eHTM1U5JiNTaZwYLh7x4QVBoRQeI5kaJ9o6xSi4-nos,1356
 plato/chronos/api/worlds/list_worlds.py,sha256=hBAuGb69tlasyn-kV_LNr9x6Rr7SHhST5hXJn1uqMf8,1253
-plato/chronos/models/__init__.py,sha256=M2dV42UmYgsNC4M76jOO4vILgzNvM6m3BGpf6McfFwE,23198
+plato/chronos/models/__init__.py,sha256=fGWDhReLc8IfOAM7fk2oVnqDKopwMNm6IVYlviQw2S4,23194
 plato/cli/__init__.py,sha256=UsKj-69eWKuAlk-Fiwlrz0GJiBfuOmcf-ZLmZJb21Vo,102
 plato/cli/agent.py,sha256=5qA0T1n0H0JQ5ZB-fAVKm3Nw-y_M-GiSQx1OTcKgkrI,44050
 plato/cli/audit_ui.py,sha256=AfnC3wngGV3ujg9POHNYQhal2S6Hr0ZhcXrAAxtVfMg,12307
-plato/cli/chronos.py,sha256=yZeP837trC9lSgyZ0mCTkNIMamz14Rd7YY1TyVgvTGc,31008
+plato/cli/chronos.py,sha256=6QkHVdZxLyevbLJm43HFPJDCpkzFPRFikVhJ_fZR5D4,27863
 plato/cli/compose.py,sha256=MIUBFbYeRO8TyUadUSnhgtWsh1M3LQHF-WLEbmFxIW0,51802
 plato/cli/main.py,sha256=euLI0aw42SG2KIAX1xzMZ2A1LYWNOYayZ2ZCZo10ws4,6984
 plato/cli/pm.py,sha256=eex5K2JucJWzlK81tyBfJrntwZiX_QrmgeKQluv0XKc,54829
@@ -536,12 +538,15 @@ plato/v2/utils/gateway_tunnel.py,sha256=eWgwf4VV8-jx6iCuHFgCISsAOVmNOOjCB56EuZLs
 plato/v2/utils/models.py,sha256=PwehSSnIRG-tM3tWL1PzZEH77ZHhIAZ9R0UPs6YknbM,1441
 plato/v2/utils/proxy_tunnel.py,sha256=8ZTd0jCGSfIHMvSv1fgEyacuISWnGPHLPbDglWroTzY,10463
 plato/worlds/README.md,sha256=XFOkEA3cNNcrWkk-Cxnsl-zn-y0kvUENKQRSqFKpdqw,5479
-plato/worlds/__init__.py,sha256=nwuEerEkP2TSfadPiOMcUE3p6u1vhaS7ZxfTh2zNcF8,2217
-plato/worlds/base.py,sha256=-RR71bSxEFI5yydtrtq-AAbuw98CIjvmrbztqzB9oIc,31041
+plato/worlds/__init__.py,sha256=1n23AAev3RZrKHpeSXoCnCVJ5TRtP88jVvagLMxISgg,2256
+plato/worlds/base.py,sha256=pjriEuu-_PcpgBqc0tQmMQnsa08oZrCP83lC586liKo,28237
 plato/worlds/build_hook.py,sha256=KSoW0kqa5b7NyZ7MYOw2qsZ_2FkWuz0M3Ru7AKOP7Qw,3486
-plato/worlds/config.py,sha256=O1lUXzxp-Z_M7izslT8naXgE6XujjzwYFFrDDzUOueI,12736
+plato/worlds/config.py,sha256=pmeOxVHLwL-DI5zzU04Pa5wng66LX2suCxd4ey9lAfU,7486
+plato/worlds/markers.py,sha256=dB4jOVYHWFm82LqskjQ4igrFp89H2FSgv8nfBXMf550,1762
+plato/worlds/models.py,sha256=dN_Lsmy4yBuyd5D17kbL4Qy9VKc-06Ea1ombXC3b-Gk,477
 plato/worlds/runner.py,sha256=r9B2BxBae8_dM7y5cJf9xhThp_I1Qvf_tlPq2rs8qC8,4013
-plato_sdk_v2-2.8.8.dist-info/METADATA,sha256=nWIt8b0h91AbIIvkuTwin5Uq9cLaIlqExgbdnvpM-oA,8652
-plato_sdk_v2-2.8.8.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-plato_sdk_v2-2.8.8.dist-info/entry_points.txt,sha256=iynJvTkU7E4MZNtSozVF0Wh083yPm6cuKV362Ol_ez8,133
-plato_sdk_v2-2.8.8.dist-info/RECORD,,
+plato/worlds/schema.py,sha256=Wn_nwvOyVYWZAVQwzMtHMxnyBWcGT4X55sbiTruwQZs,5035
+plato_sdk_v2-2.9.1.dist-info/METADATA,sha256=_YVWdGOSys1TJ2umD2Y-Kgy0QEbITJpeVetH5Mb1k0Q,8652
+plato_sdk_v2-2.9.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+plato_sdk_v2-2.9.1.dist-info/entry_points.txt,sha256=iynJvTkU7E4MZNtSozVF0Wh083yPm6cuKV362Ol_ez8,133
+plato_sdk_v2-2.9.1.dist-info/RECORD,,