iii-python-sdk

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

The async Python SDK for connecting workers to the iii engine.

用于将worker连接至iii引擎的异步Python SDK。

pip install iii-sdk

pip install iii-sdk

Export	Purpose
`register_worker(address, options?)`	Connect to the engine, returns the client
`InitOptions(worker_name, otel?)`	Connection configuration
`register_function(id, handler)`	Register an async function handler
`register_trigger(type, function_id, config)`	Bind a trigger to a function
`trigger(request)`	Invoke a function synchronously
`trigger_async(request)`	Invoke a function asynchronously
`get_context()`	Access logger and trace context inside handlers
`ApiRequest` / `ApiResponse`	HTTP request/response types (pydantic)
`IStream`	Interface for custom stream implementations
`on_functions_available(callback)`	Listen for function discovery
`on_connection_state_change(callback)`	Monitor connection state

导出项	用途
`register_worker(address, options?)`	连接至引擎，返回客户端
`InitOptions(worker_name, otel?)`	连接配置
`register_function(id, handler)`	注册异步函数处理器
`register_trigger(type, function_id, config)`	将触发器绑定至函数
`trigger(request)`	同步调用函数
`trigger_async(request)`	异步调用函数
`get_context()`	在处理器内访问日志和追踪上下文
`ApiRequest` / `ApiResponse`	HTTP请求/响应类型（基于pydantic）
`IStream`	自定义流实现的接口
`on_functions_available(callback)`	监听函数发现事件
`on_connection_state_change(callback)`	监控连接状态

```
register_worker()
```
returns a synchronous client; handlers are async
```
ApiResponse
```
uses camelCase
```
statusCode
```
(pydantic alias), not
```
status_code
```
End workers with
```
while True: await asyncio.sleep(60)
```
to keep the event loop alive
Use
```
asyncio.to_thread()
```
for CPU-heavy sync work inside handlers
The SDK implements both
```
trigger_async(request)
```
and a synchronous
```
trigger(request)
```
. Use
```
trigger_async
```
inside async handlers, and
```
trigger
```
in synchronous scripts or threads where blocking behavior is desired.

python

undefined

python

undefined

result = await iii.trigger_async({ "function_id": "greet", "payload": {"name": "World"} })

result = iii.trigger({ "function_id": "greet", "payload": {"name": "World"} })

undefined

result = iii.trigger({ "function_id": "greet", "payload": {"name": "World"} })

undefined

Use this skill when the task is primarily about
```
iii-python-sdk
```
in the iii engine.
Triggers when the request directly asks for this pattern or an equivalent implementation.

Never use this skill as a generic fallback for unrelated tasks.
You must not apply this skill when a more specific iii skill is a better fit.
Always verify environment and safety constraints before applying examples from this skill.