cmd Package

base Module

class opennode.oms.endpoint.ssh.cmd.base.Cmd(protocol)

Bases: object

arg_parser(*args, **kwargs)

Returns the argument parser for this command.

Use partial=True if you want to tolerate incomplete last token and avoid executing help action (e.g. during completion).

contextual_arg_parser(*args, **kwargs)

If command offers a contextual parser, use it, otherwise fall back to a normal parser.

current_obj

execute(args)

Subclasses should override this if they need parsed arguments.

obj_path

parse_args(*args, **kwargs)

Parse command line arguments. Return a deferred.

path

Current working directory

register(*args, **kwargs)

subject(args)

Provide the subject of the command (usually free arguments and/or current directory path)

subject_from_raw(*args, **kwargs)

Subclasses should override this if they need raw arguments.

traverse(path)

traverse_full(path)

unregister()

write(*args)

Ensure that all writes are serialized regardless if the command is executing in another thread.

class opennode.oms.endpoint.ssh.cmd.base.CommandContextExtractor(context)

Bases: grokcore.component.components.Subscription

get_context()

commands Module

class opennode.oms.endpoint.ssh.cmd.commands.CatLogCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

execute(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.CatObjectCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.ChangeDirCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.CommonArgs(context)

Bases: grokcore.component.components.Subscription

Just an example of common args, not actually sure that -v is needed in every command.

arguments()

class opennode.oms.endpoint.ssh.cmd.commands.CreateObjCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments(*args, **kwargs)

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.EchoCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Outputs the command line arguments.

arguments()

execute(args)

class opennode.oms.endpoint.ssh.cmd.commands.EditCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.FileCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Outputs the type of an object.

arguments()

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.HelpCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Outputs the names of all commands.

arguments(*args, **kwargs)

execute(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.HistoryCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Prints the shell history.

execute(args)

class opennode.oms.endpoint.ssh.cmd.commands.IdCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

execute(args)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.KillTaskCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Implement the kill command which can send signals to tasks.

arguments()

execute(args)

find_task(tid)

class opennode.oms.endpoint.ssh.cmd.commands.LastErrorCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Prints out the last error.

Useful for devs, and users reporting to issue tracker. (Inspired by xsbt)

execute(args)

class opennode.oms.endpoint.ssh.cmd.commands.LinkCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Creates a (sym)link to an object.

arguments()

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.ListDirContentsCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.MoveCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Moves an object.

arguments()

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.NoCommand(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Represents the fact that there is no command yet.

class opennode.oms.endpoint.ssh.cmd.commands.OmsShellCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

This command represents the oms shell. Currently it cannot run a nested shell.

execute(args)

class opennode.oms.endpoint.ssh.cmd.commands.PrintEnvCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Prints the environment variables.

execute(args)

class opennode.oms.endpoint.ssh.cmd.commands.PrintWorkDirCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

execute(args)

class opennode.oms.endpoint.ssh.cmd.commands.QuitCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Quits the console.

execute(args)

class opennode.oms.endpoint.ssh.cmd.commands.RemoveCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Deletes an object.

arguments()

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.SetAttrCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

execute(*args, **kwargs)

subject(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.SetEnvCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Modifies the environment variables.

arguments()

execute(args)

class opennode.oms.endpoint.ssh.cmd.commands.SetOrMkCmdDynamicArguments(context)

Bases: grokcore.component.components.Adapter

Dynamically creates the key=value arguments for the set and mk commands depending on the object or type being edited or created.

arguments(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.SleepCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Do nothing for some time.

arguments()

execute(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.TaskListCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Emulates ‘ps’ command, including bsd args.

arguments()

execute(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.commands.TerminalResetCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

Resets terminal. Useful after interrupting an attach.

arguments()

execute(args)

completers Module

class opennode.oms.endpoint.ssh.cmd.completers.ArgSwitchCompleter(context)

Bases: opennode.oms.endpoint.ssh.cmd.completion.Completer

Completes argument switches based on the argparse grammar exposed for a command

complete(token, parsed, parser, **kwargs)

option_consumed(action, parsed)

class opennode.oms.endpoint.ssh.cmd.completers.CommandCompleter(context)

Bases: opennode.oms.endpoint.ssh.cmd.completers.PathCompleter

Completes a command.

complete(*args, **kwargs)

expected_action(parsed, parser)

class opennode.oms.endpoint.ssh.cmd.completers.EnvironmentCompleter(context)

Bases: opennode.oms.endpoint.ssh.cmd.completion.Completer

complete(token, parsed, parser, protocol=None, **kwargs)

class opennode.oms.endpoint.ssh.cmd.completers.KeywordPathSubCompleter(context, base_path='')

Bases: opennode.oms.endpoint.ssh.cmd.completers.PathCompleter

Implement a FS path completer which works as subcompleter for the keyworded arguments.

complete(*args, **kwargs)

expected_action(parsed, parser)

traverse(path)

class opennode.oms.endpoint.ssh.cmd.completers.KeywordSwitchCompleter(context)

Bases: opennode.oms.endpoint.ssh.cmd.completers.ArgSwitchCompleter

Completes key=value argument switches based on the argparse grammar exposed for a command. TODO: probably more can be shared with ArgSwitchCompleter.

complete(token, parsed, parser, display=False, **kwargs)

class opennode.oms.endpoint.ssh.cmd.completers.KeywordValueCompleter(context)

Bases: opennode.oms.endpoint.ssh.cmd.completers.ArgSwitchCompleter

Completes the value part of key=value constructs based on the type of the keyword. Currently works only for args which declare an explicit enumeration.

complete(token, parsed, parser, **kwargs)

find_action(keyword, parsed, parser)

class opennode.oms.endpoint.ssh.cmd.completers.PathCompleter(context)

Bases: opennode.oms.endpoint.ssh.cmd.completers.PositionalCompleter

Completes a path name.

complete(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.completers.PositionalChoiceCompleter(context)

Bases: opennode.oms.endpoint.ssh.cmd.completers.PositionalCompleter

complete(token, parsed, parser, **kwargs)

class opennode.oms.endpoint.ssh.cmd.completers.PositionalCompleter(context)

Bases: opennode.oms.endpoint.ssh.cmd.completion.Completer

Base class for positional completers.

expected_action(parsed, parser)

Currently expected action. It looks at the cardinalities

completion Module

class opennode.oms.endpoint.ssh.cmd.completion.Completer(context)

Bases: grokcore.component.components.Subscription

opennode.oms.endpoint.ssh.cmd.completion.complete(*args, **kwargs)

Bash like dummy completion, not great like zsh completion. Problems: completion in the middle of a word will screw it (like bash)

directives Module

class opennode.oms.endpoint.ssh.cmd.directives.command(*args, **kw)

Bases: martian.directive.Directive

Use this directive in a class in order to set its command name. Only classes marked with this directive will be valid commands.

default = None

scope = <martian.directive.ClassScope object at 0x2821cd0>

store = <martian.directive.StoreOnce object at 0x2821910>

class opennode.oms.endpoint.ssh.cmd.directives.alias(*args, **kw)

Bases: martian.directive.Directive

Use this directive in a class in order to add an alias. TODO: make it work with multiple aliases.

default = None

scope = <martian.directive.ClassScope object at 0x2821cd0>

store = <martian.directive.StoreOnce object at 0x2821910>

grokkers Module

class opennode.oms.endpoint.ssh.cmd.grokkers.AliasGrokker

Bases: martian.components.ClassGrokker

execute(class_, alias, **kwargs)

class opennode.oms.endpoint.ssh.cmd.grokkers.CmdGrokker

Bases: martian.components.ClassGrokker

execute(class_, command, **kw)

registry Module

opennode.oms.endpoint.ssh.cmd.registry.commands()

A map of command names to command objects.

opennode.oms.endpoint.ssh.cmd.registry.get_command(name)

Returns the command class for a given name.

Returns NoCommand if the name is empty. Returns UnknownCommand if the command does not exist.

security Module

class opennode.oms.endpoint.ssh.cmd.security.GetAclCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

execute(*args, **kwargs)

exception opennode.oms.endpoint.ssh.cmd.security.NoSuchPermission

Bases: exceptions.Exception

class opennode.oms.endpoint.ssh.cmd.security.PermCheckCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

check_rights(obj, args)

execute(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.security.SetAclCmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

arguments()

execute(*args, **kwargs)

class opennode.oms.endpoint.ssh.cmd.security.WhoAmICmd(protocol)

Bases: opennode.oms.endpoint.ssh.cmd.base.Cmd

execute(args)

opennode.oms.endpoint.ssh.cmd.security.effective_perms(interaction, obj)

opennode.oms.endpoint.ssh.cmd.security.pretty_effective_perms(interaction, obj)