Metadata Models#

class InsertMetadata(error_description=None, errors=<factory>, inserted_idx=<factory>, existing_idx=<factory>)[source]#

Bases: object

Metadata returned by insertion / adding functions

Parameters:

  • error_description (str | None)

  • errors (List[Tuple[int, str]])

  • inserted_idx (List[int])

  • existing_idx (List[int])

error_description: str | None = None#
errors: List[Tuple[int, str]]#
inserted_idx: List[int]#
existing_idx: List[int]#
property n_inserted#
property n_existing#
property n_errors#
property error_idx#
property success#
property error_string#
classmethod sort_fields(v)[source]#
classmethod check_all_indices(values)[source]#
dict()[source]#

Returns the information from this dataclass as a dictionary

Return type:

Dict[str, Any]

static merge(metadata)[source]#
Parameters:

metadata (Sequence[InsertMetadata])

Return type:

InsertMetadata

class InsertCountsMetadata(n_inserted, n_existing, error_description=None, errors=<factory>)[source]#

Bases: object

Metadata returned by insertion / adding functions, only including counts

Parameters:

  • n_inserted (int)

  • n_existing (int)

  • error_description (str | None)

  • errors (List[str])

n_inserted: int#
n_existing: int#
error_description: str | None = None#
errors: List[str]#
property n_errors#
property success#
property error_string#
dict()[source]#

Returns the information from this dataclass as a dictionary

Return type:

Dict[str, Any]

class DeleteMetadata(error_description=None, errors=<factory>, deleted_idx=<factory>, n_children_deleted=0)[source]#

Bases: object

Metadata returned by delete functions

Parameters:

  • error_description (str | None)

  • errors (List[Tuple[int, str]])

  • deleted_idx (List[int])

  • n_children_deleted (int)

error_description: str | None = None#
errors: List[Tuple[int, str]]#
deleted_idx: List[int]#
n_children_deleted: int = 0#
property n_deleted#
property n_errors#
property error_idx#
property success#
property error_string#
classmethod sort_fields(v)[source]#
classmethod check_all_indices(values)[source]#
dict()[source]#

Returns the information from this dataclass as a dictionary

Return type:

Dict[str, Any]

class UpdateMetadata(error_description=None, errors=<factory>, updated_idx=<factory>, n_children_updated=0)[source]#

Bases: object

Metadata returned by update functions

Parameters:

  • error_description (str | None)

  • errors (List[Tuple[int, str]])

  • updated_idx (List[int])

  • n_children_updated (int)

error_description: str | None = None#
errors: List[Tuple[int, str]]#
updated_idx: List[int]#
n_children_updated: int = 0#
property n_updated#
property n_errors#
property error_idx#
property success#
property error_string#
classmethod sort_fields(v)[source]#
classmethod check_all_indices(values)[source]#
dict()[source]#

Returns the information from this dataclass as a dictionary

Return type:

Dict[str, Any]

class TaskReturnMetadata(error_description=None, rejected_info=<factory>, accepted_ids=<factory>)[source]#

Bases: object

Metadata returned to managers that have sent completed tasks back to the server

Parameters:

  • error_description (str | None)

  • rejected_info (List[Tuple[int, str]])

  • accepted_ids (List[int])

error_description: str | None = None#
rejected_info: List[Tuple[int, str]]#
accepted_ids: List[int]#
property n_accepted#
property n_rejected#
property rejected_ids#
property success#
property error_string#
classmethod sort_fields(v)[source]#
dict()[source]#

Returns the information from this dataclass as a dictionary

Return type:

Dict[str, Any]

On this page

This Page