tractor/docs/api/index.rst

1.6 KiB

API reference

This is the curated reference for tractor's public surface: the names you can import and lean on without reading runtime internals. Everything below is re-exported at the top level (import tractor) unless a page says otherwise; subsystems like tractor.msg, tractor.trionics, tractor.to_asyncio, tractor.devx and tractor.log are importable as submodules.

tractor is "just trio" extended across processes: every API here is designed to keep the structured concurrency (SC) rules you already know from the trio docs intact across the process boundary. If a name isn't documented here it's an internal — expect it to change without notice B).

tractor

Most-used names at a glance:

open_root_actor open_nursery run_daemon ActorNursery Portal context Context MsgStream open_actor_cluster find_actor wait_for_actor get_registry current_actor current_ipc_ctx is_root_process get_runtime_vars RemoteActorError ContextCancelled MsgTypeError pause post_mortem Channel

core context discovery errors msg trionics to_asyncio devx ipc

Where to next? If you're new, start with the runtime and spawning APIs in /api/core, then graduate to the inter-actor task linking model in /api/context — it's the heart of the whole system.