Metadata

metadata module

class mmodel.metadata.MetaDataFormatter(formatter_dict: dict, meta_order: list, text_wrapper: callable, shorten_list: list = <factory>, shorten_placeholder: str = ' ...')

Bases: object

Metadata Formatter.

mmodel.metadata.format_dictargs(key, value)

Format the metadata value that is a dictionary.

mmodel.metadata.format_dictkeys(key, value)

Formating function that only shows dictionary keys.

If the value dictionary is empty return None.

mmodel.metadata.format_func(key, value)

Format the metadata value that has a function.

The key name is not shown in the string output. The result is func(args1, args2, …).

mmodel.metadata.format_group_content(key, value, formatter=MetaDataFormatter(formatter_dict={'self': <function format_func>, 'returns': <function format_returns>, 'graph': <function format_obj_name>, 'handler': <function format_obj_name>, 'handler_kwargs': <function format_dictargs>, 'modifiers': <function format_modifierlist>, 'doc': <function format_value>}, meta_order=['self', 'returns', 'group', 'graph', 'handler', 'handler_kwargs', 'modifiers', '_', 'doc'], text_wrapper=<textwrap.TextWrapper object>, shorten_list=['handler_kwargs', 'modifiers'], shorten_placeholder=' ...'))

Format the metadata value that is a dictionary of model arguments.

Here use the model formatter dictionary to parse the content.

mmodel.metadata.format_list(key, value)

Format the metadata value that is a list.

mmodel.metadata.format_modifierlist(key, value)

Format the metadata that is a list of modifiers.

The metadata of the modifier is extracted by the modifier_metadata function. The resulting list is formatted by the format_list function.

mmodel.metadata.format_obj_name(key, value)

Format the metadata value that is an object.

Only show the name of the object. This is used for graph and handler objects. The object needs to have __name__ or name attribute defined. If neither is defined, display the string representation.

mmodel.metadata.format_returns(key, value)

Format the metadata value that has a list of returns.

The formatter is for the returns metadata. If the “returns” value is empty, the output is None. If the returns only have one value, return the value; otherwise , return the values separated by commas in a tuple representation.

mmodel.metadata.format_shortdocstring(key, value)

Format function docstring.

Only the short docstring is parsed. The built-in and ufunc type docstring location is not consistent some module/function has the repr at the first line, and some don’t. Here we try to grab the first line that starts with an upper case and ends with a period. If the docstring is improperly formatted, the first line is used.

mmodel.metadata.format_value(key, value)

Format the metadata without displaying the key.

mmodel.metadata.modifier_metadata(func)

Extract metadata from closure, including the name and the arguments.

The order of extraction: 1. If the object has the “metadata” attribute defined. 2. If not, the metadata returns the function name itself.