taucmdr.cli.cli_view module

A command line data view.

See http://en.wikipedia.org/wiki/Model-view-controller

class taucmdr.cli.cli_view.AbstractCliView(model, module_name, summary_fmt=None, help_page_fmt=None, group=None, include_storage_flag=True)

Bases: AbstractCommand

A command that works as a view for a controller.

See http://en.wikipedia.org/wiki/Model-view-controller

controller

The controller class for this view’s data.

Type:

class

model_name

The lower-case name of the model.

Type:

str

_abc_impl = <_abc._abc_data object>

class taucmdr.cli.cli_view.CopyCommand(*args, **kwargs)

Bases: CreateCommand

Base class for the copy subcommand of command line views.

_abc_impl = <_abc._abc_data object>

_construct_parser()

Construct a command line argument parser.

_copy_record(store, updates, key)

main(argv)

Command program entry point.

Parameters:

argv (list) – Command line arguments.

Returns:

Process return code: non-zero if a problem occurred, 0 otherwise

Return type:

int

class taucmdr.cli.cli_view.CreateCommand(*args, **kwargs)

Bases: AbstractCliView

Base class for the create command of command line views.

_abc_impl = <_abc._abc_data object>

_construct_parser()

Construct a command line argument parser.

_create_record(store, data)

Create the model record.

Parameters:

• store (AbstractStorage) – Storage to contain the record.

• data (dict) – Record data.

Returns:

EXIT_SUCCESS if successful.

Return type:

int

Raises:

UniqueAttributeError – A record with the same unique attribute already exists.

main(argv)

Command program entry point.

Parameters:

argv (list) – Command line arguments.

Returns:

Process return code: non-zero if a problem occurred, 0 otherwise

Return type:

int

class taucmdr.cli.cli_view.DeleteCommand(*args, **kwargs)

Bases: AbstractCliView

Base class for the delete subcommand of command line views.

_abc_impl = <_abc._abc_data object>

_construct_parser()

Construct a command line argument parser.

_delete_record(store, key)

main(argv)

Command program entry point.

Parameters:

argv (list) – Command line arguments.

Returns:

Process return code: non-zero if a problem occurred, 0 otherwise

Return type:

int

class taucmdr.cli.cli_view.EditCommand(*args, **kwargs)

Bases: AbstractCliView

Base class for the edit subcommand of command line views.

_abc_impl = <_abc._abc_data object>

_construct_parser()

Construct a command line argument parser.

_update_record(store, data, key)

main(argv)

Command program entry point.

Parameters:

argv (list) – Command line arguments.

Returns:

Process return code: non-zero if a problem occurred, 0 otherwise

Return type:

int

class taucmdr.cli.cli_view.ListCommand(*args, **kwargs)

Bases: AbstractCliView

Base class for the list subcommand of command line views.

_abc_impl = <_abc._abc_data object>

_construct_parser()

Construct a command line argument parser.

_count_records(ctrl)

Print a record count to stdout.

Parameters:

controller (Controller) – Controller for the data model.

_format_long_item(key, val)

_format_records(ctrl, style, keys=None, context=True)

Format records in a given style.

Retrieves records for controller ctrl and formats them.

Parameters:

• ctrl (Controller) – Controller for the data model.

• style (str) – Style in which to format records.

• keys (list) – Keys to match to the model’s key attribute.

Returns:

Record data as formatted strings.

Return type:

list

_list_records(storage_levels, keys, style, context=True)

Shows record data via print.

Parameters:

• storage_levels (list) – Storage levels to query, e.g. [‘user’, ‘project’]

• keys (list) – Keys to match to the model’s key attribute.

• style (str) – Style in which to format records.

Returns:

EXIT_SUCCESS if successful.

Return type:

int

_retrieve_records(ctrl, keys, context=True)

Retrieve modeled data from the controller.

Parameters:

• ctrl (Controller) – Controller for the data model.

• keys (list) – Keys to match to the model’s key attribute.

Returns:

Model records.

Return type:

list

dashboard_format(records)

Format modeled records in dashboard format.

Parameters:

records – Modeled records to format.

Returns:

Record data in dashboard format.

Return type:

str

long_format(records)

Format records in long format.

Parameters:

records – Controlled records to format.

Returns:

Record data in long format.

Return type:

str

main(argv)

Command program entry point.

Parameters:

argv (list) – Command line arguments.

Returns:

Process return code: non-zero if a problem occurred, 0 otherwise

Return type:

int

short_format(models)

Format modeled records in short format.

Parameters:

models – Modeled records to format.

Returns:

Record data in short format.

Return type:

str

class taucmdr.cli.cli_view.RootCommand(model, module_name, summary_fmt=None, help_page_fmt=None, group=None, include_storage_flag=True)

Bases: AbstractCliView

A command with subcommands for actions.

_abc_impl = <_abc._abc_data object>

_construct_parser()

Construct a command line argument parser.

main(argv)

Command program entry point.

Parameters:

argv (list) – Command line arguments.

Returns:

Process return code: non-zero if a problem occurred, 0 otherwise

Return type:

int

class taucmdr.cli.cli_view.Texttable(max_width=80)

Bases: Texttable

Extend the Texttable class to print header rows in bold.

_draw_line(line, isheader=False)

Override original Texttable’s _draw_line() method to make headers bold.

Draws a line by looping over a single cell length, over all the cells, making any header text bold. A better place to implement this would have been _splitit() but the logic in texttable does not strip ANSI escape sequences and treats them as printable characters. texttable 1.6.3 and 1.7.1 have the same _draw_line. Adapted from texttable v1.6.3: https://github.com/foutaise/texttable/blob/4073cefdfc4e5c50ed587909875b64b005c70df8/texttable.py#L657-L686