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.

package documentation

Group the support types components and public imports.

Module _html Strip markup using the standard HTML parser while preserving allowed tags.
Module collection Provide collection operations over an ordered sequence of values.
Package contracts Group the support types contracts components and public imports.
Module dot_dict Expose nested dictionary values through attribute access.
Module sentinel Represent the absence of a value without conflating it with None.
Module std Represent dynamically assigned attributes as a simple data object.
Module stringable Provide chainable operations over a string value.
Module uniqueness Provide support types operations through unique_items.

From __init__.py:

Class Collection Provide collection operations over an ordered sequence of values.
Class DotDict Expose nested dictionary values through attribute access.
Class StdClass Represent dynamically assigned attributes as a simple data object.
Class Stringable Provide chainable operations over a string value.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
Constant MISSING Instance representing a missing value sentinel.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'MISSING': ('orionis.support.types.sentinel', 'MISSING'),
 'Collection': ('orionis.support.types.collection', 'Collection'),
 'DotDict': ('orionis.support.types.dot_dict', 'DotDict'),
 'StdClass': ('orionis.support.types.std', 'StdClass'),
 'Stringable': ('orionis.support.types.stringable', 'Stringable')}

Instance representing a missing value sentinel.

Value
_MissingType()