AutoArchive._ui._cmdline

Cmdline UI component.

Package defines a Mainf component for a command-line user interface.

Modules

cmdline_commands

CmdlineCommands and CmdlineCommandsUtils static classes.

class AutoArchive._ui._cmdline.cmdline_commands.CmdlineCommands[source]

Bases: builtins.object

Constants for command-line command names.

Command-line commands are used to invoke program operations via a command-line argument. For example: --create will invoke a backup creation.

Note

It is not allowed to change values of these constants.

CREATE = 'create'

Create backup for a given archive specification file.

LIST = 'list'

List all archive specification files.

PURGE = 'purge'

Purge orphaned archive data.

class AutoArchive._ui._cmdline.cmdline_commands.CmdlineCommandsUtils[source]

Bases: builtins.object

Various utility methods working with CmdlineCommands.

static getAllCommands()[source]

Iterator over all known commands.

Returns:All options defined in CmdlineCommands.
Return type:Iterable<str>
classmethod isExistingCommand(commandName)[source]

Check whether a command with name commandName does exists in CmdlineCommandsUtils.

Parameters:commandName (str) – Name of the command which existence shall be checked.
Returns:True if option with name commandName exists; False otherwise.
Return type:bool

Table Of Contents

Previous topic

AutoArchive._ui

Next topic

AutoArchive._ui._cmdline._core