journal_manager.cli.commands.journal_commands.show module

journal_manager.cli.commands.journal_commands.show.get_parser(subparser_action=None)[source]
journal_manager.cli.commands.journal_commands.show.show(journal_name: str, attribute_names: List[str]) Iterable[str][source]

Get attribute data from a registered journal.

Parameters:
  • journal_name (str) – The journal name

  • attribute_names (optional) – List of attribute names which values one wants to show

Returns:

The attribute value if a single attribute was requested. For two or more attributes, several strings are returned. One for line requested attribute. The string has the format “attribute_name: attribute_value”.

Raises:
  • InvalidName if the journal name is invalid.

  • InvalidAttribute if an attribute name is invalid.

Return type:

Iterable[str]