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.estructures.query_params.QueryParams

class documentation

class QueryParams: (source)

Constructor: QueryParams(query_string)

View In Hierarchy

Undocumented

Method __contains__ Check if the key exists in the query parameters.
Method __getitem__ Retrieve the last value for a given key or raise KeyError.
Method __init__ Initialize QueryParams with a query string.
Method __iter__ Return an iterator over the key-value pairs.
Method __len__ Return the number of key-value pairs.
Method __repr__ Return the string representation of the QueryParams object.
Method get Retrieve the last value for a given key.
Method getAll Return every value for key in insertion order.
Method getList Alias for getAll().
Method items Return all key-value pairs as a list.
Method keys Return all keys in the query parameters.
Method multiItems Return all (key, value) pairs in insertion order.
Method values Return all values in the query parameters.
Class Variable __slots__ Undocumented
Instance Variable _index Undocumented
Instance Variable _items Undocumented
def __contains__(self, key: str) -> bool: (source)

Check if the key exists in the query parameters.

Parameters
key:strThe key to check for.
Returns
boolTrue if the key exists, False otherwise.
def __getitem__(self, key: str) -> str: (source)

Retrieve the last value for a given key or raise KeyError.

Parameters
key:strThe key to retrieve.
Returns
strThe last value associated with the key.
Raises
KeyErrorIf the key is not found.
def __init__(self, query_string: str): (source)

Initialize QueryParams with a query string.

Parameters
query_string:strThe query string to parse.
Returns
NoneThis method initializes the instance.
def __iter__(self) -> Iterator[tuple[str, str]]: (source)

Return an iterator over the key-value pairs.

Returns
Iterator[tuple[str, str]]Iterator over all key-value pairs.
def __len__(self) -> int: (source)

Return the number of key-value pairs.

Returns
intThe number of key-value pairs.
def __repr__(self) -> str: (source)

Return the string representation of the QueryParams object.

Returns
strString representation of the QueryParams instance.
def get(self, key: str, default: str | None = None) -> str | None: (source)

Retrieve the last value for a given key.

Parameters
key:strThe key to search for.
default:str | None, optionalThe value to return if the key is not found (default is None).
Returns
str | NoneThe last value associated with the key, or default if not found.
def getAll(self, key: str) -> list[str]: (source)

Return every value for key in insertion order.

Unlike get(), which returns only the last occurrence, this method preserves all values so that repeated parameters such as ?tag=a&tag=b are handled without data loss.

Parameters
key:strThe query parameter name to look up.
Returns
list[str]All values for key in the order they appear in the query string. Returns an empty list when key is absent.
def getList(self, key: str) -> list[str]: (source)

Alias for getAll().

Parameters
key:strThe query parameter name to look up.
Returns
list[str]All values for key in insertion order.
def items(self) -> list[tuple[str, str]]: (source)

Return all key-value pairs as a list.

Returns
list[tuple[str, str]]List of all key-value pairs.
def keys(self) -> set[str]: (source)

Return all keys in the query parameters.

Returns
set[str]Set of all unique keys.
def multiItems(self) -> list[tuple[str, str]]: (source)

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

Parameters
None
Returns
list[tuple[str, str]]A copy of the full ordered sequence of query parameter pairs.
def values(self) -> list[str]: (source)

Return all values in the query parameters.

Returns
list[str]List of all values.
__slots__: tuple[str, ...] = (source)

Undocumented

_index = (source)

Undocumented

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

Undocumented