3. CMD5

cloudmesh.shell.command.basecommand(func)

A decorator to create a function with docopt arguments. It also generates a help function

@command def do_myfunc(self, args):

“”” docopts text “”” pass

will create

def do_myfunc(self, args, arguments):

“”” docopts text “”” …

def help_myfunc(self, args, arguments):

… prints the docopt text …

Parameters:func – the function for the decorator

cloudmesh.shell.command.command(func)

A decorator to create a function with docopt arguments. It also generates a help function

@command def do_myfunc(self, args):

“”” docopts text “”” pass

will create

def do_myfunc(self, args, arguments):

“”” docopts text “”” …

def help_myfunc(self, args, arguments):

… prints the docopt text …

Parameters:func – the function for the decorator

cloudmesh.shell.command.map_parameters(arguments, *args)

This command is useful to map parameters with – to regular argument dicts for easier processing.

Parameters:

• arguments –
• args –

Returns:

an example is

map_parameters(arguments,

‘active’, ‘cloud’)

where –active=ACTIVE is mapped to arguments[“active”] and –cloud=CLOUD is mapped to arguments[“cloud”]

as arguments is a dotdict, they can than for example be called as

arguments.cloud

class cloudmesh.shell.shell.CMShell(completekey='tab', stdin=None, stdout=None)

The command shell that inherits all commands from PluginCommand

do_EOF(args)

Usage:
  EOF

Description:
  Command to the shell to terminate reading a script.

do_help(arg)

Usage:
    help
    help COMMAND

Description:
    List available commands with "help" or detailed help with
    "help COMMAND".

do_info(args)

Usage:
      info [path|commands|files|cloudmesh]

Description:
      info
          provides internal info about the shell and its packages

do_plugin(args)

Usage:
  plugin install PLUGIN [-s]
  plugin uninstall PLUGIN
  plugin list
  plugin ? [--format=FORMAT]

Arguments:
  PLUGIN   the name of the plugin

Description:
  plugin available
      lists the available plugins
  plugin list
      lists the plugin
  plugin install
      installs the given plugin
  plugin uninstall
      uninstalls the given plugin

do_q(args)

Usage:
  quit

Description:
  Action to be performed when quit is typed

do_quit(args)

Usage:
  quit

Description:
  Action to be performed when quit is typed

do_shell(args)

Usage:
     shell COMMAND

 Arguments:
     COMMAND  the command to be executed

Description:
     shell COMMAND  executes the command 

do_version(args)

Usage:
  version pip [PACKAGE]
  version [--format=FORMAT] [--check=CHECK]


Options:
  --format=FORMAT  the format to print the versions in [default: table]
  --check=CHECK    boolean tp conduct an additional check [default: True]

Description:
  version 
      Prints out the version number
  version pip
      Prints the contents of pip list

Limitations:
  Package names must not have a . in them instead you need to use -
  Thus to query for cloudmesh-cmd5 use

    cms version pip cloudmesh-cmd5

emptyline()

Called when an empty line is entered in response to the prompt.

If this method is not overridden, it repeats the last nonempty command entered.

help_help()

Usage:
    help
    help COMMAND

Description:
    List available commands with "help" or detailed help with
    "help COMMAND".

onecmd(line)

Interpret the argument as though it had been typed in response to the prompt.

This may be overridden, but should not normally need to be; see the precmd() and postcmd() methods for useful execution hooks. The return value is a flag indicating whether interpretation of commands by the interpreter should stop.

postcmd(stop, line)

Hook method executed just after a command dispatch is finished.

precmd(line)

Hook method executed just before the command line is interpreted, but after the input prompt is generated and issued.

preloop()

adds the banner to the preloop

class cloudmesh.shell.shell.Plugin

Some simple methods to manage dynamic namespace plugins for cloudmesh.

classmethod class_name(command)

creates the default filename in which the module is defined :param command: the name of the command :return: cloudmesh.ext.command.<command>+command.<Command>

classmethod classes()

list of the commands in the cloudmesh namespace under cloudmesh.ext.command :return: list of the commands

classmethod load(commands=None)

Parameters:commands –

If None the commands will be found from import cloudmesh Otherwise the commands can be explicitly specified with

commands = [

‘cloudmesh.ext.command.bar.BarCommand’, ‘cloudmesh.ext.command.foo.FooCommand’, ]

A namespace package must exists. Foo and Bar ar just examples

Returns:the classes of the command

classmethod modules()

list of cloudmesh modules in the cloudmesh namespace :return: list of modules

classmethod name(command)

creates a name for a modules starting with do_ :param command: returns a tuple with the module location and tge do_function :return:

cloudmesh.shell.shell.PluginCommandClasses

alias of cloudmesh.shell.shell.CommandProxyClass

cloudmesh.shell.shell.main()

cms.

Usage:

cms –help cms [–echo] [–debug] [–nosplash] [-i] [COMMAND …]

Arguments:

COMMAND A command to be executed

Options:

--file=SCRIPT	-f SCRIPT Executes the script
-i	After start keep the shell interactive, otherwise quit [default: False]
--nosplash	do not show the banner [default: False]

cloudmesh.shell.shell.print_list(elements)

prints the element of a list :param elements: the elements to be printed