acp-sdk 0.3.0__tar.gz → 0.3.2__tar.gz

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acp-sdk
-Version: 0.3.0
+Version: 0.3.2
 Summary: Agent Communication Protocol SDK
 Author: IBM Corp.
 Maintainer-email: Tomas Pilar <thomas7pilar@gmail.com>
@@ -28,19 +28,7 @@ Agent Communication Protocol SDK for Python provides allows developers to serve
 
 ## Installation
 
-Install to use client:
-
-```shell
-pip install acp-sdk[client]
-```
-
-Install to use server:
-
-```shell
-pip install acp-sdk[server]
-```
-
-Install to use models only:
+Install with:
 
 ```shell
 pip install acp-sdk

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/README.md

@@ -8,19 +8,7 @@ Agent Communication Protocol SDK for Python provides allows developers to serve
 
 ## Installation
 
-Install to use client:
-
-```shell
-pip install acp-sdk[client]
-```
-
-Install to use server:
-
-```shell
-pip install acp-sdk[server]
-```
-
-Install to use models only:
+Install with:
 
 ```shell
 pip install acp-sdk

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/examples/clients/advanced.py

@@ -13,9 +13,7 @@ async def example() -> None:
             # Additional client configuration
         )
     ) as client:
-        run = await client.run_sync(
-            agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!", content_type="text/plain")])]
-        )
+        run = await client.run_sync(agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!")])])
         print(run)
 
 

acp_sdk-0.3.2/examples/clients/session.py

@@ -0,0 +1,18 @@
+import asyncio
+
+from acp_sdk.client import Client
+from acp_sdk.models import (
+    Message,
+    MessagePart,
+)
+
+
+async def example() -> None:
+    async with Client(base_url="http://localhost:8000") as client, client.session() as session:
+        run = await session.run_sync(agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!")])])
+        run = await session.run_sync(agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy again!")])])
+        print(run)
+
+
+if __name__ == "__main__":
+    asyncio.run(example())

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/examples/clients/simple.py

@@ -9,9 +9,7 @@ from acp_sdk.models import (
 
 async def example() -> None:
     async with Client(base_url="http://localhost:8000") as client:
-        run = await client.run_sync(
-            agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!", content_type="text/plain")])]
-        )
+        run = await client.run_sync(agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!")])])
         print(run)
 
 

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/examples/clients/stream.py

@@ -6,9 +6,7 @@ from acp_sdk.models import Message, MessagePart
 
 async def example() -> None:
     async with Client(base_url="http://localhost:8000") as client:
-        async for event in client.run_stream(
-            agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!", content_type="text/plain")])]
-        ):
+        async for event in client.run_stream(agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!")])]):
             print(event)
 
 

acp_sdk-0.3.2/examples/servers/awaiting.py

@@ -0,0 +1,26 @@
+from collections.abc import AsyncGenerator
+
+from acp_sdk.models import (
+    Message,
+    MessageAwaitRequest,
+    MessageAwaitResume,
+    MessagePart,
+)
+from acp_sdk.server import Context, Server
+from acp_sdk.server.types import RunYield, RunYieldResume
+
+server = Server()
+
+
+@server.agent()
+async def awaiting(inputs: list[Message], context: Context) -> AsyncGenerator[RunYield, RunYieldResume]:
+    """Greets and awaits for more data"""
+    yield MessagePart(content="Hello!")
+    resume = yield MessageAwaitRequest(
+        message=Message(parts=[MessagePart(content="Can you provide me with additional configuration?")])
+    )
+    assert isinstance(resume, MessageAwaitResume)
+    yield MessagePart(content=f"Thanks for config: {resume.message}")
+
+
+server.run()

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "acp-sdk"
-version = "0.3.0"
+version = "0.3.2"
 description = "Agent Communication Protocol SDK"
 license = "Apache-2.0"
 readme = "README.md"

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/src/acp_sdk/models/models.py

@@ -17,12 +17,12 @@ class AnyModel(BaseModel):
 
 class MessagePart(BaseModel):
     name: Optional[str] = None
-    content_type: str
+    content_type: Optional[str] = "text/plain"
     content: Optional[str] = None
     content_encoding: Optional[Literal["plain", "base64"]] = "plain"
     content_url: Optional[AnyUrl] = None
 
-    model_config = ConfigDict(extra="forbid")
+    model_config = ConfigDict(extra="allow")
 
     def model_post_init(self, __context: Any) -> None:
         if self.content is None and self.content_url is None:
@@ -48,6 +48,36 @@ class Message(BaseModel):
             part.content for part in self.parts if part.content is not None and part.content_type == "text/plain"
         )
 
+    def compress(self) -> "Message":
+        def can_be_joined(first: MessagePart, second: MessagePart) -> bool:
+            return (
+                first.name is None
+                and second.name is None
+                and first.content_type == "text/plain"
+                and second.content_type == "text/plain"
+                and first.content_encoding == "plain"
+                and second.content_encoding == "plain"
+                and first.content_url is None
+                and second.content_url is None
+            )
+
+        def join(first: MessagePart, second: MessagePart) -> MessagePart:
+            return MessagePart(
+                name=None,
+                content_type="text/plain",
+                content=first.content + second.content,
+                content_encoding="plain",
+                content_url=None,
+            )
+
+        parts: list[MessagePart] = []
+        for part in self.parts:
+            if len(parts) > 0 and can_be_joined(parts[-1], part):
+                parts[-1] = join(parts[-1], part)
+            else:
+                parts.append(part)
+        return Message(parts=parts)
+
 
 AgentName = str
 SessionId = uuid.UUID
@@ -75,12 +105,18 @@ class RunStatus(str, Enum):
         return self in terminal_states
 
 
-class AwaitRequest(BaseModel):
-    type: Literal["placeholder"] = "placeholder"
+class MessageAwaitRequest(BaseModel):
+    type: Literal["message"] = "message"
+    message: Message
+
+
+class MessageAwaitResume(BaseModel):
+    type: Literal["message"] = "message"
+    message: Message
 
 
-class AwaitResume(BaseModel):
-    pass
+AwaitRequest = Union[MessageAwaitRequest]
+AwaitResume = Union[MessageAwaitResume]
 
 
 class Run(BaseModel):

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/src/acp_sdk/server/app.py

@@ -144,6 +144,16 @@ def create_app(*agents: Agent) -> FastAPI:
     @app.post("/runs/{run_id}")
     async def resume_run(run_id: RunId, request: RunResumeRequest) -> RunResumeResponse:
         bundle = find_run_bundle(run_id)
+
+        if bundle.run.await_request is None:
+            raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail=f"Run {run_id} has no await request")
+
+        if bundle.run.await_request.type != request.await_resume.type:
+            raise HTTPException(
+                status_code=status.HTTP_403_FORBIDDEN,
+                detail=f"Run {run_id} is expecting resume of type {bundle.run.await_request.type}",
+            )
+
         await bundle.resume(request.await_resume)
         match request.mode:
             case RunMode.STREAM:

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/src/acp_sdk/server/bundle.py

@@ -129,6 +129,8 @@ class RunBundle:
                         run_logger.info("Run resumed")
                     elif isinstance(next, Error):
                         raise ACPError(error=next)
+                    elif next is None:
+                        pass  # Do nothing
                     else:
                         try:
                             generic = AnyModel.model_validate(next)

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/src/acp_sdk/server/types.py

@@ -2,5 +2,5 @@ from typing import Any
 
 from acp_sdk.models import AwaitRequest, AwaitResume, Message
 
-RunYield = Message | AwaitRequest | dict[str | Any]
+RunYield = Message | AwaitRequest | dict[str | Any] | None
 RunYieldResume = AwaitResume | None

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/tests/e2e/fixtures/server.py

@@ -4,7 +4,7 @@ from collections.abc import AsyncGenerator, AsyncIterator, Generator
 from threading import Thread
 
 import pytest
-from acp_sdk.models import Artifact, AwaitRequest, AwaitResume, Error, ErrorCode, Message, MessagePart
+from acp_sdk.models import Artifact, AwaitResume, Error, ErrorCode, Message, MessageAwaitRequest, MessagePart
 from acp_sdk.server import Context, Server
 
 from e2e.config import Config
@@ -20,8 +20,10 @@ def server() -> Generator[None]:
             yield message
 
     @server.agent()
-    async def awaiter(inputs: list[Message], context: Context) -> AsyncGenerator[Message | AwaitRequest, AwaitResume]:
-        yield AwaitRequest()
+    async def awaiter(
+        inputs: list[Message], context: Context
+    ) -> AsyncGenerator[Message | MessageAwaitRequest, AwaitResume]:
+        yield MessageAwaitRequest(message=Message(parts=[]))
         yield MessagePart(content="empty", content_type="text/plain")
 
     @server.agent()

{acp_sdk-0.3.0 → acp_sdk-0.3.2}/tests/e2e/test_suites/test_runs.py

@@ -4,9 +4,9 @@ import pytest
 from acp_sdk.client import Client
 from acp_sdk.models import (
     ArtifactEvent,
-    AwaitResume,
     ErrorCode,
     Message,
+    MessageAwaitResume,
     MessageCreatedEvent,
     MessagePart,
     RunCompletedEvent,
@@ -16,7 +16,8 @@ from acp_sdk.models import (
 )
 from acp_sdk.server import Server
 
-inputs = [Message(parts=[MessagePart(content="Hello!", content_type="text/plain")])]
+inputs = [Message(parts=[MessagePart(content="Hello!")])]
+await_resume = MessageAwaitResume(message=Message(parts=[]))
 
 
 @pytest.mark.asyncio
@@ -69,7 +70,7 @@ async def test_run_resume_sync(server: Server, client: Client) -> None:
     assert run.status == RunStatus.AWAITING
     assert run.await_request is not None
 
-    run = await client.run_resume_sync(run_id=run.run_id, await_resume=AwaitResume())
+    run = await client.run_resume_sync(run_id=run.run_id, await_resume=await_resume)
     assert run.status == RunStatus.COMPLETED
 
 
@@ -79,7 +80,7 @@ async def test_run_resume_async(server: Server, client: Client) -> None:
     assert run.status == RunStatus.AWAITING
     assert run.await_request is not None
 
-    run = await client.run_resume_async(run_id=run.run_id, await_resume=AwaitResume())
+    run = await client.run_resume_async(run_id=run.run_id, await_resume=await_resume)
     assert run.status == RunStatus.IN_PROGRESS
 
 
@@ -89,7 +90,7 @@ async def test_run_resume_stream(server: Server, client: Client) -> None:
     assert run.status == RunStatus.AWAITING
     assert run.await_request is not None
 
-    event_stream = [event async for event in client.run_resume_stream(run_id=run.run_id, await_resume=AwaitResume())]
+    event_stream = [event async for event in client.run_resume_stream(run_id=run.run_id, await_resume=await_resume)]
     assert isinstance(event_stream[0], RunInProgressEvent)
     assert isinstance(event_stream[-1], RunCompletedEvent)
 

acp_sdk-0.3.2/tests/unit/models/test_models.py

@@ -0,0 +1,37 @@
+import pytest
+from acp_sdk.models.models import Message, MessagePart
+
+
+@pytest.mark.parametrize(
+    "uncompressed,compressed",
+    [
+        (
+            Message(
+                parts=[
+                    MessagePart(content_type="text/plain", content="Foo"),
+                    MessagePart(content_type="text/plain", content="Bar"),
+                ]
+            ),
+            Message(parts=[MessagePart(content_type="text/plain", content="FooBar")]),
+        ),
+        (
+            Message(
+                parts=[
+                    MessagePart(content_type="text/plain", content="Foo"),
+                    MessagePart(content_type="text/html", content="<head>"),
+                    MessagePart(content_type="text/plain", content="Foo"),
+                    MessagePart(content_type="text/plain", content="Bar"),
+                ]
+            ),
+            Message(
+                parts=[
+                    MessagePart(content_type="text/plain", content="Foo"),
+                    MessagePart(content_type="text/html", content="<head>"),
+                    MessagePart(content_type="text/plain", content="FooBar"),
+                ]
+            ),
+        ),
+    ],
+)
+def test_message_compress(uncompressed: Message, compressed: Message) -> None:
+    assert uncompressed.compress() == compressed

acp_sdk-0.3.0/examples/clients/session.py

@@ -1,22 +0,0 @@
-import asyncio
-
-from acp_sdk.client import Client
-from acp_sdk.models import (
-    Message,
-    MessagePart,
-)
-
-
-async def example() -> None:
-    async with Client(base_url="http://localhost:8000") as client, client.session() as session:
-        run = await session.run_sync(
-            agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!", content_type="text/plain")])]
-        )
-        run = await session.run_sync(
-            agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy again!", content_type="text/plain")])]
-        )
-        print(run)
-
-
-if __name__ == "__main__":
-    asyncio.run(example())

acp_sdk-0.3.0/examples/servers/awaiting.py

@@ -1,25 +0,0 @@
-from collections.abc import AsyncGenerator
-from typing import Any
-
-from acp_sdk.models import (
-    AwaitRequest,
-    AwaitResume,
-    Message,
-    MessagePart,
-)
-from acp_sdk.server import Context, Server
-
-server = Server()
-
-
-@server.agent()
-async def awaiting(
-    inputs: list[Message], context: Context
-) -> AsyncGenerator[Message | AwaitRequest | Any, AwaitResume]:
-    """Greets and awaits for more data"""
-    yield MessagePart(content="Hello!", content_type="text/plain")
-    data = yield AwaitRequest()
-    yield MessagePart(content=f"Thanks for {data}", content_type="text/plain")
-
-
-server.run()