gemd.entity.link_by_uid module

A unique id that stands in for a data object.

class gemd.entity.link_by_uid.LinkByUID(scope, id)

Link object, which replaces pointers to other entities before serialization and writing.

Parameters

scope (str) – The scope of the unique identifier. Scopes are case-insensitive.
id (str) – The unique identifier.

as_dict() → Dict[str, Any]

Convert the object to a dictionary.

Returns: A dictionary representation of the object, where the keys are its fields.
Return type: dict

static build(d: Mapping[str, Any]) → DictSerializableType

Build an object from a JSON dictionary.

This differs from from_dict in that the values themselves may also be dictionaries corresponding to serialized DictSerializable objects.

dump() → Dict[str, Any]

Convert the object to a JSON dictionary, so that every entry is serialized.

Uses the json encoder client, so objects with uids are converted to LinkByUID dictionaries.

classmethod from_dict(d: Mapping[str, Any]) → DictSerializableType

Reconstitute the object from a dictionary.

Parameters: d (dict) – The object as a dictionary of key-value pairs that correspond to the object’s fields.
Returns: The deserialized object.
Return type: DictSerializable

classmethod from_entity(entity: BaseEntityType, *, scope=None)

Create LinkByUID from in-memory object.

If there exists an id with scope (default ‘auto’), the LinkByUID object will be built with that scope.
If there is no id with scope, an arbitrary scope-id pair will be chosen.
If the object has no uids, the object will be mutated to include a uid (UUID4) with the chosen scope and the LinkByUID object will be built with that scope and id.

Parameters

Returns

A link object that references entity through its scope and id.

Return type

LinkByUID