beanis.odm.utils.init

Initializer

class Initializer()

Initializer.__init__

def __init__(database: "Redis" = None,
             document_models: Optional[List[Union[Type["DocType"],
                                                  str]]] = None)

Beanis initializer

Arguments:

• database: redis.asyncio.Redis - Redis async client instance
• document_models: List[Union[Type[DocType], str]] - model classes or strings with dot separated paths

Returns:

None

Initializer.get_model

@staticmethod
def get_model(dot_path: str) -> Type["DocType"]

Get the model by the path in format bar.foo.Model

Arguments:

• dot_path: str - dot seprated path to the model

Returns:

Type[DocType] - class of the model

Initializer.init_settings

def init_settings(cls: Union[Type[Document]])

Init Settings

Arguments:

• cls: Union[Type[Document], Type[View], Type[UnionDoc]] - Class to init settings

Returns:

None

Initializer.set_default_class_vars

@staticmethod
def set_default_class_vars(cls: Type[Document])

Set default class variables.

Arguments:

• cls: Union[Type[Document], Type[View], Type[UnionDoc]] - Class to init settings

Initializer.init_document_fields

def init_document_fields(cls) -> None

Init class fields

Returns:

None

Initializer.init_actions

@staticmethod
def init_actions(cls)

Init event-based actions

Initializer.init_vector_indexes

async def init_vector_indexes(cls)

Create vector indexes for fields with VectorField

Arguments:

• cls:

Initializer.init_document_collection

def init_document_collection(cls)

Init Redis client for the Document-based class

Arguments:

• cls:

Initializer.init_document

async def init_document(cls: Type[Document]) -> Optional[Output]

Init Document-based class

Arguments:

• cls:

Initializer.init_class

async def init_class(cls: Union[Type[Document]])

Init Document, View or UnionDoc based class.

Arguments:

• cls:

init_beanis

async def init_beanis(database: "Redis" = None,
                      document_models: Optional[List[Union[Type[Document],
                                                           str]]] = None)

Beanis initialization

Arguments:

• database: redis.asyncio.Redis - Redis async client instance
• document_models: List[Union[Type[DocType], str]] - model classes or strings with dot separated paths

Returns:

None