Cliff Classes

App

class cliff.app.App(description, version, command_manager, stdin=None, stdout=None, stderr=None)

Application base class.

build_option_parser(description, version)

Return an argparse option parser for this application.

Subclasses may override this method to extend the parser with more global options.

clean_up(cmd, result, err)

Hook run after a command is done to shutdown the app.

configure_logging()

Create logging handlers for any log output.

prepare_to_run_command(cmd)

Perform any preliminary work needed to run a command.

run(argv)

Equivalent to the main program for the application.

CommandManager

class cliff.commandmanager.CommandManager(namespace)

Discovers commands and handles lookup based on argv data.

find_command(argv)

Given an argument list, find a command and return the processor and any remaining arguments.

Command

class cliff.command.Command(app, app_args)

Base class for command plugins.

get_description()

Return the command description.

get_parser(prog_name)

Return an argparse.ArgumentParser.

run(parsed_args)

Do something useful.

Lister

class cliff.lister.Lister(app, app_args)

Command base class for providing a list of data as output.

get_data(parsed_args)

Return an iterable containing the data to be listed.

Formatter

class cliff.formatters.base.Formatter

add_argument_group(parser)

Add any options to the argument parser.

Should use our own argument group.

ListFormatter

class cliff.formatters.base.ListFormatter

emit_list(column_names, data, stdout)

Format and print the list from the iterable data source.