finesse.cli package

Submodules

finesse.cli.config module

finesse.cli.config.config_edit(ctx, option, value): Open the user configuration in the system default editor.

finesse.cli.config.config_reset(ctx, option, value): Reset the user configuration to the default.

finesse.cli.debug module

finesse.cli.docs module

finesse.cli.model module

finesse.cli.script module

finesse.cli.util module

class finesse.cli.util.ClickLogColorFormatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

Bases: Formatter

Stdout log formatter with colors.

PREFIX_FORMAT = '{short_name:>16s} [{record.levelname:>8s}]:'

STYLES = {'critical': {'fg': 'red'}, 'debug': {'fg': 'blue'}, 'error': {'fg': 'red'}, 'info': {'fg': 'green'}, 'warning': {'fg': 'yellow'}}

format(record)

Format the specified record as text.

The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

class finesse.cli.util.KatState

Bases: object

Shared state for all CLI subcommands.

This object gets built by Click when the CLI is called and encapsulates global settings for use by individual commands/groups.

LOG_DISPLAY_DEFAULT_LEVEL = 30

property debug

exclude(pattern): Exclude records from loggers with names matching the specified pattern.

exit(code=0): Stop execution.

property isverbose

Verbose output enabled.

Returns True if the verbosity is enough for info messages to be displayed.

property log_display_level: Log verbosity on stdout.

print(text='', indent=0, error=False, exit_=False, exit_code=0, **kwargs)

print_banner(kat_file=None, **kwargs): Print the Finesse banner.

print_error(exception_or_msg, title=None, exit_=True, exit_code=1, **kwargs)

finesse.cli.util.list_graph_layouts(ctx, option, value): Callback to list available graph layouts.

finesse.cli.util.parse_path(state, path, legacy=False, **error_kwargs)

finesse.cli.util.plot_graph(state, *args, **kwargs)

finesse.cli.util.print_banner(ctx, option, value): Show the Finesse banner and exit.

finesse.cli.util.set_debug(ctx, option, value)

finesse.cli.util.set_fancy_error_formatting(ctx, option, value)

finesse.cli.util.set_log_display_level(ctx, option, value): Callback to set log verbosity for root CLI command.

finesse.cli.util.set_log_excludes(ctx, option, value)

finesse.cli.util.set_verbosity(ctx, option, value): Callback to set verbosity for root CLI command.

Module contents

class finesse.cli.KatState