Module arches_orm.adapter

Variables

ADAPTER_MANAGER

logger

Functions

admin

def admin(
    adapter_key: 'str | None' = None
)

admin_everywhere

def admin_everywhere(
    key=None
)

context

def context(
    ctx: 'dict | None',
    adapter_key: 'str | None' = None
) -> 'Callable[[Any], Any]'

context_free

def context_free(
    arg: 'Callable[[Any], Any] | str'
) -> 'Callable[[Any], Any]'

get_adapter

def get_adapter(
    key=None
)

Classes

Adapter

class Adapter(
    key
)

Helper class that provides a standard way to create an ABC using

inheritance.

Ancestors (in MRO)

• abc.ABC

Descendants

• arches_orm.static.adapter.StaticAdapter

Instance variables

key

Methods

context

def context(
    self,
    _ctx: 'dict[str, Any] | ContextVar | None | Literal[False]' = False,
    _override=False,
    **kwargs: 'dict[str, Any]'
) -> 'Generator[ContextVar[dict[str, Any] | None], None, None]'

context_free

def context_free(
    self
) -> 'Generator[ContextVar[dict[str, Any] | None], None, None]'

derive_collection

def derive_collection(
    self,
    collection_id: 'str | UUID',
    include: 'list[UUID] | None',
    exclude: 'list[UUID] | None',
    language: 'str | None' = None
) -> 'type[Enum]'

Note that include and exclude should be lists of concept, not value, IDs.

get_collection

def get_collection(
    self,
    collection_id: 'str | UUID'
) -> 'type[Enum]'

get_context

def get_context(
    self
)

get_rdm

def get_rdm(
    self
)

load_from_id

def load_from_id(
    self,
    resource_id: 'str',
    from_prefetch: 'Callable[[str], Any] | None' = None,
    lazy: 'bool' = False
) -> 'ResourceInstanceViewModel'

make_concept

def make_concept(
    self,
    concept_id: 'str | UUID',
    values: 'dict[UUID, tuple[str, str]]',
    children: 'list[UUID] | None'
) -> 'ConceptValueViewModel'

retrieve_concept

def retrieve_concept(
    self,
    concept_id: 'str | UUID'
) -> 'ConceptValueViewModel'

set_context_free

def set_context_free(
    self
)

AdapterManager

class AdapterManager(
    
)

Class variables

default_adapter

Methods

get_adapter

def get_adapter(
    self,
    key=None
)

register_adapter

def register_adapter(
    self,
    adapter_cls,
    key=None
)

set_default_adapter

def set_default_adapter(
    self,
    default_adapter
)