Module arches_orm.wkrm

Variables

WELL_KNOWN_RESOURCE_MODELS

logger

resource_models

Functions

attempt_well_known_resource_model

def attempt_well_known_resource_model(
    resource_id,
    from_prefetch=None,
    adapter=None,
    lazy=False,
    **kwargs
)

Attempts to find and create a well-known resource from a resource ID

This is the simplest entry-point if you do not know the model of the resource you have. Bear in mind, it will return None if a well-known resource model is not matched.

get_resource_models_for_adapter

def get_resource_models_for_adapter(
    adapter_name: str | None = None
)

get_well_known_resource_model_by_class_name

def get_well_known_resource_model_by_class_name(
    class_name,
    default=None,
    adapter: str | None = None
)

Turns a class-name as a string into a well-known resource model wrapper.

get_well_known_resource_model_by_graph_id

def get_well_known_resource_model_by_graph_id(
    graphid,
    default=None,
    adapter: str | None = None
)

Turns a graph into a well-known resource model wrapper, by ID, if known.

Classes

WKRM

class WKRM(
    model_name,
    graphid,
    __str__=None,
    total_remap=False,
    remapping=None,
    **kwargs
)

Well-known resource model definition.

This provides the settings for a well-known resource model wrapper, in particular, the model's name, its graph ID, any node-specific settings and, if desired, a callback to render the resource to a string.

Instance variables

model_class_name