runners
¶
- class fabric.runners.Remote(*args, **kwargs)¶
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 aConnection
(or subclass) instance for itscontext
argument.New in version 2.0.
- __init__(*args, **kwargs)¶
Thin wrapper for superclass’
__init__
; please see it for details.Additional keyword arguments defined here are listed below.
- Parameters
inline_env (bool) – Whether to ‘inline’ shell env vars as prefixed parameters, instead of trying to submit them via
Channel.update_environment
. Default:True
.
Changed in version 2.3: Added the
inline_env
parameter.Changed in version 3.0: Changed the default value of
inline_env
fromFalse
toTrue
.
- handle_window_change(signum, frame)¶
Respond to a
signal.SIGWINCH
(as a standard signal handler).Sends a window resize command via Paramiko channel method.
- class fabric.runners.Result(**kwargs)¶
An
invoke.runners.Result
exposing whichConnection
was run against.Exposes all attributes from its superclass, then adds a
.connection
, which is simply a reference to theConnection
whose method yielded this result.New in version 2.0.