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

class SeederEvents: (source)

View In Hierarchy

Progress callbacks reported while migrations run.

Grouping the callbacks keeps the migrator free of any dependency on the console layer: the caller decides how each event is rendered.

Method failed Report that a migration failed.
Method started Report that a migration is about to run.
Method succeeded Report that a migration completed successfully.
Instance Variable on_error Invoked with the migration name and elapsed seconds when it fails, right before the exception propagates.
Instance Variable on_start Invoked with the migration name right before it runs.
Instance Variable on_success Invoked with the migration name and elapsed seconds once it completes successfully.
def failed(self, name: str, elapsed: float): (source)

Report that a migration failed.

Parameters
name:strMigration name.
elapsed:floatSeconds elapsed before the failure.
Returns
NoneNo return value.
def started(self, name: str): (source)

Report that a migration is about to run.

Parameters
name:strMigration name.
Returns
NoneNo return value.
def succeeded(self, name: str, elapsed: float): (source)

Report that a migration completed successfully.

Parameters
name:strMigration name.
elapsed:floatSeconds the migration took.
Returns
NoneNo return value.

Invoked with the migration name and elapsed seconds when it fails, right before the exception propagates.

Invoked with the migration name right before it runs.

on_success: callable or None = (source)

Invoked with the migration name and elapsed seconds once it completes successfully.