Index

_ | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | R | S | T | U | V | W

_

__call__() (plumbum.commands.base.BaseCommand method)
(plumbum.machines.env.BaseEnv method)
(plumbum.path.local.LocalWorkdir method)
(plumbum.path.remote.RemoteWorkdir method)
__contains__() (plumbum.machines.env.BaseEnv method)
(plumbum.machines.local.LocalMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
__delitem__() (plumbum.machines.env.BaseEnv method)
(plumbum.machines.remote.RemoteEnv method)
__div__() (plumbum.path.base.Path method)
__floordiv__() (plumbum.path.base.Path method)
__ge__() (plumbum.commands.base.BaseCommand method)
__getitem__() (plumbum.commands.base.BaseCommand method)
(plumbum.machines.env.BaseEnv method)
(plumbum.machines.local.LocalMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
__gt__() (plumbum.commands.base.BaseCommand method)
__iter__() (plumbum.machines.env.BaseEnv method)
(plumbum.path.base.Path method)
__len__() (plumbum.machines.env.BaseEnv method)
__lshift__() (plumbum.commands.base.BaseCommand method)
__lt__() (plumbum.commands.base.BaseCommand method)
__or__() (plumbum.commands.base.BaseCommand method)
__rshift__() (plumbum.commands.base.BaseCommand method)
__setitem__() (plumbum.machines.env.BaseEnv method)
(plumbum.machines.remote.RemoteEnv method)
__sub__() (plumbum.path.base.Path method)
__truediv__() (plumbum.path.base.Path method)
__weakref__ (plumbum.commands.base.RedirectionError attribute)
(plumbum.commands.modifiers.Future attribute)
(plumbum.commands.processes.CommandNotFound attribute)
(plumbum.commands.processes.ProcessExecutionError attribute)
(plumbum.commands.processes.ProcessTimedOut attribute)
(plumbum.machines.local.LocalMachine attribute)
(plumbum.machines.remote.BaseRemoteMachine attribute)
(plumbum.machines.session.SessionPopen attribute)
(plumbum.machines.session.ShellSession attribute)
(plumbum.machines.session.ShellSessionError attribute)
(plumbum.path.base.FSUser attribute)
(plumbum.path.base.RelativePath attribute)
(plumbum.path.remote.RemoteWorkdir attribute)
(plumbum.path.remote.StatRes attribute)

A

access() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
acquire() (plumbum.fs.atomic.PidFile method)
alive() (plumbum.machines.session.ShellSession method)
Application (class in plumbum.cli.application)
as_root() (plumbum.machines.local.LocalMachine method)
as_user() (plumbum.machines.local.LocalMachine method)
ask() (in module plumbum.cli.terminal)
AtomicCounterFile (class in plumbum.fs.atomic)
AtomicFile (class in plumbum.fs.atomic)
autoswitch() (in module plumbum.cli.switches)

B

BaseCommand (class in plumbum.commands.base)
BaseEnv (class in plumbum.machines.env)
basename (plumbum.path.base.Path attribute)
(plumbum.path.local.LocalPath attribute)
(plumbum.path.remote.RemotePath attribute)
BaseRemoteMachine (class in plumbum.machines.remote)
BG (in module plumbum.commands.modifiers)
bgrun() (plumbum.commands.base.BaseCommand method)

C

chdir() (plumbum.path.local.LocalWorkdir method)
(plumbum.path.remote.RemoteWorkdir method)
chmod() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
choose() (in module plumbum.cli.terminal)
chown() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
cleanup() (plumbum.cli.application.Application method)
clear() (plumbum.machines.env.BaseEnv method)
close() (plumbum.machines.remote.BaseRemoteMachine method)
(plumbum.machines.session.MarkedPipe method)
(plumbum.machines.session.ShellSession method)
(plumbum.machines.ssh_machine.SshTunnel method)
CommandNotFound
communicate() (plumbum.machines.session.SessionPopen method)
connect_sock() (plumbum.machines.paramiko_machine.ParamikoMachine method)
copy() (in module plumbum.path.utils)
(plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
CountOf (class in plumbum.cli.switches)

D

daemonic_popen() (plumbum.machines.local.LocalMachine method)
delete() (in module plumbum.path.utils)
(plumbum.fs.atomic.AtomicFile method)
(plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
dirname (plumbum.path.base.Path attribute)
(plumbum.path.local.LocalPath attribute)
(plumbum.path.remote.RemotePath attribute)
download() (plumbum.machines.paramiko_machine.ParamikoMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
(plumbum.machines.ssh_machine.SshMachine method)

E

exists() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
expand() (plumbum.machines.local.LocalEnv method)
(plumbum.machines.remote.RemoteEnv method)
expanduser() (plumbum.machines.local.LocalEnv method)
(plumbum.machines.remote.RemoteEnv method)

F

Flag (class in plumbum.cli.switches)
formulate() (plumbum.commands.base.BaseCommand method)
FSUser (class in plumbum.path.base)
Future (class in plumbum.commands.modifiers)

G

get() (plumbum.machines.env.BaseEnv method)
get_terminal_size() (in module plumbum.cli.terminal)
getdelta() (plumbum.machines.remote.RemoteEnv method)
getdict() (plumbum.machines.env.BaseEnv method)
getpath() (plumbum.path.local.LocalWorkdir method)
(plumbum.path.remote.RemoteWorkdir method)
gid (plumbum.path.base.Path attribute)
(plumbum.path.local.LocalPath attribute)
(plumbum.path.remote.RemotePath attribute)
glob() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)

H

help() (plumbum.cli.application.Application method)
helpall() (plumbum.cli.application.Application method)
hexdump() (in module plumbum.cli.terminal)
home (plumbum.machines.env.BaseEnv attribute)

I

invoke() (plumbum.cli.application.Application class method)
isdir() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
isfile() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
islink() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
items() (plumbum.machines.env.BaseEnv method)
iter_lines() (in module plumbum.commands.processes)
(plumbum.commands.base.BaseCommand method)

J

join() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)

K

keys() (plumbum.machines.env.BaseEnv method)

L

link() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
list() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
list_processes() (plumbum.machines.local.LocalMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
local (in module plumbum.machines.local)
LocalEnv (class in plumbum.machines.local)
LocalMachine (class in plumbum.machines.local)
LocalPath (class in plumbum.path.local)
LocalWorkdir (class in plumbum.path.local)
locked() (plumbum.fs.atomic.AtomicFile method)

M

main() (plumbum.cli.application.Application method)
MarkedPipe (class in plumbum.machines.session)
MissingArgument
MissingMandatorySwitch
mkdir() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
mount_table() (in module plumbum.fs.mounts)
mounted() (in module plumbum.fs.mounts)
MountEntry (class in plumbum.fs.mounts)
move() (in module plumbum.path.utils)
(plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)

N

next() (plumbum.fs.atomic.AtomicCounterFile method)
nohup() (plumbum.machines.ssh_machine.SshMachine method)

O

open() (plumbum.fs.atomic.AtomicCounterFile class method)
(plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)

P

pager() (in module plumbum.cli.terminal)
ParamikoMachine (class in plumbum.machines.paramiko_machine)
Path (class in plumbum.path.base)
path (plumbum.machines.env.BaseEnv attribute)
path() (plumbum.machines.local.LocalMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
pgrep() (plumbum.machines.local.LocalMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
PidFile (class in plumbum.fs.atomic)
PidFileTaken
plumbum.cli.application (module)
plumbum.cli.switches (module)
plumbum.cli.terminal (module)
plumbum.commands.base (module)
plumbum.commands.daemons (module)
plumbum.commands.modifiers (module)
plumbum.commands.processes (module)
plumbum.fs.atomic (module)
plumbum.fs.mounts (module)
plumbum.machines.env (module)
plumbum.machines.local (module)
plumbum.machines.paramiko_machine (module)
plumbum.machines.remote (module)
plumbum.machines.session (module)
plumbum.machines.ssh_machine (module)
plumbum.path.base (module)
plumbum.path.local (module)
plumbum.path.remote (module)
plumbum.path.utils (module)
poll() (plumbum.commands.modifiers.Future method)
(plumbum.machines.session.SessionPopen method)
pop() (plumbum.machines.env.BaseEnv method)
(plumbum.machines.remote.RemoteEnv method)
popen() (plumbum.commands.base.BaseCommand method)
(plumbum.machines.paramiko_machine.ParamikoMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
(plumbum.machines.session.ShellSession method)
(plumbum.machines.ssh_machine.SshMachine method)
PositionalArgumentsError
Predicate (class in plumbum.cli.switches)
ProcessExecutionError
ProcessTimedOut
PuttyMachine (class in plumbum.machines.ssh_machine)
python (plumbum.machines.local.LocalMachine attribute)
(plumbum.machines.remote.BaseRemoteMachine attribute)

R

Range (class in plumbum.cli.switches)
read() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
read_atomic() (plumbum.fs.atomic.AtomicFile method)
read_shared() (plumbum.fs.atomic.AtomicFile method)
readline() (in module plumbum.cli.terminal)
(plumbum.machines.session.MarkedPipe method)
ready() (plumbum.commands.modifiers.Future method)
RedirectionError
relative_to() (plumbum.path.base.Path method)
RelativePath (class in plumbum.path.base)
release() (plumbum.fs.atomic.PidFile method)
RemoteEnv (class in plumbum.machines.remote)
RemotePath (class in plumbum.path.remote)
RemoteWorkdir (class in plumbum.path.remote)
rename() (plumbum.path.base.Path method)
reopen() (plumbum.fs.atomic.AtomicFile method)
reset() (plumbum.fs.atomic.AtomicCounterFile method)
returncode (plumbum.commands.modifiers.Future attribute)
run() (plumbum.cli.application.Application class method)
(plumbum.commands.base.BaseCommand method)
(plumbum.machines.session.ShellSession method)
run_proc() (in module plumbum.commands.processes)

S

session() (plumbum.machines.local.LocalMachine method)
(plumbum.machines.paramiko_machine.ParamikoMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
(plumbum.machines.ssh_machine.PuttyMachine method)
(plumbum.machines.ssh_machine.SshMachine method)
SessionPopen (class in plumbum.machines.session)
Set (class in plumbum.cli.switches)
setenv() (plumbum.commands.base.BaseCommand method)
sftp (plumbum.machines.paramiko_machine.ParamikoMachine attribute)
ShellSession (class in plumbum.machines.session)
ShellSessionError
shquote() (in module plumbum.commands.base)
split() (plumbum.path.base.Path method)
SshMachine (class in plumbum.machines.ssh_machine)
SshTunnel (class in plumbum.machines.ssh_machine)
StatRes (class in plumbum.path.remote)
stderr (plumbum.commands.modifiers.Future attribute)
stdout (plumbum.commands.modifiers.Future attribute)
subcommand() (plumbum.cli.application.Application class method)
SubcommandError
switch() (in module plumbum.cli.switches)
SwitchAttr (class in plumbum.cli.switches)
SwitchCombinationError
SwitchError
symlink() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)

T

tempdir() (plumbum.machines.local.LocalMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
tunnel() (plumbum.machines.ssh_machine.SshMachine method)

U

uid (plumbum.path.base.Path attribute)
(plumbum.path.local.LocalPath attribute)
(plumbum.path.remote.RemotePath attribute)
unbind_switches() (plumbum.cli.application.Application class method)
UnknownSwitch
unlink() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
up() (plumbum.path.base.Path method)
update() (plumbum.machines.env.BaseEnv method)
(plumbum.machines.remote.RemoteEnv method)
upload() (plumbum.machines.paramiko_machine.ParamikoMachine method)
(plumbum.machines.remote.BaseRemoteMachine method)
(plumbum.machines.ssh_machine.SshMachine method)
user (plumbum.machines.env.BaseEnv attribute)

V

values() (plumbum.machines.env.BaseEnv method)
version() (plumbum.cli.application.Application method)

W

wait() (plumbum.commands.modifiers.Future method)
(plumbum.machines.session.SessionPopen method)
walk() (plumbum.path.base.Path method)
which() (plumbum.machines.local.LocalMachine class method)
(plumbum.machines.remote.BaseRemoteMachine method)
with_env() (plumbum.commands.base.BaseCommand method)
write() (plumbum.path.base.Path method)
(plumbum.path.local.LocalPath method)
(plumbum.path.remote.RemotePath method)
write_atomic() (plumbum.fs.atomic.AtomicFile method)
WrongArgumentType