Skip to content

Commit 0599baf

Browse files
committed
docs: Add docstrings to base transport methods.
1 parent be01104 commit 0599baf

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

src/a2a/client/transports/base.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,7 @@ async def send_message(
190190
context: ClientCallContext | None = None,
191191
extensions: list[str] | None = None,
192192
) -> SendMessageResponse:
193+
"""Sends a streaming message request to the agent and yields responses as they arrive."""
193194
self.update_tenant(request)
194195
return await self._base.send_message(
195196
request, context=context, extensions=extensions
@@ -202,6 +203,7 @@ async def send_message_streaming(
202203
context: ClientCallContext | None = None,
203204
extensions: list[str] | None = None,
204205
) -> AsyncGenerator[StreamResponse]:
206+
"""Sends a streaming message request to the agent and yields responses."""
205207
self.update_tenant(request)
206208
async for event in self._base.send_message_streaming(
207209
request, context=context, extensions=extensions
@@ -215,6 +217,7 @@ async def get_task(
215217
context: ClientCallContext | None = None,
216218
extensions: list[str] | None = None,
217219
) -> Task:
220+
"""Retrieves the current state and history of a specific task."""
218221
self.update_tenant(request)
219222
return await self._base.get_task(
220223
request, context=context, extensions=extensions
@@ -227,6 +230,7 @@ async def list_tasks(
227230
context: ClientCallContext | None = None,
228231
extensions: list[str] | None = None,
229232
) -> ListTasksResponse:
233+
"""Retrieves tasks for an agent."""
230234
self.update_tenant(request)
231235
return await self._base.list_tasks(
232236
request, context=context, extensions=extensions
@@ -239,6 +243,7 @@ async def cancel_task(
239243
context: ClientCallContext | None = None,
240244
extensions: list[str] | None = None,
241245
) -> Task:
246+
"""Requests the agent to cancel a specific task."""
242247
self.update_tenant(request)
243248
return await self._base.cancel_task(
244249
request, context=context, extensions=extensions
@@ -251,6 +256,7 @@ async def set_task_callback(
251256
context: ClientCallContext | None = None,
252257
extensions: list[str] | None = None,
253258
) -> TaskPushNotificationConfig:
259+
"""Sets or updates the push notification configuration for a specific task."""
254260
self.update_tenant(request)
255261
return await self._base.set_task_callback(
256262
request, context=context, extensions=extensions
@@ -263,6 +269,7 @@ async def get_task_callback(
263269
context: ClientCallContext | None = None,
264270
extensions: list[str] | None = None,
265271
) -> TaskPushNotificationConfig:
272+
"""Retrieves the push notification configuration for a specific task."""
266273
self.update_tenant(request)
267274
return await self._base.get_task_callback(
268275
request, context=context, extensions=extensions
@@ -275,6 +282,7 @@ async def list_task_callback(
275282
context: ClientCallContext | None = None,
276283
extensions: list[str] | None = None,
277284
) -> ListTaskPushNotificationConfigsResponse:
285+
"""Lists push notification configurations for a specific task."""
278286
self.update_tenant(request)
279287
return await self._base.list_task_callback(
280288
request, context=context, extensions=extensions
@@ -287,6 +295,7 @@ async def delete_task_callback(
287295
context: ClientCallContext | None = None,
288296
extensions: list[str] | None = None,
289297
) -> None:
298+
"""Deletes the push notification configuration for a specific task."""
290299
self.update_tenant(request)
291300
await self._base.delete_task_callback(
292301
request, context=context, extensions=extensions
@@ -299,6 +308,7 @@ async def subscribe(
299308
context: ClientCallContext | None = None,
300309
extensions: list[str] | None = None,
301310
) -> AsyncGenerator[StreamResponse]:
311+
"""Reconnects to get task updates."""
302312
self.update_tenant(request)
303313
async for event in self._base.subscribe(
304314
request, context=context, extensions=extensions
@@ -312,11 +322,13 @@ async def get_extended_agent_card(
312322
extensions: list[str] | None = None,
313323
signature_verifier: Callable[[AgentCard], None] | None = None,
314324
) -> AgentCard:
325+
"""Retrieves the Extended AgentCard."""
315326
return await self._base.get_extended_agent_card(
316327
context=context,
317328
extensions=extensions,
318329
signature_verifier=signature_verifier,
319330
)
320331

321332
async def close(self) -> None:
333+
"""Closes the transport."""
322334
await self._base.close()

0 commit comments

Comments
 (0)