ssh Package

cmdline Module

exception opennode.oms.endpoint.ssh.cmdline.ArgumentParsingError(status, message=None)

Bases: exceptions.Exception

exception opennode.oms.endpoint.ssh.cmdline.ArgumentParsingInterrupted

Bases: opennode.oms.endpoint.ssh.cmdline.ArgumentParsingError

class opennode.oms.endpoint.ssh.cmdline.GroupDictAction(group='group', is_path=False, base_path='', **kwargs)

Bases: argparse.Action

Extends argparser with an action suited for key=value keyword arguments. Each arg declared with a KeywordAction, will be put inside a dictionary (by default called keywords) inside the resulting arg object.

This is particularly useful if you have a number of dynamically defined args which would otherwise end up in cluttering the resulting arg object without a clear way to enumerate them all.

You can override this grouping with the group parameter.

class opennode.oms.endpoint.ssh.cmdline.InstrumentableArgumentParser(file=None, *args, **kwargs)

Bases: argparse.ArgumentParser

ArgumentParser subclass that raises an exception instead of exiting in case of errors, and allows all output to be redirected to a custom output stream.

error(message)

exit(status=0, message=None)

class opennode.oms.endpoint.ssh.cmdline.MergeListAction(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: argparse.Action

Custom argparse action which allows multiple occurrences of multivalued optional arguments, e.g. -x a b -x c d will yield [‘a’, ‘b’, ‘c’, ‘d’].

class opennode.oms.endpoint.ssh.cmdline.PartialVirtualConsoleArgumentParser(file=None, add_help=None, *args, **kwargs)

Bases: opennode.oms.endpoint.ssh.cmdline.VirtualConsoleArgumentParser

Use this if you want to avoid printing error messages and retry on partial arglists.

parse_args(args=None, namespace=None)

class opennode.oms.endpoint.ssh.cmdline.VirtualConsoleArgumentParser(add_help=None, *args, **kwargs)

Bases: opennode.oms.endpoint.ssh.cmdline.InstrumentableArgumentParser

This parser avoids using the argparse help action, since it fires during the parsing, We want to pospone the handling of help until after the args are parsed.

declare_argument(dest, default=None)

Declares the existence of an argument without adding a requirement and an option string for it.

It’s useful for GroupDictAction argument or other actions where multiple arguments store in the same value. The dest attribute for declared arguments will have its default value even if no argument was defined or matched.

parse_args(args=None, namespace=None)

class opennode.oms.endpoint.ssh.cmdline.VirtualConsoleHelpFormatter(prog, indent_increment=2, max_help_position=24, width=None)

Bases: argparse.HelpFormatter

Takes care of presenting our special keyworded options in their canonical key = value form.

format_help()

colored_columnize Module

Returns a compact set of columns as a string with newlines for an array of strings.

Adapted from the routine of the same name inside cmd.py

mmikulicic: taken from http://pypi.python.org/pypi/columnize and adapted for strings containing ANSI escapes (should work mostly for colors).

opennode.oms.endpoint.ssh.colored_columnize.bw(text)

Plain black and white text.

opennode.oms.endpoint.ssh.colored_columnize.color_ljust(text, size)

opennode.oms.endpoint.ssh.colored_columnize.color_rjust(text, size)

opennode.oms.endpoint.ssh.colored_columnize.columnize(array, displaywidth=80, colsep=' ', arrange_vertical=True, ljust=True, lineprefix='')

Return a list of strings as a compact set of columns arranged

horizontally or vertically.

For example, for a line width of 4 characters (arranged vertically):

[‘1’, ‘2,’, ‘3’, ‘4’] => ‘1 3

2 4 ‘

or arranged horizontally:

[‘1’, ‘2,’, ‘3’, ‘4’] => ‘1 2

3 4 ‘

Each column is only as wide as necessary. By default, columns are separated by two spaces - one was not legible enough. Set “colsep” to adjust the string separate columns. Set `displaywidth’ to set the line width.

Normally, consecutive items go down from the top to bottom from the left-most column to the right-most. If “arrange_vertical” is set false, consecutive items will go across, left to right, top to bottom.

detached Module

class opennode.oms.endpoint.ssh.detached.DetachedProtocol

Bases: object

This represents a detached background protocol used to execute commands in background and redirect output to logs

write(*args, **kwargs)

editable Module

class opennode.oms.endpoint.ssh.editable.EditableModelAdapter(context)

Bases: grokcore.component.components.Adapter

toEditableString(descriptions=False)

editor Module

class opennode.oms.endpoint.ssh.editor.Editor(parent)

Bases: object

COMMENT_COLOR = '\x1b[0;31m'

MODELINE_HEIGHT = 2

abort()

bol_pos(from_pos=None)

char_at(pos)

delete_character()

draw_modeline(text)

draw_status(text)

enable_tracing()

eol_pos()

finalize_tracing()

fixup_for_shorter_line(go_forward)

goto_next_line()

goto_prev_line()

handle_BACKSPACE()

handle_BEGIN_LINE()

handle_DOWN()

handle_DUMP_BUFFER()

handle_END_LINE()

handle_EOF()

handle_EXIT()

handle_KILL_LINE()

handle_LEFT()

handle_REDRAW()

handle_RIGHT()

handle_SAVE()

handle_UP()

handle_WHAT_CURSOR_POSITION()

handle_YANK()

insert_character(ch)

keystrokeReceived(*args, **kwargs)

redraw_buffer()

refresh_modline()

replay_recorded()

Debug utility useful for repeating difficult to reproduce sessions that show some bug

reset_scrolling_region()

show_keys(keys, prefix='C-')

start(*args, **kwargs)

trace_keystroke(keyID, mod)

wait_for_exit()

write(text)

protocol Module

class opennode.oms.endpoint.ssh.protocol.CallbackExecutionSubProtocol

Bases: object

keystrokeReceived(keyID, mod)

class opennode.oms.endpoint.ssh.protocol.CommandExecutionSubProtocol(parent)

Bases: object

handle_EOF()

keystrokeReceived(keyID, mod)

class opennode.oms.endpoint.ssh.protocol.OmsShellProtocol

Bases: opennode.oms.endpoint.ssh.terminal.InteractiveTerminal

The OMS virtual console over SSH.

Accepts lines of input and writes them back to its connection. If a line consisting solely of “quit” is received, the connection is dropped.

close_connection()

connectionMade()

dataReceived(data)

ensure_initialized(*args, **kwargs)

exit_sub_protocol()

expand(command, tokens)

expand_token(command, token)

get_command_class(name)

handle_EOF()

handle_TAB(*args, **kwargs)

hist_file_name

keystrokeReceived(keyID, modifier)

lineReceived(*args, **kwargs)

logged_in(principal)

Invoked when the principal which opened this session is known

static make_path(path)

parse_line(*args, **kwargs)

Returns a command instance and parsed cmdline argument list.

TODO: Shell expansion should be handled here.

ps

spawn_command(*args, **kwargs)

spawn_commands(*args, **kwargs)

class opennode.oms.endpoint.ssh.protocol.ProtocolContextExtractor(context)

Bases: grokcore.component.components.Subscription

get_context()

opennode.oms.endpoint.ssh.protocol.dataReceived(self, data)

opennode.oms.endpoint.ssh.protocol.protocolInlineCallbacks(fun)

Executes protocol async callbacks while buffering next keystrokes during the execution of the callback. After the callback finishes the buffered keystrokes will be replayed back, but currently only non-special characters are replayed, since special characters could trigger a reentrant here which would inject keystrokes out of order.

pubkey Module

class opennode.oms.endpoint.ssh.pubkey.InMemoryPublicKeyCheckerDontUse

Bases: twisted.conch.checkers.SSHPublicKeyDatabase

Loads the public key from ~/.ssh/id_[rd]sa.pub at startup, and accepts logins for those keys Designed for testing, especially local testing.

checkKey(credentials)

Accepts any user name

session Module

class opennode.oms.endpoint.ssh.session.BatchOmsShellProtocol

Bases: opennode.oms.endpoint.ssh.protocol.OmsShellProtocol

batch = True

lineReceived(line)

Ignore input, we are not a shell

class opennode.oms.endpoint.ssh.session.OmsSSHSession(*args, **kw)

Bases: twisted.conch.ssh.session.SSHSession

request_agent(data)

request_env(data)

request_x11_req(data)

class opennode.oms.endpoint.ssh.session.OmsTerminalRealm

Bases: twisted.conch.manhole_ssh.TerminalRealm

class opennode.oms.endpoint.ssh.session.OmsTerminalSession(original)

Bases: twisted.conch.manhole_ssh.TerminalSession

execCommand(proto, cmd)

class opennode.oms.endpoint.ssh.session.OmsTerminalSessionTransport(proto, chainedProtocol, avatar, width, height)

Bases: twisted.conch.manhole_ssh.TerminalSessionTransport

class opennode.oms.endpoint.ssh.session.OmsTerminalUser(original, avatarId)

Bases: twisted.conch.manhole_ssh.TerminalUser

terminal Module

class opennode.oms.endpoint.ssh.terminal.InteractiveTerminal

Bases: twisted.conch.recvline.HistoricRecvLine

Advanced interactive terminal. Handles history, line editing, killing/yanking, line movement.

Prompt handling is delegated to subclasses.

batch = False

close_connection()

Closes the connection and saves history.

colorize(color, text)

connectionMade()

enter_full_screen()

Switch to the full screen plane, used for editors.

exit_full_screen()

Switch back to the normal plane.

handle_ABORT()

Abort a search.

handle_BACKWARD_KILL_WORD()

Provides the ALT-BACKSPACE behaviour like in emacs/bash.

handle_EOF()

Exits the shell on CTRL-D

handle_EXIT_SEARCH()

Exits search mode and edit the found history line.

handle_FF()

Handles a ‘form feed’ byte - generally used to request a screen refresh/redraw.

handle_KILL_LINE()

Deletes the rest of the line (from the cursor right), and keeps the content in the kill ring for future pastes.

handle_QUIT()

Just copied from conch Manhole, no idea why it would be useful to differentiate it from CTRL-D, but I guess it’s here for a reason.

handle_SEARCH()

handle_SEARCH_NEXT()

handle_SEARCH_RETURN()

handle_TRANSPOSE()

Provides the CTRL-T behaviour like on emacs/bash.

handle_UPDATE_SEARCH(skip=0)

handle_YANK()

Pastes the content of the kill ring.

hist_file_name

initializeScreen()

insert_buffer(buf)

Inserts some chars in the buffer at the current cursor position.

insert_text(text)

Inserts some text at the current cursor position and renders it.

keystrokeReceived(keyID, modifier)

print_prompt()

restore_history()

save_history()

search_ps

set_terminal(terminal)

terminalSize(width, height)

Avoid clearing the whole screen

terminalSizeAfterLogin()

Part of terminalSize executed after login

tokenizer Module

exception opennode.oms.endpoint.ssh.tokenizer.CommandLineSyntaxError(message)

Bases: exceptions.Exception

The commandline has a syntax error and cannot be even tokenized correctly

class opennode.oms.endpoint.ssh.tokenizer.CommandLineTokenizer

Bases: object

Tokenizer for the commandline, handling escaped space, quotes, escaped quotes and also special key=value syntax. It tries to provide user friendly error messages where possible.

tokenize(args)

Subpackages

• cmd Package
  • base Module
  • commands Module
  • completers Module
  • completion Module
  • directives Module
  • grokkers Module
  • registry Module
  • security Module