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.

class documentation

Define the contract for environment caster implementations.

Method get Return the processed value according to the type hint.
Method to Convert the internal value to the specified type and return as a string.
Class Variable __slots__ Declare that this class introduces no additional instance slots.

Return the processed value according to the type hint.

If a valid type hint is present, dispatch to the corresponding internal parsing method for that type. Supported type hints include: 'path', 'str', 'int', 'float', 'bool', 'list', 'dict', 'tuple', 'set', and 'base64'. If no type hint is set, return the raw value.

Returns
objectThe value converted or processed according to the specified type hint. If no type hint is set, returns the raw value.
Raises
ValueErrorIf an error occurs during type conversion or processing.
TypeErrorIf an error occurs during type conversion or processing.
def to(self, type_hint: str | EnvironmentValueType) -> str: (source)

Convert the internal value to the specified type and return as a string.

Parameters
type_hint:str or orionis.environment.enums.EnvironmentValueTypeThe type to which the internal value should be converted. Must be a valid option in OPTIONS.
Returns
strString representation of the value with the type hint prefix, e.g., int:42, list:[1, 2, 3], etc.
Raises
ValueErrorIf the provided type hint is invalid or conversion fails.
__slots__: tuple = (source)

Declare that this class introduces no additional instance slots.