meta

Utility functions for merging metadata for multiple files.

class meta.MergeMetaAll

Merge metadata by taking the set of values.

add(value)

Add a new value to the metadata.

property valid

Check if the value is valid.

property value

Get the merged value.

class meta.MergeMetaMax

Merge metadata by taking the maximum value.

add(value)

Add a new value to the metadata.

property valid

Check if the value is valid.

class meta.MergeMetaMin

Merge metadata by taking the minimum value.

add(value)

Add a new value to the metadata.

property valid

Check if the value is valid.

class meta.MergeMetaOverride(value=None)

Merge metadata by overriding the value.

add(value)

Add a new value to the metadata.

property valid

Check if the value is valid.

class meta.MergeMetaSubset(value=None)

Merge metadata by taking the subset of consistent values.

add(value)

Add a new value to the metadata.

property valid

Check if the value is valid.

property warn

Whether to warn about inconsistent metadata.

class meta.MergeMetaSum

Merge metadata by adding the values.

add(value)

Add a new value to the metadata.

property valid

Check if the value is valid.

class meta.MergeMetaUnion

Merge metadata by taking the union.

add(value)

Add a new value to the metadata.

property valid

Check if the value is valid.

property value

Get the merged value.

class meta.MergeMetaUnique(value=None)

Merge metadata by taking the unique values.

add(value)

Add a new value to the metadata.

property valid

Check if the value is valid.

class meta.MetaNameDict(meta: dict)

Wrapper class to access metadata dictionary.

Initialize the MetaNameDict with a metadata dictionary.

class MetaNameReader(meta: dict, key: str)

Class to read metadata values.

eval(condition: str) → bool

Evaluate a condition using the metadata dictionary.

Parameters:

condition – condition string to evaluate

Returns:

evaluated value

format(template: str) → str

Format a string using the metadata dictionary.

Parameters:

template – template string

Returns:

formatted string

meta.check_method(files: dict) → None

Check and set the merging method based on the input file metadata.

Parameters:

files – set of files to merge

meta.check_required(metadata: dict) → list

Check if the metadata dictionary contains all required keys.

Parameters:

metadata – metadata dictionary

Returns:

List of any missing required keys

meta.fix(name: str, metadata: dict) → None

Fix the metadata dictionary.

Parameters:

• name – name of the file (for logging)

• metadata – metadata dictionary

meta.make_name(files: dict) → str

Update merging method and create a name for the merged files.

Parameters:

files – set of files to merge

Returns:

merged file name

meta.merged_keys(files: dict, warn: bool = False) → dict

Merge metadata from multiple files into a single dictionary.

Parameters:

• files – set of files to merge

• warn – whether to warn about inconsistent metadata

Returns:

merged metadata

meta.parents(files: dict) → list[str]

Retrieve all the parents from a set of files.

Parameters:

files – set of files to merge

Returns:

set of parents

meta.set_extension(files: dict) → None

Get the file extension for the merged file.

Parameters:

files – set of files to merge

Returns:

file extension

meta.set_method(method: dict) → None

Set merging method parameters.

Parameters:

method – merging method dictionary

meta.set_method_auto(metadata: dict) → None

Auto-select merging method based on metadata conditions.

Parameters:

metadata – metadata dictionary

meta.set_method_custom() → None

Set merging method parameters for a custom script.

meta.validate(name: str, metadata: dict, requirements: bool = True) → bool

Validate the metadata dictionary.

Parameters:

• name – name of the file (for logging)

• metadata – metadata dictionary

• requirements – whether to check for required keys

Returns:

True if metadata is valid, False otherwise