ORIONIS API REFERENCE

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.

Explore modules View classes

orionis.http.FileResponse

class documentation

class FileResponse(StreamingResponse): (source)

Constructor: FileResponse(path, status_code, headers, media_type, ...)

View In Hierarchy

Undocumented

Method __init__ Initialize a file streaming response.
Async Method _fileIterator Yield file content in chunks asynchronously.
Method getFileSize Return the file size in bytes.
Method getPath Return the file path.
Class Variable __slots__ Undocumented
Instance Variable _chunk_size Undocumented
Instance Variable _file_size Undocumented
Instance Variable _path Undocumented

Inherited from StreamingResponse:

Async Method _wrapSyncIterable Adapt a synchronous iterable of bytes to an asynchronous iterable.
Instance Variable _body Undocumented

Inherited from Response (via StreamingResponse):

Method addHeader Add a header to the response.
Method deleteCookie Delete a cookie by setting its expiration to the past.
Method getBody Return the response body as bytes.
Method getFlashData Return the data queued by withFlash() for the session flash bag.
Method getHeader Get the values for a header.
Method getMediaType Return the media type of the response.
Method getRawHeaders Return the headers as a list of (key, value) byte tuples.
Method getStatusCode Return the HTTP status code of the response.
Method getStream Return the response stream if present.
Method getStringHeaders Return the headers as a list of (key, value) string tuples.
Method hasHeader Check if a header is present.
Method hasStream Check if the response has a stream.
Method removeHeader Remove a header from the response.
Method render Render the content to bytes.
Async Method runBackground Run the background task if it exists.
Method setCookie Set a cookie header in the response.
Method setHeader Set a header, replacing any existing values.
Method withCookie Attach a cookie and return the response for chaining.
Method withCookies Attach several cookies at once and return the response.
Method withErrors Flash validation errors for the next request.
Method withFlash Flash a status message into the session and return the response.
Method withInput Flash the submitted payload so the next request can repopulate it.
Method withoutCookie Expire a cookie and return the response for chaining.
Class Variable charset Undocumented
Instance Variable _flash Undocumented
Instance Variable _headers Undocumented
Instance Variable _raw_headers Undocumented
Instance Variable _stream Undocumented
Instance Variable background Undocumented
Instance Variable media_type Undocumented
Instance Variable status_code Undocumented
def __init__(self, path: str | Path, status_code: int = 200, headers: Mapping[str, str] | None = None, media_type: str | None = None, filename: str | None = None, chunk_size: int = 64 * 1024, background: BackgroundTask | None = None): (source)
overrides orionis.http.StreamingResponse.__init__

Initialize a file streaming response.

Parameters
path:str | PathPath to the file to serve.
status_code:int, default 200HTTP status code for the response.
headers:Mapping[str, str] | None, optionalOptional response headers.
media_type:str | None, optionalOptional media type for the response.
filename:str | None, optionalOptional filename for Content-Disposition header.
chunk_size:int, default 65536Size of file chunks to read and send.
background:BackgroundTask | None, optionalOptional background task to run after response.
Returns
NoneThis constructor does not return a value.
async def _fileIterator(self) -> AsyncIterable[bytes]: (source)

Yield file content in chunks asynchronously.

Returns
AsyncIterable[bytes]An asynchronous iterable yielding file chunks as bytes.
def getFileSize(self) -> int: (source)

Return the file size in bytes.

Returns
intThe size of the file in bytes.
def getPath(self) -> Path: (source)

Return the file path.

Returns
PathThe path to the file being served.
__slots__: tuple[str, ...] = (source)
overrides orionis.http.StreamingResponse.__slots__

Undocumented

_chunk_size = (source)

Undocumented

_file_size = (source)

Undocumented

_path = (source)

Undocumented