MetadataMethod

class MetadataMethod(func, items=None, name_mapping=None)

Bases: object

Generate one or more metadata items.

Parameters:

• func (Callable[[MetadataGenerator], Any]) – Method of MetadataGenerator that is called to generate items. It returns either a single item (if simple) or a mapping of multiple items.

• items (list[str] | None) – List of items names generated by this method. If left to None, the method is considered “simple”: it generates a single item of the same name as the method.

• name_mapping (Mapping[str, str] | None) – Mapping to rename items ({"item_name": "new_name"}). Items names must be registered (via items for multiple items).

generate(gen)

Populate the metadata attribute of the generator.

Parameters:

gen (MetadataGenerator)

Return type:

None

rename(name=None, **kwargs)

Rename item(s).

Parameters:

• name (str | None) – If the method is simple, rename to that.

• kwargs (str) – Rename multiple items.

Return type:

None