api.rst

API reference

Event loop

anyio.run

anyio.get_all_backends

anyio.get_cancelled_exc_class

anyio.sleep

anyio.sleep_forever

anyio.sleep_until

anyio.current_time

Asynchronous resources

anyio.aclose_forcefully

anyio.abc.AsyncResource

Typed attributes

anyio.typed_attribute

anyio.TypedAttributeSet

anyio.TypedAttributeProvider

Timeouts and cancellation

anyio.move_on_after

anyio.fail_after

anyio.current_effective_deadline

anyio.CancelScope

Task groups

anyio.create_task_group

anyio.abc.TaskGroup

anyio.abc.TaskStatus

Running code in worker threads

anyio.to_thread.run_sync

anyio.to_thread.current_default_thread_limiter

Running code in worker processes

anyio.to_process.run_sync

anyio.to_process.current_default_process_limiter

Running asynchronous code from other threads

anyio.from_thread.run

anyio.from_thread.run_sync

anyio.from_thread.check_cancelled

anyio.from_thread.start_blocking_portal

anyio.from_thread.BlockingPortal

Async file I/O

anyio.open_file

anyio.wrap_file

anyio.AsyncFile

anyio.Path

Streams and stream wrappers

anyio.create_memory_object_stream

anyio.abc.UnreliableObjectReceiveStream()

anyio.abc.UnreliableObjectSendStream()

anyio.abc.UnreliableObjectStream()

anyio.abc.ObjectReceiveStream()

anyio.abc.ObjectSendStream()

anyio.abc.ObjectStream()

anyio.abc.ByteReceiveStream

anyio.abc.ByteSendStream

anyio.abc.ByteStream

anyio.abc.Listener

anyio.abc.AnyUnreliableByteReceiveStream

anyio.abc.AnyUnreliableByteSendStream

anyio.abc.AnyUnreliableByteStream

anyio.abc.AnyByteReceiveStream

anyio.abc.AnyByteSendStream

anyio.abc.AnyByteStream

anyio.streams.buffered.BufferedByteReceiveStream

anyio.streams.file.FileStreamAttribute

anyio.streams.file.FileReadStream

anyio.streams.file.FileWriteStream

anyio.streams.memory.MemoryObjectReceiveStream

anyio.streams.memory.MemoryObjectSendStream

anyio.streams.memory.MemoryObjectStreamStatistics

anyio.streams.stapled.MultiListener

anyio.streams.stapled.StapledByteStream

anyio.streams.stapled.StapledObjectStream

anyio.streams.text.TextReceiveStream

anyio.streams.text.TextSendStream

anyio.streams.text.TextStream

anyio.streams.tls.TLSAttribute

anyio.streams.tls.TLSStream

anyio.streams.tls.TLSListener

Sockets and networking

anyio.connect_tcp

anyio.connect_unix

anyio.create_tcp_listener

anyio.create_unix_listener

anyio.create_udp_socket

anyio.create_connected_udp_socket

anyio.getaddrinfo

anyio.getnameinfo

anyio.wait_socket_readable

anyio.wait_socket_writable

anyio.abc.SocketAttribute

anyio.abc.SocketStream()

anyio.abc.SocketListener()

anyio.abc.UDPSocket()

anyio.abc.ConnectedUDPSocket()

anyio.abc.UNIXSocketStream()

Subprocesses

anyio.run_process

anyio.open_process

anyio.abc.Process

Synchronization

anyio.Event

anyio.Lock

anyio.Condition

anyio.Semaphore

anyio.CapacityLimiter

anyio.ResourceGuard

anyio.LockStatistics

anyio.EventStatistics

anyio.ConditionStatistics

anyio.CapacityLimiterStatistics

anyio.SemaphoreStatistics

Operating system signals

anyio.open_signal_receiver

Low level operations

anyio.lowlevel.checkpoint

anyio.lowlevel.checkpoint_if_cancelled

anyio.lowlevel.cancel_shielded_checkpoint

anyio.lowlevel.RunVar

Testing and debugging

anyio.TaskInfo

anyio.get_current_task

anyio.get_running_tasks

anyio.wait_all_tasks_blocked

Exceptions

anyio.BrokenResourceError

anyio.BusyResourceError

anyio.ClosedResourceError

anyio.DelimiterNotFound

anyio.EndOfStream

anyio.IncompleteRead

anyio.TypedAttributeLookupError

anyio.WouldBlock