3
.] @ s d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlmZ d dl Z d dl
m Z ddl m
Z
mZmZ ddlmZ ddlmZmZmZ edd Zejd d
kZG d d d eZd
d ZdS ) N)contextmanager)use_native_pty_fork )ExceptionPexpectEOFTIMEOUT) SpawnBase)whichsplit_command_lineselect_ignore_interruptsc c s> y
dV W n. t jk
r8 } zt| j W Y dd} ~ X nX dS )z;Turn ptyprocess errors into our own ExceptionPexpect errorsN)
ptyprocessZPtyProcessErrorr args)e r /usr/lib/python3.6/pty_spawn.py_wrap_ptyprocess_err s
r c
s^ e Zd ZdZeZg ddddddddddddf
fdd Zd
d Zg ddfd d
Zdd ZdHddZ dd Z
dJddZ dd Z dd Z
dL fdd Zd d Zd d Zd!d" ZdMd$d%Zd&d' Zd(d) Zd*d+ Zd,d- Zed.d/ Zejd0d/ Zd1d2 ZdNd3d4Zd5d6 Z d7d8 Z d9d: Z d;d< Z d=d> Z e!d?ddfd@dAZ"dBdC Z#dDdE Z$dOdFdGZ% Z&S )PspawnzjThis is the main class interface for Pexpect. Use this class to start
and control child applications. i NFTstrictc s t t| j||||| |
d tj| _tj| _tj| _|| _|| _|
| _ | | _
t j j
jd| _|dkrzd| _d| _d| _n| j||| | dS )aO This is the constructor. The command parameter may be a string that
includes a command and any arguments to the command. For example::
child = pexpect.spawn('/usr/bin/ftp')
child = pexpect.spawn('/usr/bin/ssh user@example.com')
child = pexpect.spawn('ls -latr /tmp')
You may also construct it with a list of arguments like so::
child = pexpect.spawn('/usr/bin/ftp', [])
child = pexpect.spawn('/usr/bin/ssh', ['user@example.com'])
child = pexpect.spawn('ls', ['-latr', '/tmp'])
After this the child application will be created and will be ready to
talk to. For normal use, see expect() and send() and sendline().
Remember that Pexpect does NOT interpret shell meta characters such as
redirect, pipe, or wild cards (``>``, ``|``, or ``*``). This is a
common mistake. If you want to run a command and pipe it through
another command then you must also start a shell. For example::
child = pexpect.spawn('/bin/bash -c "ls -l | grep LOG > logs.txt"')
child.expect(pexpect.EOF)
The second form of spawn (where you pass a list of arguments) is useful
in situations where you wish to spawn a command and pass it its own
argument list. This can make syntax more clear. For example, the
following is equivalent to the previous example::
shell_cmd = 'ls -l | grep LOG > logs.txt'
child = pexpect.spawn('/bin/bash', ['-c', shell_cmd])
child.expect(pexpect.EOF)
The maxread attribute sets the read buffer size. This is maximum number
of bytes that Pexpect will try to read from a TTY at one time. Setting
the maxread size to 1 will turn off buffering. Setting the maxread
value higher may help performance in cases where large amounts of
output are read back from the child. This feature is useful in
conjunction with searchwindowsize.
When the keyword argument *searchwindowsize* is None (default), the
full buffer is searched at each iteration of receiving incoming data.
The default number of bytes scanned at each iteration is very large
and may be reduced to collaterally reduce search cost. After
:meth:`~.expect` returns, the full buffer attribute remains up to
size *maxread* irrespective of *searchwindowsize* value.
When the keyword argument ``timeout`` is specified as a number,
(default: *30*), then :class:`TIMEOUT` will be raised after the value
specified has elapsed, in seconds, for any of the :meth:`~.expect`
family of method calls. When None, TIMEOUT will not be raised, and
:meth:`~.expect` may block indefinitely until match.
The logfile member turns on or off logging. All input and output will
be copied to the given file object. Set logfile to None to stop
logging. This is the default. Set logfile to sys.stdout to echo
everything to standard output. The logfile is flushed after each write.
Example log input and output to a file::
child = pexpect.spawn('some_command')
fout = open('mylog.txt','wb')
child.logfile = fout
Example log to stdout::
# In Python 2:
child = pexpect.spawn('some_command')
child.logfile = sys.stdout
# In Python 3, we'll use the ``encoding`` argument to decode data
# from the subprocess and handle it as unicode:
child = pexpect.spawn('some_command', encoding='utf-8')
child.logfile = sys.stdout
The logfile_read and logfile_send members can be used to separately log
the input from the child and output sent to the child. Sometimes you
don't want to see everything you write to the child. You only want to
log what the child sends back. For example::
child = pexpect.spawn('some_command')
child.logfile_read = sys.stdout
You will need to pass an encoding to spawn in the above code if you are
using Python 3.
To separately log output sent to the child use logfile_send::
child.logfile_send = fout
If ``ignore_sighup`` is True, the child process will ignore SIGHUP
signals. The default is False from Pexpect 4.0, meaning that SIGHUP
will be handled normally by the child.
The delaybeforesend helps overcome a weird behavior that many users
were experiencing. The typical problem was that a user would expect() a
"Password:" prompt and then immediately call sendline() to send the
password. The user would then see that their password was echoed back
to them. Passwords don't normally echo. The problem is caused by the
fact that most applications print out the "Password" prompt and then
turn off stdin echo, but if you send your password before the
application turned off echo, then you get your password echoed.
Normally this wouldn't be a problem when interacting with a human at a
real keyboard. If you introduce a slight delay just before writing then
this seems to clear up the problem. This was such a common problem for
many users that I decided that the default pexpect behavior should be
to sleep just before writing to the child application. 1/20th of a
second (50 ms) seems to be enough to clear up the problem. You can set
delaybeforesend to None to return to the old behavior.
Note that spawn is clever about finding commands on your path.
It uses the same logic that "which" uses to find executables.
If you wish to get the exit status of the child you must call the
close() method. The exit or signal status of the child will be stored
in self.exitstatus or self.signalstatus. If the child exited normally
then exitstatus will store the exit return code and signalstatus will
be None. If the child was terminated abnormally with a signal then
signalstatus will store the signal value and exitstatus will be None::
child = pexpect.spawn('some_command')
child.close()
print(child.exitstatus, child.signalstatus)
If you need more detail you can also read the self.status member which
stores the status returned by os.waitpid. You can interpret this using
os.WIFEXITED/os.WEXITSTATUS or os.WIFSIGNALED/os.TERMSIG.
The echo attribute may be set to False to disable echoing of input.
As a pseudo-terminal, all input echoed by the "keyboard" (send()
or sendline()) will be repeated to output. For many cases, it is
not desirable to have echo enabled, and it may be later disabled
using setecho(False) followed by waitnoecho(). However, for some
platforms such as Solaris, this is not possible, and should be
disabled immediately on spawn.
If preexec_fn is given, it will be called in the child process before
launching the given command. This is useful to e.g. reset inherited
signal handlers.
The dimensions attribute specifies the size of the pseudo-terminal as
seen by the subprocess, and is specified as a two-entry tuple (rows,
columns). If this is unspecified, the defaults in ptyprocess will apply.
)timeoutmaxreadsearchwindowsizelogfileencoding codec_errorsirixNz )superr __init__pty STDIN_FILENO
STDOUT_FILENOZ
STDERR_FILENOcwdenvecho
ignore_sighupsysplatformlower
startswith_spawn__irix_hackcommandr
name_spawn)selfr+ r
r r r r r" r# r% r$
preexec_fnr r
dimensions) __class__r r r " s zspawn.__init__c C s g }|j t| |j dt| j |j d| jf |j d| jrR| jd d n| jf |j d| jrx| jd d n| jf |j d| jf |j d| jf |j d t| j |j d
t| j
t | d r|j d t| j |j d
t| j
|j dt| j |j dt| j |j dt| j |j dt| j |j dt| j |j dt| j |j dt| j |j dt| j |j dt| j |j dt| j |j dt| j |j dt| j |j dt| j dj|S ) zVThis returns a human-readable string that represents the state of
the object. z command: zargs: %rzbuffer (last 100 chars): %rd Nzbefore (last 100 chars): %rz after: %rz match: %rz
match_index: z exitstatus: ptyprocz
flag_eof: zpid: z
child_fd: zclosed: z timeout: z delimiter: z logfile: zlogfile_read: zlogfile_send: z maxread: z ignorecase: zsearchwindowsize: zdelaybeforesend: zdelayafterclose: zdelayafterterminate:
ii) appendreprstrr+ r
bufferZbeforeaftermatchZ match_index
exitstatushasattrflag_eofpidchild_fdclosedr Z delimiterr Z logfile_readZ logfile_sendr Z
ignorecaser delaybeforesendZdelayafterclosedelayafterterminatejoin)r. sr r r __str__ s:
z
spawn.__str__c s t |tdrtdt |tg s,td|g krLt|_jd _n"|dd _jjd| |_tjj d}|dkrtd d
j |_jjd< d d j
j d
_ j dkst
djdk st
dj d}jr fdd}||d< |dk r ||d< jdk r@fddjD _jjfj jd|_jj _ jj_d_d_dS ) a This starts the given command in a child process. This does all the
fork/exec type of stuff for a pty. This is called by __init__. If args
is empty then command will be parsed (split on spaces) and args will be
set to parsed arguments. r zCommand is an int type. z4If this is a file descriptor then maybe you want to z.use fdpexpect.fdspawn which takes an existing z,file descriptor instead of a command string.z#The argument, args, must be a list.N)r# z%The command was not found or was not zexecutable: %s.< >z The pid member must be None.z$The command member must not be None.)r$ r/ c s" t j t jt j dk r dS )z7Set SIGHUP to be ignored, then call the real preexec_fnN)signalSIGHUPSIG_IGNr )r/ r r preexec_wrapper s z%spawn._spawn..preexec_wrapperr/ r0 c s& g | ] }t |tr|n
|j jqS r )
isinstancebytesencoder ).0a)r. r r
& s z spawn._spawn..)r# r" FzLCommand is an int type. If this is a file descriptor then maybe you want to zzCommand is an int type. If this is a file descriptor then maybe you want to use fdpexpect.fdspawn which takes an existing zCommand is an int type. If this is a file descriptor then maybe you want to use fdpexpect.fdspawn which takes an existing file descriptor instead of a command string.)rM typer TypeErrorr
r
r+ insertr r# rC r, r> AssertionErrorr$ r% r _spawnptyr" r3 fdr?
terminatedr@ )r. r+ r
r/ r0 Zcommand_with_pathkwargsrL r )r/ r. r r- sH
z spawn._spawnc K s t jj|f|S )z1Spawn a pty and return an instance of PtyProcess.)r Z
PtyProcessr )r. r
rZ r r r rW 3 s zspawn._spawnptyc
C s: | j t | jj|d W dQ R X | j d| _dS )a? 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). )forceNr )flushr r3 closeisaliver? )r. r[ r r r r^ 7 s
z spawn.closec C s t j| jS )a^ 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. )osisattyr? )r. r r r ra F s z spawn.isattyr c C sj |dkr| j }|dk r"tj | }xB| j s0dS |dk rD|dk rDdS |dk rX|tj }tjd q$W dS )a 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.
r NTr Fg?r\ )r timegetechosleep)r. r Zend_timer r r
waitnoechoQ s zspawn.waitnoechoc C s
| j j S )a 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. )r3 rc )r. r r r rc o s z
spawn.getechoc C s | j j|S )aZ 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.
)r3 setecho)r. stater r r rf w s z
spawn.setechoc s | j rtd|d kr | j}| j sPt| jgg g d\}}}|sd| _tdn<| jrt| jgg g d\}}}| r| j rd| _tdt| jgg g |\}}}|s| j sd| _tdnt d | j|krt
t | j |S t
d
d S )
aC 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. z I/O operation on closed file.r r Tz&End Of File (EOF). Braindead platform. z!End Of File (EOF). Slow platform.z&End of File (EOF). Very slow platform.zTimeout exceeded.z Reached an unexpected state.Nr\ )r@
ValueErrorr r_ r r? r= r r* r r r read_nonblockingr )r. sizer rwr )r1 r r rj s.
zspawn.read_nonblockingc C s | j | dS )zHThis is similar to send() except that there is no return value.
N)send)r. rD r r r write s z spawn.writec C s x|D ]}| j | qW dS )zThis 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.
N)ro )r. ZsequencerD r r r
writelines s
zspawn.writelinesc C sJ | j dk rtj| j | j|}| j|d | jj|dd}tj| j |S )a 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)
Nrn F)final)
rA rb rd _coerce_send_string_logZ_encoderrO r` ro r? )r. rD br r r rn s #
z
spawn.send c C s | j |}| j|| j S )a 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`.
)rr rn linesep)r. rD r r r sendline s
zspawn.sendlinec C s( | j dk r|j| j d}| j|d dS )z5Write control characters to the appropriate log filesNreplacern )r decoders )r. rD r r r _log_control s
zspawn._log_controlc C s | j j|\}}| j| |S )a 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().
)r3 sendcontrolrz )r. charnbyter r r r{ # s
zspawn.sendcontrolc C s | j j \}}| j| dS )a1 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. N)r3 sendeofrz )r. r} r~ r r r r 0 s
z
spawn.sendeofc C s | j j \}}| j| dS )znThis sends a SIGINT to the child. It does not require
the SIGINT to be the first character on a line. N)r3 sendintrrz )r. r} r~ r r r r = s zspawn.sendintrc C s | j jS )N)r3 r= )r. r r r r= D s zspawn.flag_eofc C s || j _d S )N)r3 r= )r. valuer r r r= H s c C s | j S )z@This returns True if the EOF exception was ever raised.
)r= )r. r r r eofL s z spawn.eofc C s | j s dS y| jtj tj| j | j s2dS | jtj tj| j | j sVdS | jtj tj| j | j szdS |r| jtj tj| j | j sdS dS dS t
k
r tj| j | j sdS dS Y nX dS )zThis 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. TFN) r_ killrI rJ rb rd rB SIGCONTSIGINTSIGKILLOSError)r. r[ r r r terminateQ s6 zspawn.terminatec C sB | j }t |j }W dQ R X |j| _|j| _|j| _d| _|S )a@ 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.
NT)r3 r waitstatusr; signalstatusrY )r. r3 r; r r r r y s z
spawn.waitc C sF | j }t |j }W dQ R X |sB|j| _|j| _|j| _d| _|S )aZ 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. NT)r3 r r_ r r; r rY )r. r3 aliver r r r_ s z
spawn.isalivec C s | j rtj| j| dS )zThis 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. N)r_ r` r r> )r. Zsigr r r r s z
spawn.killc C s
| j j S )zmThis returns the terminal window size of the child tty. The return
value is a tuple of (rows, cols). )r3
getwinsize)r. r r r r s zspawn.getwinsizec C s | j j||S )a= 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. )r3
setwinsize)r. ZrowsZcolsr r r r s zspawn.setwinsize c
C sz | j | j | jj | j | _tj| j}tj| j |dk rNt rN|j
d}z| j ||| W dtj | jtj
| X dS )a 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()
Nzlatin-1)Zwrite_to_stdoutr8 stdoutr] Z string_typettyZ tcgetattrr ZsetrawPY3rO _spawn__interact_copyZ tcsetattrZ TCSAFLUSH)r. escape_character input_filter
output_filtermoder r r interact s )
zspawn.interactc C s2 x,|dkr,| j r,tj||}||d }qW dS )z/This is used by the interact() method.
N)r_ r` ro )r. rX datar} r r r Z__interact_writen s zspawn.__interact_writenc C s t j|dS )z/This is used by the interact() method.
i )r` read)r. rX r r r Z__interact_read s zspawn.__interact_readc
C s< x4| j r6t| j| jgg g \}}}| j|kry| j| j}W n6 tk
rx } z|jd tjkrfP W Y dd}~X nX |dkrP |r||}| j |d t
j | j | | j|kr| j| j}|r||}d} |dk r|j
|} | dkr|d| }|r
| j |d | j| j| P | j |d | j| j| qW dS ) z/This is used by the interact() method.
r Nr r r rn r\ r\ )r_ r r? r _spawn__interact_readr r
errnoZEIOrs r` ro r! rfind_spawn__interact_writen)
r. r r r rl rm r r errir r r Z__interact_copy s<
zspawn.__interact_copy)Tr\ )r\ r\ )r r\ )ru )F)NNN)'__name__
__module__ __qualname____doc__r r rE r- rW r^ ra re rc rf rj ro rp rn rw rz r{ r r propertyr= setterr r r r_ r r r chrr r r r
__classcell__r r )r1 r r sN $"I
"@ ,
(
4 r c O s |j dd t| |S )z-Deprecated: pass encoding to spawn() instead.r zutf-8)
setdefaultr )r
rZ r r r spawnu' s r )r` r& rb r r r rI
contextlibr r Zptyprocess.ptyprocessr
exceptionsr r r Z spawnbaser Zutilsr r
r r version_infor r r r r r r s,