Skip to content

common

Common utility functions for building VBL Aquarium models.

get_model_classes(module)

Get all VBL models in a module.

Looks for all classes in a module that subclass VBLBaseModel (excluding VBLBaseModel itself).

Parameters:

Name Type Description Default
module ModuleType

The module to search for models in.

 required

Returns:

Type Description
list[type[VBLBaseModel]]

A list of all model classes in the module.
Source code in src/vbl_aquarium/utils/common.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def get_model_classes(module: ModuleType) -> list[type[VBLBaseModel]]:
    """Get all VBL models in a module.

    Looks for all classes in a module that subclass VBLBaseModel (excluding VBLBaseModel itself).

    Args:
        module: The module to search for models in.

    Returns:
        A list of all model classes in the module.
    """
    return [
        class_type
        for _, class_type in getmembers(module, isclass)
        if issubclass(class_type, VBLBaseModel) and class_type != VBLBaseModel
    ]

get_unity_model_class_names()

Get the names of all Unity models.

Looks for all classes in the unity_models module that subclass BaseModel (excluding BaseModel itself).

Returns:

Type Description
set[str]

The names of all Unity models.
Source code in src/vbl_aquarium/utils/common.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
def get_unity_model_class_names() -> set[str]:
    """Get the names of all Unity models.

    Looks for all classes in the unity_models module that subclass BaseModel (excluding BaseModel itself).

    Returns:
        The names of all Unity models.
    """
    return {
        model_name
        for model_name, class_object in getmembers(unity, isclass)
        if issubclass(class_object, BaseModel) and class_object != BaseModel
    }