osprofiler.cmd package

Submodules

osprofiler.cmd.cliutils module

osprofiler.cmd.cliutils.add_arg(func: Callable[[...], Any], *args: Any, **kwargs: Any) → None

Bind CLI arguments to a shell.py do_foo function.

osprofiler.cmd.cliutils.arg(*args: Any, **kwargs: Any) → Callable[[Callable[[...], Any]], Callable[[...], Any]]

Decorator for CLI args.

Example:

>>> @arg("name", help="Name of the new entity")
    ... def entity_create(args):
    ... pass

osprofiler.cmd.cliutils.env(*args: str, **kwargs: str) → str

Returns the first environment variable set.

If all are empty, defaults to ‘’ or keyword arg default.

osprofiler.cmd.commands module

class osprofiler.cmd.commands.BaseCommand

Bases: object

group_name: str | None = None

class osprofiler.cmd.commands.TraceCommands

Bases: BaseCommand

group_name: str | None = 'trace'

list(args: Namespace) → None

List all traces

show(args: Namespace) → None

Display trace results in HTML, JSON or DOT format.

osprofiler.cmd.shell module

Command-line interface to the OpenStack Profiler.

class osprofiler.cmd.shell.OSProfilerShell(argv: list[str])

Bases: object

osprofiler.cmd.shell.main(args: list[str] | None = None) → int | None

Module contents