idmtools.core.interfaces.imetadata_operations module¶

Here we implement the Metadata operations interface.

class idmtools.core.interfaces.imetadata_operations.IMetadataOperations[source]¶

Bases: ABC

Operations to handle metadata for SlurmPlatform.

abstract get(item: IEntity) → Dict[source]¶

Obtain item’s metadata.

Parameters:: item – idmtools entity (Suite, Experiment and Simulation, etc.)
Returns:: a key/value dict of metadata from the given item

abstract dump(item: IEntity) → None[source]¶

Save item’s metadata to a file.

Parameters:: item – idmtools entity (Suite, Experiment and Simulation, etc.)
Returns:: None

abstract load(item: IEntity) → Dict[source]¶

Obtain item’s metadata file.

Parameters:: item – idmtools entity (Suite, Experiment and Simulation, etc.)
Returns:: key/value dict of item’s metadata file

abstract update(item: IEntity) → None[source]¶

Update item’s metadata file.

Parameters:: item – idmtools entity (Suite, Experiment and Simulation, etc.)
Returns:: None

abstract clear(item: IEntity) → None[source]¶

Clear the item’s metadata file.

Parameters:: item – idmtools entity (Suite, Experiment and Simulation, etc.)
Returns:: None

abstract filter(item_type: ItemType, item_filter: Dict | None = None) → List[source]¶

Obtain all items that match the given item_filter key/value pairs passed.

Parameters:

item_type – the type of items to search for matches (simulation, experiment, suite, etc)
item_filter – a dict of metadata key/value pairs for exact match searching

Returns:

a list of matching items