| | |
- pexpect.exceptions.ExceptionPexpect(exceptions.Exception)
-
- psftp.psftp.ExceptionPsftpInteraction
- psftp.psftp.ExceptionPsftpLocal
- pexpect.pty_spawn.spawn(pexpect.spawnbase.SpawnBase)
-
- psftp.psftp.psftp
class psftp(pexpect.pty_spawn.spawn) |
| |
This class extends pexpect.spawn to specialize setting up sftp
connections. This add methods for login, logout, interactive commands and
expecting the shell prompt. It does various tricky things to handle many
situations in the sftp login process and interactive commands process.
For example, if the session is you first login, the psftp automatically
accepts the remote certificate, or if you have public key authenticate
setup then pxssh won't wait for the password prompt.
Example that runs a few commands on a remote server and prints the result::
import psftp
import getpass
try:
s = psftp.sftp()
hostname = raw_input('hostname: ')
username = raw_input('username: ')
password = getpass.getpass('password: ')
s.login(hostname, username, password)
s.pwd()
s.lpwd()
s.lls()
s.ls()
s.put('./hello.txt')
s.ls()
except:
pass
Example showing how to specify ssh options::
import psftp
s = psftp.psftp(options={
"StrictHostKeyChecking": "no",
"UserKnownHostsFile": "/dev/null"}
)
# ...
Note that if you have ssh-agent running while doing development with psftp
then this can lead to a lot of confusion. Many X display managers (xdm,
gdm, kdm, etc.) will automatically start a GUI agent. You may see a GUI
dialog box popup asking for a password during development. You should turn
off any key agents during testing. The 'force_password' attribute will turn
off public key authentication. This will only work if the remote SSH server
is configured to allow password logins. Example of useing 'force_password'
attribute::
s = psftp.psftp()
s.force_password = True
hostname = raw_input('hostname: ')
username = raw_input('username: ')
password = getpass.getpass('password: ')
s.login (hostname, username, password)
|
| |
- Method resolution order:
- psftp
- pexpect.pty_spawn.spawn
- pexpect.spawnbase.SpawnBase
- __builtin__.object
Methods defined here:
- __init__(self, timeout=60, maxread=100, searchwindowsize=None, logfile=None, cwd=None, env=None, ignore_sighup=True, echo=True, options={}, encoding=None, codec_errors='strict')
- cd(self, path)
- Change remote directory to path.
- chgrp(self, grp, path)
- Change group of file path to grp. path may contain glob(3)
characters and may match multiple files. grp must be a numeric GID.
- chmod(self, mode, path)
- Change permissions of file path to mode. path may contain glob(3)
characters and may match multiple files.
- df(self, path='', options='')
- Display usage information for the filesystem holding the current
directory (of path if specified).
*attention* This function is only supported on servers that implement
the "statvfs@openssh.com" extension.
:options: every char is one of 'hi'.
-h the capacity information will be displayed using human-readable
suffixes.
-i display of inode information in addition to capacity information.
:return: tuple, the first value is the item list
the second is the value list
- get(self, remote_path, local_path='', options='')
- Retrieve the remote-path and store it on the local machine. If the
local path name is not specified, it is given the same name it has on
the remote machine. rempte-path may contain glob(3) characters and may
match multiple files. If it does and local-path is specified, then
local-path must specify a directory.
:options: every char is one of 'afPpr'.
-a attempt to resume partial transfers of existing files.
Note that resumption assumes that any partial copy of the local file
matches the remote copy. If the remote file contents differ from the
partial local copy then the resultant file is likely to corrupt.
-f fsync(2) will be called after the file transfer has completed
to flush the file to disk.
-P,-p full file permissions and access times are copied too.
-r directories will be copied recursively. Note that sftp
does not follow symbolic links when performing recursive transfers.
- help(self)
- Display help text.
- lcd(self, path)
- Change local directory to path
- lls(self, path='', options='')
- Display local directory listing of either path or current directory
if path is not specified. options may contain any flags supported by
the local system's ls(1) command. path may contain glob(3) characters
and may match multiple files.
:returns: lines of output
- lmkdir(self, path)
- Create local directory specified by path.
- ln(self, oldpath, newpath, options='')
- Create a link from oldpath to newpath in remote server.
:options: every char is one of 's'.
-s created link is a symbolic link, otehrwise it's a hard link.
- local_command(self, command)
- Execute command in local shell
- login(self, server, username, password='', terminal_type='ansi', login_timeout=10, port=None, ssh_key=None, quiet=True, check_local_ip=True)
- This logs the user into the given server.
- logout(self)
- Sends exit to the remote shell.
If there are stopped jobs then this automatically sends exit twice.
- lpwd(self)
- Get local working directory.
- ls(self, path='', options='')
- Display a remote directory listing of either path or the current
directory if path is not specified. path may contain glob(3) characters
and may match multiple files.
:options: every char is one of '1afhlnrSt'.
-1 Produce single columnar output.
-a List files begining with a dot ('.').
-f Do not sort the listing. The default sort order is lexicographical.
-h When used with a long format option, use unit suffixes: Byte,
Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in
order to reduce the number of digits to four or fewer using powers
of 2 for sizes (K=1024, M=1048576, etc.).
-l Display additional details includeing permissions and ownership
information.
-n Produce a long listing with user and group information presented
numerically.
-r Reverse the sort order of the listing.
-S Sort the listing by file size.
-t Sort the listing by last modification time.
:return: lines of output
- lumask(self, umask)
- Set localumask to umask
- mkdir(self, path)
- Create remote directory specified by path.
- progress(self)
- Toggle display of progress meter.
- prompt(self, timeout=-1)
- Match the next shell prompt.
This is little more than a short-cut to the
:meth:`~pexpect.spawn.expect` method.
Note that if you called :meth:`login` with
Calling :meth:`prompt` will erase the contents of the :attr:`before`
attribute even if no prompt is ever matched. If timeout is not given or
it is set to -1 then self.timeout is used.
:return: True if the shell prompt was matched, False if the timeout was
reached.
- put(self, local_path, remote_path='', options='')
- Upload local-path and store it on the remote machine. If the remote
path name is not specified, it is given the same name it has on the
local machine. local-path may contain glob(3) characters and may match
multiple files. If it does and remote-path is specified, then
remote-path speciff a directory.
:options: every char is one of 'afPpr'.
-a attempt to resume partial transfers of existing files.
Note that resumption assumes that any partial copy of the remote file
matches the local copy. If the local file contents differ from the
remote local copy then the resultant file is likely to the corrupt.
-f a request will be send to the server to call fsync(2) after the
file has been transferred. Note that this is only supported by servers
that implement the "fsync@openssh.com" extension.
-P,-p full file permissions and access times are copied too.
-r directories will be copied recursively. Note that sftp
does not follow symbolic links when performing recursive transfers.
- pwd(self)
- Get remote working directory.
- reget(self, remote_path, local_path='', options='')
- Resume download of remote-path.
Equivalent to get with the -a flag set.
:options: every char is one of 'Ppr'.
-P,-p full file permissions and access times are copied too.
-r directories will be copied recursively. Note that sftp
does not follow symbolic links when performing recursive transfers.
- rename(self, oldpath, newpath)
- Rename remote file from oldpath to newpath
- reput(self, remote_path, local_path='', options='')
- Resume upload of local_path.
Equivalent to put with the -a flag set.
:options: every char is one of '1afhlnrSt'.
-P,-p full file permissions and access times are copied too.
-r directories will be copied recursively. Note that sftp
does not follow symbolic links when performing recursive transfers.
- rm(self, path)
- Delete remote file specified by path
- rmdir(self, path)
- Remote remote directory specified by path.
- symlink(self, oldpath, newpath)
- Create a symbolic link from oldpath to newpath.
- version(self)
- Display the sftp protocol version.
Methods inherited from pexpect.pty_spawn.spawn:
- __str__(self)
- This returns a human-readable string that represents the state of
the object.
- close(self, force=True)
- This closes the connection with the child application. Note that
calling close() more than once is valid. This emulates standard Python
behavior with files. Set force to True if you want to make sure that
the child is terminated (SIGKILL is sent if the child ignores SIGHUP
and SIGINT).
- eof(self)
- This returns True if the EOF exception was ever raised.
- getecho(self)
- This returns the terminal echo mode. This returns True if echo is
on or False if echo is off. Child applications that are expecting you
to enter a password often set ECHO False. See waitnoecho().
Not supported on platforms where ``isatty()`` returns False.
- getwinsize(self)
- This returns the terminal window size of the child tty. The return
value is a tuple of (rows, cols).
- interact(self, escape_character='\x1d', input_filter=None, output_filter=None)
- This gives control of the child process to the interactive user (the
human at the keyboard). Keystrokes are sent to the child process, and
the stdout and stderr output of the child process is printed. This
simply echos the child stdout and child stderr to the real stdout and
it echos the real stdin to the child stdin. When the user types the
escape_character this method will return None. The escape_character
will not be transmitted. The default for escape_character is
entered as ``Ctrl - ]``, the very same as BSD telnet. To prevent
escaping, escape_character may be set to None.
If a logfile is specified, then the data sent and received from the
child process in interact mode is duplicated to the given log.
You may pass in optional input and output filter functions. These
functions should take a string and return a string. The output_filter
will be passed all the output from the child process. The input_filter
will be passed all the keyboard input from the user. The input_filter
is run BEFORE the check for the escape_character.
Note that if you change the window size of the parent the SIGWINCH
signal will not be passed through to the child. If you want the child
window size to change when the parent's window size changes then do
something like the following example::
import pexpect, struct, fcntl, termios, signal, sys
def sigwinch_passthrough (sig, data):
s = struct.pack("HHHH", 0, 0, 0, 0)
a = struct.unpack('hhhh', fcntl.ioctl(sys.stdout.fileno(),
termios.TIOCGWINSZ , s))
global p
p.setwinsize(a[0],a[1])
# Note this 'p' global and used in sigwinch_passthrough.
p = pexpect.spawn('/bin/bash')
signal.signal(signal.SIGWINCH, sigwinch_passthrough)
p.interact()
- isalive(self)
- This tests if the child process is running or not. This is
non-blocking. If the child was terminated then this will read the
exitstatus or signalstatus of the child. This returns True if the child
process appears to be running or False if not. It can take literally
SECONDS for Solaris to return the right status.
- isatty(self)
- This returns True if the file descriptor is open and connected to a
tty(-like) device, else False.
On SVR4-style platforms implementing streams, such as SunOS and HP-UX,
the child pty may not appear as a terminal device. This means
methods such as setecho(), setwinsize(), getwinsize() may raise an
IOError.
- kill(self, sig)
- This sends the given signal to the child application. In keeping
with UNIX tradition it has a misleading name. It does not necessarily
kill the child unless you send the right signal.
- read_nonblocking(self, size=1, timeout=-1)
- This reads at most size characters from the child application. It
includes a timeout. If the read does not complete within the timeout
period then a TIMEOUT exception is raised. If the end of file is read
then an EOF exception will be raised. If a logfile is specified, a
copy is written to that log.
If timeout is None then the read may block indefinitely.
If timeout is -1 then the self.timeout value is used. If timeout is 0
then the child is polled and if there is no data immediately ready
then this will raise a TIMEOUT exception.
The timeout refers only to the amount of time to read at least one
character. This is not affected by the 'size' parameter, so if you call
read_nonblocking(size=100, timeout=30) and only one character is
available right away then one character will be returned immediately.
It will not wait for 30 seconds for another 99 characters to come in.
This is a wrapper around os.read(). It uses select.select() to
implement the timeout.
- send(self, s)
- Sends string ``s`` to the child process, returning the number of
bytes written. If a logfile is specified, a copy is written to that
log.
The default terminal input mode is canonical processing unless set
otherwise by the child process. This allows backspace and other line
processing to be performed prior to transmitting to the receiving
program. As this is buffered, there is a limited size of such buffer.
On Linux systems, this is 4096 (defined by N_TTY_BUF_SIZE). All
other systems honor the POSIX.1 definition PC_MAX_CANON -- 1024
on OSX, 256 on OpenSolaris, and 1920 on FreeBSD.
This value may be discovered using fpathconf(3)::
>>> from os import fpathconf
>>> print(fpathconf(0, 'PC_MAX_CANON'))
256
On such a system, only 256 bytes may be received per line. Any
subsequent bytes received will be discarded. BEL (``''``) is then
sent to output if IMAXBEL (termios.h) is set by the tty driver.
This is usually enabled by default. Linux does not honor this as
an option -- it behaves as though it is always set on.
Canonical input processing may be disabled altogether by executing
a shell, then stty(1), before executing the final program::
>>> bash = pexpect.spawn('/bin/bash', echo=False)
>>> bash.sendline('stty -icanon')
>>> bash.sendline('base64')
>>> bash.sendline('x' * 5000)
- sendcontrol(self, char)
- Helper method that wraps send() with mnemonic access for sending control
character to the child (such as Ctrl-C or Ctrl-D). For example, to send
Ctrl-G (ASCII 7, bell, '')::
child.sendcontrol('g')
See also, sendintr() and sendeof().
- sendeof(self)
- This sends an EOF to the child. This sends a character which causes
the pending parent output buffer to be sent to the waiting child
program without waiting for end-of-line. If it is the first character
of the line, the read() in the user program returns 0, which signifies
end-of-file. This means to work as expected a sendeof() has to be
called at the beginning of a line. This method does not send a newline.
It is the responsibility of the caller to ensure the eof is sent at the
beginning of a line.
- sendintr(self)
- This sends a SIGINT to the child. It does not require
the SIGINT to be the first character on a line.
- sendline(self, s='')
- Wraps send(), sending string ``s`` to child process, with
``os.linesep`` automatically appended. Returns number of bytes
written. Only a limited number of bytes may be sent for each
line in the default terminal mode, see docstring of :meth:`send`.
- setecho(self, state)
- This sets the terminal echo mode on or off. Note that anything the
child sent before the echo will be lost, so you should be sure that
your input buffer is empty before you call setecho(). For example, the
following will work as expected::
p = pexpect.spawn('cat') # Echo is on by default.
p.sendline('1234') # We expect see this twice from the child...
p.expect(['1234']) # ... once from the tty echo...
p.expect(['1234']) # ... and again from cat itself.
p.setecho(False) # Turn off tty echo
p.sendline('abcd') # We will set this only once (echoed by cat).
p.sendline('wxyz') # We will set this only once (echoed by cat)
p.expect(['abcd'])
p.expect(['wxyz'])
The following WILL NOT WORK because the lines sent before the setecho
will be lost::
p = pexpect.spawn('cat')
p.sendline('1234')
p.setecho(False) # Turn off tty echo
p.sendline('abcd') # We will set this only once (echoed by cat).
p.sendline('wxyz') # We will set this only once (echoed by cat)
p.expect(['1234'])
p.expect(['1234'])
p.expect(['abcd'])
p.expect(['wxyz'])
Not supported on platforms where ``isatty()`` returns False.
- setwinsize(self, rows, cols)
- This sets the terminal window size of the child tty. This will cause
a SIGWINCH signal to be sent to the child. This does not change the
physical window size. It changes the size reported to TTY-aware
applications like vi or curses -- applications that respond to the
SIGWINCH signal.
- terminate(self, force=False)
- This forces a child process to terminate. It starts nicely with
SIGHUP and SIGINT. If "force" is True then moves onto SIGKILL. This
returns True if the child was terminated. This returns False if the
child could not be terminated.
- wait(self)
- This waits until the child exits. This is a blocking call. This will
not read any data from the child, so this will block forever if the
child has unread output and has terminated. In other words, the child
may have printed output then called exit(), but, the child is
technically still alive until its output is read by the parent.
This method is non-blocking if :meth:`wait` has already been called
previously or :meth:`isalive` method returns False. It simply returns
the previously determined exit status.
- waitnoecho(self, timeout=-1)
- This waits until the terminal ECHO flag is set False. This returns
True if the echo mode is off. This returns False if the ECHO flag was
not set False before the timeout. This can be used to detect when the
child is waiting for a password. Usually a child application will turn
off echo mode when it is waiting for the user to enter a password. For
example, instead of expecting the "password:" prompt you can wait for
the child to set ECHO off::
p = pexpect.spawn('ssh user@example.com')
p.waitnoecho()
p.sendline(mypassword)
If timeout==-1 then this method will use the value in self.timeout.
If timeout==None then this method to block until ECHO flag is False.
- write(self, s)
- This is similar to send() except that there is no return value.
- writelines(self, sequence)
- This calls write() for each element in the sequence. The sequence
can be any iterable object producing strings, typically a list of
strings. This does not add line separators. There is no return value.
Data descriptors inherited from pexpect.pty_spawn.spawn:
- flag_eof
Data and other attributes inherited from pexpect.pty_spawn.spawn:
- use_native_pty_fork = True
Methods inherited from pexpect.spawnbase.SpawnBase:
- __enter__(self)
- # For 'with spawn(...) as child:'
- __exit__(self, etype, evalue, tb)
- __iter__(self)
- This is to support iterators over a file-like object.
- compile_pattern_list(self, patterns)
- This compiles a pattern-string or a list of pattern-strings.
Patterns must be a StringType, EOF, TIMEOUT, SRE_Pattern, or a list of
those. Patterns may also be None which results in an empty list (you
might do this if waiting for an EOF or TIMEOUT condition without
expecting any pattern).
This is used by expect() when calling expect_list(). Thus expect() is
nothing more than::
cpl = self.compile_pattern_list(pl)
return self.expect_list(cpl, timeout)
If you are using expect() within a loop it may be more
efficient to compile the patterns first and then call expect_list().
This avoid calls in a loop to compile_pattern_list()::
cpl = self.compile_pattern_list(my_pattern)
while some_condition:
...
i = self.expect_list(cpl, timeout)
...
- expect(self, pattern, timeout=-1, searchwindowsize=-1, async=False)
- This seeks through the stream until a pattern is matched. The
pattern is overloaded and may take several types. The pattern can be a
StringType, EOF, a compiled re, or a list of any of those types.
Strings will be compiled to re types. This returns the index into the
pattern list. If the pattern was not a list this returns index 0 on a
successful match. This may raise exceptions for EOF or TIMEOUT. To
avoid the EOF or TIMEOUT exceptions add EOF or TIMEOUT to the pattern
list. That will cause expect to match an EOF or TIMEOUT condition
instead of raising an exception.
If you pass a list of patterns and more than one matches, the first
match in the stream is chosen. If more than one pattern matches at that
point, the leftmost in the pattern list is chosen. For example::
# the input is 'foobar'
index = p.expect(['bar', 'foo', 'foobar'])
# returns 1('foo') even though 'foobar' is a "better" match
Please note, however, that buffering can affect this behavior, since
input arrives in unpredictable chunks. For example::
# the input is 'foobar'
index = p.expect(['foobar', 'foo'])
# returns 0('foobar') if all input is available at once,
# but returs 1('foo') if parts of the final 'bar' arrive late
When a match is found for the given pattern, the class instance
attribute *match* becomes an re.MatchObject result. Should an EOF
or TIMEOUT pattern match, then the match attribute will be an instance
of that exception class. The pairing before and after class
instance attributes are views of the data preceding and following
the matching pattern. On general exception, class attribute
*before* is all data received up to the exception, while *match* and
*after* attributes are value None.
When the keyword argument timeout is -1 (default), then TIMEOUT will
raise after the default value specified by the class timeout
attribute. When None, TIMEOUT will not be raised and may block
indefinitely until match.
When the keyword argument searchwindowsize is -1 (default), then the
value specified by the class maxread attribute is used.
A list entry may be EOF or TIMEOUT instead of a string. This will
catch these exceptions and return the index of the list entry instead
of raising the exception. The attribute 'after' will be set to the
exception type. The attribute 'match' will be None. This allows you to
write code like this::
index = p.expect(['good', 'bad', pexpect.EOF, pexpect.TIMEOUT])
if index == 0:
do_something()
elif index == 1:
do_something_else()
elif index == 2:
do_some_other_thing()
elif index == 3:
do_something_completely_different()
instead of code like this::
try:
index = p.expect(['good', 'bad'])
if index == 0:
do_something()
elif index == 1:
do_something_else()
except EOF:
do_some_other_thing()
except TIMEOUT:
do_something_completely_different()
These two forms are equivalent. It all depends on what you want. You
can also just expect the EOF if you are waiting for all output of a
child to finish. For example::
p = pexpect.spawn('/bin/ls')
p.expect(pexpect.EOF)
print p.before
If you are trying to optimize for speed then see expect_list().
On Python 3.4, or Python 3.3 with asyncio installed, passing
``async=True`` will make this return an :mod:`asyncio` coroutine,
which you can yield from to get the same result that this method would
normally give directly. So, inside a coroutine, you can replace this code::
index = p.expect(patterns)
With this non-blocking form::
index = yield from p.expect(patterns, async=True)
- expect_exact(self, pattern_list, timeout=-1, searchwindowsize=-1, async=False)
- This is similar to expect(), but uses plain string matching instead
of compiled regular expressions in 'pattern_list'. The 'pattern_list'
may be a string; a list or other sequence of strings; or TIMEOUT and
EOF.
This call might be faster than expect() for two reasons: string
searching is faster than RE matching and it is possible to limit the
search to just the end of the input buffer.
This method is also useful when you don't want to have to worry about
escaping regular expression characters that you want to match.
Like :meth:`expect`, passing ``async=True`` will make this return an
asyncio coroutine.
- expect_list(self, pattern_list, timeout=-1, searchwindowsize=-1, async=False)
- This takes a list of compiled regular expressions and returns the
index into the pattern_list that matched the child output. The list may
also contain EOF or TIMEOUT(which are not compiled regular
expressions). This method is similar to the expect() method except that
expect_list() does not recompile the pattern list on every call. This
may help if you are trying to optimize for speed, otherwise just use
the expect() method. This is called by expect().
Like :meth:`expect`, passing ``async=True`` will make this return an
asyncio coroutine.
- expect_loop(self, searcher, timeout=-1, searchwindowsize=-1)
- This is the common loop used inside expect. The 'searcher' should be
an instance of searcher_re or searcher_string, which describes how and
what to search for in the input.
See expect() for other arguments, return value and exceptions.
- fileno(self)
- Expose file descriptor for a file-like interface
- flush(self)
- This does nothing. It is here to support the interface for a
File-like object.
- read(self, size=-1)
- This reads at most "size" bytes from the file (less if the read hits
EOF before obtaining size bytes). If the size argument is negative or
omitted, read all data until EOF is reached. The bytes are returned as
a string object. An empty string is returned when EOF is encountered
immediately.
- readline(self, size=-1)
- This reads and returns one entire line. The newline at the end of
line is returned as part of the string, unless the file ends without a
newline. An empty string is returned if EOF is encountered immediately.
This looks for a newline as a CR/LF pair (\r\n) even on UNIX because
this is what the pseudotty device returns. So contrary to what you may
expect you will receive newlines as \r\n.
If the size argument is 0 then an empty string is returned. In all
other cases the size argument is ignored, which is not standard
behavior for a file-like object.
- readlines(self, sizehint=-1)
- This reads until EOF using readline() and returns a list containing
the lines thus read. The optional 'sizehint' argument is ignored.
Remember, because this reads until EOF that means the child
process should have closed its stdout. If you run this method on
a child that is still running with its stdout open then this
method will block until it timesout.
Data descriptors inherited from pexpect.spawnbase.SpawnBase:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from pexpect.spawnbase.SpawnBase:
- encoding = None
- pid = None
| |