orionis.http.adapters.response.files

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

module documentation

(source)

Undocumented

Async Function	`_drain_future`	Wait through repeated cancellation until the worker operation finishes.
Async Function	`complete_file_read`	Complete a pending worker read before propagating cancellation.
Async Function	`open_file`	Open a file in a worker thread.

async def _drain_future(pending: Future[T]) -> T: (source) ¶

Wait through repeated cancellation until the worker operation finishes.

Parameters
pending:`Future[T]`	Worker operation whose resources must remain owned until completion.

Returns
`T`	Completed worker result, including an opened handle awaiting cleanup.

async def complete_file_read(pending: Future[bytes]) -> bytes: (source) ¶

Complete a pending worker read before propagating cancellation.

Parameters
pending:`Future[bytes]`	Future representing the pending file read.

Returns
`bytes`	Bytes returned by the worker read.

Raises
`asyncio.CancelledError`	If the waiting task is cancelled after the read completes.

async def open_file(path: Path, start: int = 0) -> BinaryIO: (source) ¶

Open a file in a worker thread.

Parameters
path:`Path`	Path of the file to open.
start:`int, optional`	Byte offset at which to position the file.

Returns
`BinaryIO`	The opened file positioned at `start`.

Raises
`asyncio.CancelledError`	If the waiting task is cancelled after the file opens.