fabric.runners.Remote

class documentation

class Remote(Runner): (source)

Known subclasses: fabric.runners.RemoteShell

View In Hierarchy

Run a shell command over an SSH connection. This class subclasses `invoke.runners.Runner`; please see its documentation for most public API details. .. note:: `.Remote`'s ``__init__`` method expects a `.Connection` (or subclass) instance for its ``context`` argument. .. versionadded:: 2.0

Method __init__ Thin wrapper for superclass' ``__init__``; please see it for details.
Method close_proc_stdin Undocumented
Method generate_result Undocumented
Method handle_window_change Respond to a `signal.SIGWINCH` (as a standard signal handler).
Method kill Undocumented
Method read_proc_stderr Undocumented
Method read_proc_stdout Undocumented
Method returncode Undocumented
Method run Undocumented
Method send_interrupt Undocumented
Method send_start_message Undocumented
Method start Undocumented
Method stop Undocumented
Instance Variable channel Undocumented
Instance Variable inline_env Undocumented
Property process_is_finished Undocumented
Method _write_proc_stdin Undocumented
def __init__(self, *args, **kwargs): (source)

Thin wrapper for superclass' ``__init__``; please see it for details. Additional keyword arguments defined here are listed below. :param bool inline_env: Whether to 'inline' shell env vars as prefixed parameters, instead of trying to submit them via `.Channel.update_environment`. Default: ``True``. .. versionchanged:: 2.3 Added the ``inline_env`` parameter. .. versionchanged:: 3.0 Changed the default value of ``inline_env`` from ``False`` to ``True``.

def close_proc_stdin(self): (source)

Undocumented

def generate_result(self, **kwargs): (source)

Undocumented

def handle_window_change(self, signum, frame): (source)

Respond to a `signal.SIGWINCH` (as a standard signal handler). Sends a window resize command via Paramiko channel method.

def kill(self): (source)

Undocumented

def read_proc_stderr(self, num_bytes): (source)

Undocumented

def read_proc_stdout(self, num_bytes): (source)

Undocumented

def returncode(self): (source)

Undocumented

def run(self, command, **kwargs): (source)

Undocumented

def send_interrupt(self, interrupt): (source)

Undocumented

def send_start_message(self, command): (source)
overridden in fabric.runners.RemoteShell

Undocumented

def start(self, command, shell, env, timeout=None): (source)

Undocumented

def stop(self): (source)

Undocumented

channel = (source)

Undocumented

inline_env = (source)

Undocumented

@property
process_is_finished = (source)

Undocumented

def _write_proc_stdin(self, data): (source)

Undocumented