orionis.http.payload.contracts.form_data.IFormData

ORIONIS API REFERENCE

Modules Classes Names

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

class documentation

class IFormData(ABC): (source)

Known subclasses: orionis.http.payload.form_data.FormData

View In Hierarchy

Define the contract for parsed multipart form data.

Notes

Holds ordered (name, value) pairs from a multipart body, supports multiple values per field name, and releases open file handles via the context-manager protocol.

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	`__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
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.

@abstractmethod

def __contains__(self, key: str) -> bool: (source) ¶

overridden in orionis.http.payload.form_data.FormData

Return True if at least one item with key exists.

Parameters
key:`str`	Field name to check.

Returns
`bool`	`True` if key is present, `False` otherwise.

@abstractmethod

def __enter__(self) -> Self: (source) ¶

overridden in orionis.http.payload.form_data.FormData

Enter the context manager and return this instance.

Returns
`Self`	The `IFormData` instance itself.

@abstractmethod

def __exit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None): (source) ¶

overridden in orionis.http.payload.form_data.FormData

Exit the context manager and close all uploaded file handles.

Parameters
exc_type:`type[BaseException] \| None`	Exception class if one was raised, otherwise `None`.
exc_val:`BaseException \| None`	Exception instance if one was raised, otherwise `None`.
exc_tb:`TracebackType \| None`	Traceback if an exception was raised, otherwise `None`.

Returns
`None`	Always returns `None`.

@abstractmethod

def __getitem__(self, key: str) -> object: (source) ¶

overridden in orionis.http.payload.form_data.FormData

Return the last value for key using subscript notation.

Parameters
key:`str`	Field name to retrieve.

Returns
`object`	Last value for key, or `None` if absent.

@abstractmethod

def __iter__(self) -> Iterator[str]: (source) ¶

overridden in orionis.http.payload.form_data.FormData

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

Returns
`Iterator[str]`	Each unique field name exactly once.

@abstractmethod

def __len__(self) -> int: (source) ¶

overridden in orionis.http.payload.form_data.FormData

Return the number of unique field names.

Returns
`int`	Count of distinct keys, not the total item count.

@abstractmethod

def __repr__(self) -> str: (source) ¶

overridden in orionis.http.payload.form_data.FormData

Return the canonical string representation.

Returns
`str`	Developer-facing string describing the instance.

@abstractmethod

def close(self): (source) ¶

overridden in orionis.http.payload.form_data.FormData

Close all uploaded file handles to release resources.

Returns
`None`	Always returns `None`.

@abstractmethod

def get(self, key: str, default: object | None = None) -> object | None: (source) ¶

overridden in orionis.http.payload.form_data.FormData

Return the last value for key, or default.

Parameters
key:`str`	Field name to look up.
default:`object \| None, optional`	Fallback when key is absent. Defaults to `None`.

Returns
`object \| None`	Last `str` or `UploadedFile` for key, or default.

@abstractmethod

def getAll(self, key: str) -> list[str | UploadedFile]: (source) ¶

overridden in orionis.http.payload.form_data.FormData

Return every value for key in insertion order.

Parameters
key:`str`	Field name to look up.

Returns
`list[str \| UploadedFile]`	All values for key, or an empty list if absent.

@abstractmethod

def multiItems(self) -> list[tuple[str, str | UploadedFile]]: (source) ¶

overridden in orionis.http.payload.form_data.FormData

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

Returns
`list[tuple[str, str \| UploadedFile]]`	A copy of the underlying item sequence.

__slots__: tuple = (source) ¶

overridden in orionis.http.payload.form_data.FormData

Undocumented

@property
@abstractmethod

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

overridden in orionis.http.payload.form_data.FormData

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

Returns
`list[tuple[str, str \| UploadedFile]]`	The underlying item sequence; callers must not mutate it.

@property
@abstractmethod

fields: dict[str, list[str]] = (source) ¶

overridden in orionis.http.payload.form_data.FormData

Return all text field values grouped by name.

Returns
`dict[str, list[str]]`	Mapping of field names to string values in insertion order.

@property
@abstractmethod

files: dict[str, list[UploadedFile]] = (source) ¶

overridden in orionis.http.payload.form_data.FormData

Return all uploaded file values grouped by name.

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