memtab.cli module

The command line interface to the memory tabulator. We use typer instead of argparse or click because it is the most ergonomic way to include this code within the scope of a call to pytest. With argparse, it was a bit more clunky, and typer provides CliRunner which is easier to use.

class memtab.cli.ReportType(*args, **kwargs)

Bases: ParamType

Custom type to parse –report arguments as ‘type[:filename]’.

convert(value, param, ctx)

Split the input into two parts: report_type and optional filename, using ‘:’ as an optional delimiter.

Return type:

Tuple[str, str]

name = 'report'

memtab.cli.custom_entry_point_load()

we have to cheat here if we want to use classes. self.pm.load_setuptools_entrypoints only references the name, which doesn’t work if its a class. we need an INSTANCE of the class. So we DIY to get those instances.

Return type:

None

memtab.cli.list_reports_callback(value)

Callback to list available report formats

Return type:

None

memtab.cli.memtab(elf=PosixPath('zephyr.elf'), config=[PosixPath('memtab.yml')], json=PosixPath('memtab.json'), report=None, check=False, cache=True, clean=False, map=None, version=None, list_reports=None, project=None)

The main command line entry point for calling the memory tabulator. If you want to call memtab from a python app, you should import it directly, NOT via this cli method.

Return type:

None

memtab.cli.memtabviz(input=PosixPath('memtab.json'), report=None, version=None, list_reports=None)

The main command line entry point for calling the memory visual generator. If you want to call memtab from a python app, you should import it directly, NOT via this cli method.

Return type:

None

memtab.cli.version_callback(value)

Callback to show the version of memtab

Return type:

None