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.payload.form_data.FormData

class documentation

class FormData(IFormData): (source)

Constructor: FormData(items)

View In Hierarchy

Hold parsed multipart form fields and uploaded files.

Notes

Stores ordered (name, value) pairs and supports multiple values under the same field name. Implements the context-manager protocol to guarantee all open file handles are released on exit.

Method __contains__ Return True if at least one item with key exists.
Method __enter__ Enter the context manager and return this instance.
Method __exit__ Exit the context manager and close all uploaded file handles.
Method __getitem__ Return the last value for key using subscript notation.
Method __init__ Initialize FormData from an ordered list of (name, value) pairs.
Method __iter__ Iterate over unique field names in first-seen insertion order.
Method __len__ Return the number of unique field names.
Method __repr__ Return the canonical string representation.
Method close Close all uploaded file handles to release resources.
Method get Return the last value for key, or default.
Method getAll Return every value for key in insertion order.
Method multiItems Return all (name, value) pairs in insertion order.
Class Variable __slots__ Undocumented
Instance Variable _index Undocumented
Instance Variable _items Undocumented
Property allItems Return all (name, value) pairs in insertion order.
Property fields Return all text field values grouped by name.
Property files Return all uploaded file values grouped by name.
def __contains__(self, key: str) -> bool: (source)
overrides orionis.http.payload.contracts.form_data.IFormData.__contains__

Return True if at least one item with key exists.

Parameters
key:strField name to check.
Returns
boolTrue if key is present, False otherwise.
def __enter__(self) -> Self: (source)
overrides orionis.http.payload.contracts.form_data.IFormData.__enter__

Enter the context manager and return this instance.

Returns
SelfThe FormData instance itself.
def __exit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None): (source)
overrides orionis.http.payload.contracts.form_data.IFormData.__exit__

Exit the context manager and close all uploaded file handles.

Parameters
exc_type:type[BaseException] | NoneException class if one was raised, otherwise None.
exc_val:BaseException | NoneException instance if one was raised, otherwise None.
exc_tb:TracebackType | NoneTraceback if an exception was raised, otherwise None.
Returns
NoneAlways returns None.
def __getitem__(self, key: str) -> object: (source)
overrides orionis.http.payload.contracts.form_data.IFormData.__getitem__

Return the last value for key using subscript notation.

Parameters
key:strField name to retrieve.
Returns
objectLast value for key, or None if absent.
def __init__(self, items: list[tuple[str, str | UploadedFile]]): (source)

Initialize FormData from an ordered list of (name, value) pairs.

Parameters
items:list[tuple[str, str | UploadedFile]]Ordered (field_name, value) pairs from the multipart stream parser. Multiple pairs with the same name are preserved in insertion order.
Returns
NoneAlways returns None.
def __iter__(self) -> Iterator[str]: (source)
overrides orionis.http.payload.contracts.form_data.IFormData.__iter__

Iterate over unique field names in first-seen insertion order.

Returns
Iterator[str]Each unique field name exactly once.
def __len__(self) -> int: (source)
overrides orionis.http.payload.contracts.form_data.IFormData.__len__

Return the number of unique field names.

Returns
intCount of distinct keys, not the total item count.
def __repr__(self) -> str: (source)
overrides orionis.http.payload.contracts.form_data.IFormData.__repr__

Return the canonical string representation.

Returns
strDeveloper-facing string showing the stored item pairs.
def close(self): (source)
overrides orionis.http.payload.contracts.form_data.IFormData.close

Close all uploaded file handles to release resources.

Returns
NoneAlways returns None.
def get(self, key: str, default: object | None = None) -> object | None: (source)
overrides orionis.http.payload.contracts.form_data.IFormData.get

Return the last value for key, or default.

Parameters
key:strField name to look up.
default:object | None, optionalFallback when key is absent. Defaults to None.
Returns
object | NoneLast str or UploadedFile for key, or default.
def getAll(self, key: str) -> list[str | UploadedFile]: (source)
overrides orionis.http.payload.contracts.form_data.IFormData.getAll

Return every value for key in insertion order.

Parameters
key:strField name to look up.
Returns
list[str | UploadedFile]All values for key, or an empty list if absent.
def multiItems(self) -> list[tuple[str, str | UploadedFile]]: (source)
overrides orionis.http.payload.contracts.form_data.IFormData.multiItems

Return all (name, value) pairs in insertion order.

Returns
list[tuple[str, str | UploadedFile]]A copy of the underlying item sequence.
__slots__: tuple[str, ...] = (source)
overrides orionis.http.payload.contracts.form_data.IFormData.__slots__

Undocumented

_index = (source)

Undocumented

_items: list[tuple[str, str | UploadedFile]] = (source)

Undocumented

allItems: list[tuple[str, str | UploadedFile]] = (source)
overrides orionis.http.payload.contracts.form_data.IFormData.allItems

Return all (name, value) pairs in insertion order.

Returns
list[tuple[str, str | UploadedFile]]The underlying item sequence; callers must not mutate it.
fields: dict[str, list[str]] = (source)
overrides orionis.http.payload.contracts.form_data.IFormData.fields

Return all text field values grouped by name.

Returns
dict[str, list[str]]Mapping of field names to string values in insertion order.
files: dict[str, list[UploadedFile]] = (source)
overrides orionis.http.payload.contracts.form_data.IFormData.files

Return all uploaded file values grouped by name.

Returns
dict[str, list[UploadedFile]]Mapping of field names to UploadedFile instances in insertion order.