pexpect-3.1/0000755000175400017540000000000012270016336015133 5ustar takluyvertakluyver00000000000000pexpect-3.1/ANSI.py0000644000175400017540000000027712216707544016255 0ustar takluyvertakluyver00000000000000import warnings warnings.warn("This module has been moved to pexpect.ANSI, please update imports.", ImportWarning) del warnings from pexpect.ANSI import * # analysis:ignorepexpect-3.1/setup.py0000644000175400017540000000277712240222422016652 0ustar takluyvertakluyver00000000000000from distutils.core import setup from pexpect import __version__ setup (name='pexpect', version=__version__, py_modules=['pxssh', 'fdpexpect', 'FSM', 'screen', 'ANSI'], packages=['pexpect'], description='Pexpect allows easy control of interactive console applications.', author='Noah Spurrier; Thomas Kluyver; Jeff Quast', author_email='noah@noah.org; thomas@kluyver.me.uk; contact@jeffquast.com', url='http://pexpect.readthedocs.org/', license='ISC license', platforms='UNIX', classifiers = [ 'Development Status :: 5 - Production/Stable', 'Environment :: Console', 'Intended Audience :: Developers', 'Intended Audience :: System Administrators', 'License :: OSI Approved :: ISC License (ISCL)', 'Operating System :: POSIX', 'Operating System :: MacOS :: MacOS X', 'Programming Language :: Python', 'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Topic :: Software Development', 'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: Software Development :: Quality Assurance', 'Topic :: Software Development :: Testing', 'Topic :: System', 'Topic :: System :: Archiving :: Packaging', 'Topic :: System :: Installation/Setup', 'Topic :: System :: Shells', 'Topic :: System :: Software Distribution', 'Topic :: Terminals', ], ) pexpect-3.1/pexpect/0000755000175400017540000000000012270016336016603 5ustar takluyvertakluyver00000000000000pexpect-3.1/pexpect/ANSI.py0000644000175400017540000002605312220666300017712 0ustar takluyvertakluyver00000000000000'''This implements an ANSI (VT100) terminal emulator as a subclass of screen. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' # references: # http://en.wikipedia.org/wiki/ANSI_escape_code # http://www.retards.org/terminals/vt102.html # http://vt100.net/docs/vt102-ug/contents.html # http://vt100.net/docs/vt220-rm/ # http://www.termsys.demon.co.uk/vtansi.htm from . import screen from . import FSM import string # # The 'Do.*' functions are helper functions for the ANSI class. # def DoEmit (fsm): screen = fsm.memory[0] screen.write_ch(fsm.input_symbol) def DoStartNumber (fsm): fsm.memory.append (fsm.input_symbol) def DoBuildNumber (fsm): ns = fsm.memory.pop() ns = ns + fsm.input_symbol fsm.memory.append (ns) def DoBackOne (fsm): screen = fsm.memory[0] screen.cursor_back () def DoBack (fsm): count = int(fsm.memory.pop()) screen = fsm.memory[0] screen.cursor_back (count) def DoDownOne (fsm): screen = fsm.memory[0] screen.cursor_down () def DoDown (fsm): count = int(fsm.memory.pop()) screen = fsm.memory[0] screen.cursor_down (count) def DoForwardOne (fsm): screen = fsm.memory[0] screen.cursor_forward () def DoForward (fsm): count = int(fsm.memory.pop()) screen = fsm.memory[0] screen.cursor_forward (count) def DoUpReverse (fsm): screen = fsm.memory[0] screen.cursor_up_reverse() def DoUpOne (fsm): screen = fsm.memory[0] screen.cursor_up () def DoUp (fsm): count = int(fsm.memory.pop()) screen = fsm.memory[0] screen.cursor_up (count) def DoHome (fsm): c = int(fsm.memory.pop()) r = int(fsm.memory.pop()) screen = fsm.memory[0] screen.cursor_home (r,c) def DoHomeOrigin (fsm): c = 1 r = 1 screen = fsm.memory[0] screen.cursor_home (r,c) def DoEraseDown (fsm): screen = fsm.memory[0] screen.erase_down() def DoErase (fsm): arg = int(fsm.memory.pop()) screen = fsm.memory[0] if arg == 0: screen.erase_down() elif arg == 1: screen.erase_up() elif arg == 2: screen.erase_screen() def DoEraseEndOfLine (fsm): screen = fsm.memory[0] screen.erase_end_of_line() def DoEraseLine (fsm): arg = int(fsm.memory.pop()) screen = fsm.memory[0] if arg == 0: screen.erase_end_of_line() elif arg == 1: screen.erase_start_of_line() elif arg == 2: screen.erase_line() def DoEnableScroll (fsm): screen = fsm.memory[0] screen.scroll_screen() def DoCursorSave (fsm): screen = fsm.memory[0] screen.cursor_save_attrs() def DoCursorRestore (fsm): screen = fsm.memory[0] screen.cursor_restore_attrs() def DoScrollRegion (fsm): screen = fsm.memory[0] r2 = int(fsm.memory.pop()) r1 = int(fsm.memory.pop()) screen.scroll_screen_rows (r1,r2) def DoMode (fsm): screen = fsm.memory[0] mode = fsm.memory.pop() # Should be 4 # screen.setReplaceMode () def DoLog (fsm): screen = fsm.memory[0] fsm.memory = [screen] fout = open ('log', 'a') fout.write (fsm.input_symbol + ',' + fsm.current_state + '\n') fout.close() class term (screen.screen): '''This class is an abstract, generic terminal. This does nothing. This is a placeholder that provides a common base class for other terminals such as an ANSI terminal. ''' def __init__ (self, r=24, c=80): screen.screen.__init__(self, r,c) class ANSI (term): '''This class implements an ANSI (VT100) terminal. It is a stream filter that recognizes ANSI terminal escape sequences and maintains the state of a screen object. ''' def __init__ (self, r=24,c=80): term.__init__(self,r,c) #self.screen = screen (24,80) self.state = FSM.FSM ('INIT',[self]) self.state.set_default_transition (DoLog, 'INIT') self.state.add_transition_any ('INIT', DoEmit, 'INIT') self.state.add_transition ('\x1b', 'INIT', None, 'ESC') self.state.add_transition_any ('ESC', DoLog, 'INIT') self.state.add_transition ('(', 'ESC', None, 'G0SCS') self.state.add_transition (')', 'ESC', None, 'G1SCS') self.state.add_transition_list ('AB012', 'G0SCS', None, 'INIT') self.state.add_transition_list ('AB012', 'G1SCS', None, 'INIT') self.state.add_transition ('7', 'ESC', DoCursorSave, 'INIT') self.state.add_transition ('8', 'ESC', DoCursorRestore, 'INIT') self.state.add_transition ('M', 'ESC', DoUpReverse, 'INIT') self.state.add_transition ('>', 'ESC', DoUpReverse, 'INIT') self.state.add_transition ('<', 'ESC', DoUpReverse, 'INIT') self.state.add_transition ('=', 'ESC', None, 'INIT') # Selects application keypad. self.state.add_transition ('#', 'ESC', None, 'GRAPHICS_POUND') self.state.add_transition_any ('GRAPHICS_POUND', None, 'INIT') self.state.add_transition ('[', 'ESC', None, 'ELB') # ELB means Escape Left Bracket. That is ^[[ self.state.add_transition ('H', 'ELB', DoHomeOrigin, 'INIT') self.state.add_transition ('D', 'ELB', DoBackOne, 'INIT') self.state.add_transition ('B', 'ELB', DoDownOne, 'INIT') self.state.add_transition ('C', 'ELB', DoForwardOne, 'INIT') self.state.add_transition ('A', 'ELB', DoUpOne, 'INIT') self.state.add_transition ('J', 'ELB', DoEraseDown, 'INIT') self.state.add_transition ('K', 'ELB', DoEraseEndOfLine, 'INIT') self.state.add_transition ('r', 'ELB', DoEnableScroll, 'INIT') self.state.add_transition ('m', 'ELB', None, 'INIT') self.state.add_transition ('?', 'ELB', None, 'MODECRAP') self.state.add_transition_list (string.digits, 'ELB', DoStartNumber, 'NUMBER_1') self.state.add_transition_list (string.digits, 'NUMBER_1', DoBuildNumber, 'NUMBER_1') self.state.add_transition ('D', 'NUMBER_1', DoBack, 'INIT') self.state.add_transition ('B', 'NUMBER_1', DoDown, 'INIT') self.state.add_transition ('C', 'NUMBER_1', DoForward, 'INIT') self.state.add_transition ('A', 'NUMBER_1', DoUp, 'INIT') self.state.add_transition ('J', 'NUMBER_1', DoErase, 'INIT') self.state.add_transition ('K', 'NUMBER_1', DoEraseLine, 'INIT') self.state.add_transition ('l', 'NUMBER_1', DoMode, 'INIT') ### It gets worse... the 'm' code can have infinite number of ### number;number;number before it. I've never seen more than two, ### but the specs say it's allowed. crap! self.state.add_transition ('m', 'NUMBER_1', None, 'INIT') ### LED control. Same implementation problem as 'm' code. self.state.add_transition ('q', 'NUMBER_1', None, 'INIT') # \E[?47h switch to alternate screen # \E[?47l restores to normal screen from alternate screen. self.state.add_transition_list (string.digits, 'MODECRAP', DoStartNumber, 'MODECRAP_NUM') self.state.add_transition_list (string.digits, 'MODECRAP_NUM', DoBuildNumber, 'MODECRAP_NUM') self.state.add_transition ('l', 'MODECRAP_NUM', None, 'INIT') self.state.add_transition ('h', 'MODECRAP_NUM', None, 'INIT') #RM Reset Mode Esc [ Ps l none self.state.add_transition (';', 'NUMBER_1', None, 'SEMICOLON') self.state.add_transition_any ('SEMICOLON', DoLog, 'INIT') self.state.add_transition_list (string.digits, 'SEMICOLON', DoStartNumber, 'NUMBER_2') self.state.add_transition_list (string.digits, 'NUMBER_2', DoBuildNumber, 'NUMBER_2') self.state.add_transition_any ('NUMBER_2', DoLog, 'INIT') self.state.add_transition ('H', 'NUMBER_2', DoHome, 'INIT') self.state.add_transition ('f', 'NUMBER_2', DoHome, 'INIT') self.state.add_transition ('r', 'NUMBER_2', DoScrollRegion, 'INIT') ### It gets worse... the 'm' code can have infinite number of ### number;number;number before it. I've never seen more than two, ### but the specs say it's allowed. crap! self.state.add_transition ('m', 'NUMBER_2', None, 'INIT') ### LED control. Same problem as 'm' code. self.state.add_transition ('q', 'NUMBER_2', None, 'INIT') self.state.add_transition (';', 'NUMBER_2', None, 'SEMICOLON_X') # Create a state for 'q' and 'm' which allows an infinite number of ignored numbers self.state.add_transition_any ('SEMICOLON_X', DoLog, 'INIT') self.state.add_transition_list (string.digits, 'SEMICOLON_X', None, 'NUMBER_X') self.state.add_transition_any ('NUMBER_X', DoLog, 'INIT') self.state.add_transition ('m', 'NUMBER_X', None, 'INIT') self.state.add_transition ('q', 'NUMBER_X', None, 'INIT') self.state.add_transition (';', 'NUMBER_2', None, 'SEMICOLON_X') def process (self, c): """Process a single byte. Called by :meth:`write`.""" self.state.process(c) def process_list (self, l): self.write(l) def write (self, s): """Process text, writing it to the virtual screen while handling ANSI escape codes. """ for c in s: self.process(c) def flush (self): pass def write_ch (self, ch): '''This puts a character at the current cursor position. The cursor position is moved forward with wrap-around, but no scrolling is done if the cursor hits the lower-right corner of the screen. ''' #\r and \n both produce a call to cr() and lf(), respectively. ch = ch[0] if ch == '\r': self.cr() return if ch == '\n': self.crlf() return if ch == chr(screen.BS): self.cursor_back() return if ch not in string.printable: fout = open ('log', 'a') fout.write ('Nonprint: ' + str(ord(ch)) + '\n') fout.close() return self.put_abs(self.cur_r, self.cur_c, ch) old_r = self.cur_r old_c = self.cur_c self.cursor_forward() if old_c == self.cur_c: self.cursor_down() if old_r != self.cur_r: self.cursor_home (self.cur_r, 1) else: self.scroll_up () self.cursor_home (self.cur_r, 1) self.erase_line() pexpect-3.1/pexpect/psh.py0000644000175400017540000001121112233531217017742 0ustar takluyvertakluyver00000000000000'''This is a utility class to make shell scripting easier in Python. It combines Pexpect and wraps many Standard Python Library functions to make them look more shell-like. This module is undocumented, so its API is provisional, and may change in future releases without a deprecation cycle. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect, re class ExceptionPsh(pexpect.ExceptionPexpect): '''Raised for Psh exceptions. ''' class ExceptionErrorCode(ExceptionPsh): '''Raised when an program returns an error code. ''' def __init__(self, string, err_code, cmd_output): ExceptionPsh.__init__(self,string) self.error = err_code self.output = cmd_output class psh (object): def __init__ (self,exp): self.exp = exp self.default_timeout = 30 # Seconds def ls (self, path=''): fileStr = self.run("ls %s" % path) return fileStr.split() def cd (self, path='-'): return self.run("cd %s" % path) def rm (self, path=''): return self.run("/bin/rm -f %s" % path) def cp (self, path_from='', path_to=''): return self.run("/bin/cp %s %s" % (path_from, path_to)) def mv (self, path_from='', path_to=''): return self.run("/bin/mv %s %s" % (path_from, path_to)) def pwd (self): return self.run("/bin/pwd") def which (self, exe_name): return self.run("/usr/bin/which %s" % exe_name) def chown (self, path, user='', group=None, recurse=False): xtra_flags = "" if recurse: xtra_flags = "-R" if group: group = ':' + group else: group = "" return self.run("/bin/chown %s %s%s %s" % (xtra_flags,user,group,path)) def chmod (self, path, perms='', recurse=False): xtra_flags = "" if recurse: xtra_flags = "-R" return self.run("/usr/bin/chmod %s %s %s" % (xtra_flags, perms, path)) def chattr (self, path, attrs='', recurse=False): xtra_flags = "" if recurse: xtra_flags = "-R" return self.run("/usr/bin/chattr %s %s %s" % (xtra_flags, attrs, path)) def cat (self, path): return self.run("/bin/cat %s" % path) def run (self, cmd, timeout=None): (ret, output) = self.run_raw(cmd, timeout) if ret == 0: return output raise ExceptionErrorCode("Running command [%s] returned error [%d]" % (cmd,ret), ret, output) def run_raw(self, cmd, timeout=None): '''Someone contributed this, but now I've lost touch and I forget the motive of this. It was sort of a sketch at the time which doesn't make this any easier to prioritize, but it seemed important at the time. ''' if not timeout: timeout = self.default_timeout self.exp.sendline("") if not self.exp.prompt(): raise ExceptionPsh("No prompt") self.exp.sendline(cmd) self.exp.expect_exact([cmd]) self.exp.prompt(timeout=timeout) output = self.exp.before # Get the return code self.exp.sendline("echo $?") self.exp.expect_exact(["echo $?"]) if not self.exp.prompt(): raise ExceptionPsh("No prompt", 0, self.exp.before) try: reg = re.compile(b"^(\d+)") s = self.exp.before.strip() #print s #pdb.set_trace() s = reg.search(s).groups()[0] error_code = int(s) except ValueError: #log.error("Cannot parse %s into an int!" % self.exp.before) raise if not output[0:2] == '\r\n': #log.warning("Returned output lacks leading \\r\\n which may indicate a tae error") #log.debug2("Offending output string: [%s]" % output) return (error_code, output) else: return(error_code, output[2:]) pexpect-3.1/pexpect/fdpexpect.py0000644000175400017540000000704012220666300021135 0ustar takluyvertakluyver00000000000000'''This is like pexpect, but it will work with any file descriptor that you pass it. You are reponsible for opening and close the file descriptor. This allows you to use Pexpect with sockets and named pipes (FIFOs). PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from pexpect import spawn, ExceptionPexpect import os __all__ = ['fdspawn'] class fdspawn (spawn): '''This is like pexpect.spawn but allows you to supply your own open file descriptor. For example, you could use it to read through a file looking for patterns, or to control a modem or serial device. ''' def __init__ (self, fd, args=[], timeout=30, maxread=2000, searchwindowsize=None, logfile=None): '''This takes a file descriptor (an int) or an object that support the fileno() method (returning an int). All Python file-like objects support fileno(). ''' ### TODO: Add better handling of trying to use fdspawn in place of spawn ### TODO: (overload to allow fdspawn to also handle commands as spawn does. if type(fd) != type(0) and hasattr(fd, 'fileno'): fd = fd.fileno() if type(fd) != type(0): raise ExceptionPexpect('The fd argument is not an int. If this is a command string then maybe you want to use pexpect.spawn.') try: # make sure fd is a valid file descriptor os.fstat(fd) except OSError: raise ExceptionPexpect('The fd argument is not a valid file descriptor.') self.args = None self.command = None spawn.__init__(self, None, args, timeout, maxread, searchwindowsize, logfile) self.child_fd = fd self.own_fd = False self.closed = False self.name = '' % fd def __del__ (self): return def close (self): """Close the file descriptor. Calling this method a second time does nothing, but if the file descriptor was closed elsewhere, :class:`OSError` will be raised. """ if self.child_fd == -1: return self.flush() os.close(self.child_fd) self.child_fd = -1 self.closed = True def isalive (self): '''This checks if the file descriptor is still valid. If :func:`os.fstat` does not raise an exception then we assume it is alive. ''' if self.child_fd == -1: return False try: os.fstat(self.child_fd) return True except: return False def terminate (self, force=False): raise ExceptionPexpect('This method is not valid for file descriptors.') def kill (self, sig): """No-op - no process to kill.""" return pexpect-3.1/pexpect/__init__.py0000644000175400017540000024211012270005152020706 0ustar takluyvertakluyver00000000000000'''Pexpect is a Python module for spawning child applications and controlling them automatically. Pexpect can be used for automating interactive applications such as ssh, ftp, passwd, telnet, etc. It can be used to a automate setup scripts for duplicating software package installations on different servers. It can be used for automated software testing. Pexpect is in the spirit of Don Libes' Expect, but Pexpect is pure Python. Other Expect-like modules for Python require TCL and Expect or require C extensions to be compiled. Pexpect does not use C, Expect, or TCL extensions. It should work on any platform that supports the standard Python pty module. The Pexpect interface focuses on ease of use so that simple tasks are easy. There are two main interfaces to the Pexpect system; these are the function, run() and the class, spawn. The spawn class is more powerful. The run() function is simpler than spawn, and is good for quickly calling program. When you call the run() function it executes a given program and then returns the output. This is a handy replacement for os.system(). For example:: pexpect.run('ls -la') The spawn class is the more powerful interface to the Pexpect system. You can use this to spawn a child program then interact with it by sending input and expecting responses (waiting for patterns in the child's output). For example:: child = pexpect.spawn('scp foo user@example.com:.') child.expect('Password:') child.sendline(mypassword) This works even for commands that ask for passwords or other input outside of the normal stdio streams. For example, ssh reads input directly from the TTY device which bypasses stdin. Credits: Noah Spurrier, Richard Holden, Marco Molteni, Kimberley Burchett, Robert Stone, Hartmut Goebel, Chad Schroeder, Erick Tryzelaar, Dave Kirby, Ids vander Molen, George Todd, Noel Taylor, Nicolas D. Cesar, Alexander Gattin, Jacques-Etienne Baudoux, Geoffrey Marshall, Francisco Lourenco, Glen Mabey, Karthik Gurusamy, Fernando Perez, Corey Minyard, Jon Cohen, Guillaume Chazarain, Andrew Ryan, Nick Craig-Wood, Andrew Stone, Jorgen Grahn, John Spiegel, Jan Grant, and Shane Kerr. Let me know if I forgot anyone. Pexpect is free, open source, and all that good stuff. http://pexpect.sourceforge.net/ PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' try: import os import sys import time import select import re import struct import resource import types import pty import tty import termios import fcntl import errno import traceback import signal import codecs except ImportError: # pragma: no cover err = sys.exc_info()[1] raise ImportError(str(err) + ''' A critical module was not found. Probably this operating system does not support it. Pexpect is intended for UNIX-like operating systems.''') __version__ = '3.1' __revision__ = '' __all__ = ['ExceptionPexpect', 'EOF', 'TIMEOUT', 'spawn', 'spawnu', 'run', 'runu', 'which', 'split_command_line', '__version__', '__revision__'] PY3 = (sys.version_info[0] >= 3) # Exception classes used by this module. class ExceptionPexpect(Exception): '''Base class for all exceptions raised by this module. ''' def __init__(self, value): super(ExceptionPexpect, self).__init__(value) self.value = value def __str__(self): return str(self.value) def get_trace(self): '''This returns an abbreviated stack trace with lines that only concern the caller. In other words, the stack trace inside the Pexpect module is not included. ''' tblist = traceback.extract_tb(sys.exc_info()[2]) tblist = [item for item in tblist if 'pexpect/__init__' not in item[0]] tblist = traceback.format_list(tblist) return ''.join(tblist) class EOF(ExceptionPexpect): '''Raised when EOF is read from a child. This usually means the child has exited.''' class TIMEOUT(ExceptionPexpect): '''Raised when a read time exceeds the timeout. ''' ##class TIMEOUT_PATTERN(TIMEOUT): ## '''Raised when the pattern match time exceeds the timeout. ## This is different than a read TIMEOUT because the child process may ## give output, thus never give a TIMEOUT, but the output ## may never match a pattern. ## ''' ##class MAXBUFFER(ExceptionPexpect): ## '''Raised when a buffer fills before matching an expected pattern.''' def run(command, timeout=-1, withexitstatus=False, events=None, extra_args=None, logfile=None, cwd=None, env=None): ''' This function runs the given command; waits for it to finish; then returns all output as a string. STDERR is included in output. If the full path to the command is not given then the path is searched. Note that lines are terminated by CR/LF (\\r\\n) combination even on UNIX-like systems because this is the standard for pseudottys. If you set 'withexitstatus' to true, then run will return a tuple of (command_output, exitstatus). If 'withexitstatus' is false then this returns just command_output. The run() function can often be used instead of creating a spawn instance. For example, the following code uses spawn:: from pexpect import * child = spawn('scp foo user@example.com:.') child.expect('(?i)password') child.sendline(mypassword) The previous code can be replace with the following:: from pexpect import * run('scp foo user@example.com:.', events={'(?i)password': mypassword}) **Examples** Start the apache daemon on the local machine:: from pexpect import * run("/usr/local/apache/bin/apachectl start") Check in a file using SVN:: from pexpect import * run("svn ci -m 'automatic commit' my_file.py") Run a command and capture exit status:: from pexpect import * (command_output, exitstatus) = run('ls -l /bin', withexitstatus=1) The following will run SSH and execute 'ls -l' on the remote machine. The password 'secret' will be sent if the '(?i)password' pattern is ever seen:: run("ssh username@machine.example.com 'ls -l'", events={'(?i)password':'secret\\n'}) This will start mencoder to rip a video from DVD. This will also display progress ticks every 5 seconds as it runs. For example:: from pexpect import * def print_ticks(d): print d['event_count'], run("mencoder dvd://1 -o video.avi -oac copy -ovc copy", events={TIMEOUT:print_ticks}, timeout=5) The 'events' argument should be a dictionary of patterns and responses. Whenever one of the patterns is seen in the command out run() will send the associated response string. Note that you should put newlines in your string if Enter is necessary. The responses may also contain callback functions. Any callback is function that takes a dictionary as an argument. The dictionary contains all the locals from the run() function, so you can access the child spawn object or any other variable defined in run() (event_count, child, and extra_args are the most useful). A callback may return True to stop the current run process otherwise run() continues until the next event. A callback may also return a string which will be sent to the child. 'extra_args' is not used by directly run(). It provides a way to pass data to a callback function through run() through the locals dictionary passed to a callback. ''' return _run(command, timeout=timeout, withexitstatus=withexitstatus, events=events, extra_args=extra_args, logfile=logfile, cwd=cwd, env=env, _spawn=spawn) def runu(command, timeout=-1, withexitstatus=False, events=None, extra_args=None, logfile=None, cwd=None, env=None, **kwargs): """This offers the same interface as :func:`run`, but using unicode. Like :class:`spawnu`, you can pass ``encoding`` and ``errors`` parameters, which will be used for both input and output. """ return _run(command, timeout=timeout, withexitstatus=withexitstatus, events=events, extra_args=extra_args, logfile=logfile, cwd=cwd, env=env, _spawn=spawnu, **kwargs) def _run(command, timeout, withexitstatus, events, extra_args, logfile, cwd, env, _spawn, **kwargs): if timeout == -1: child = _spawn(command, maxread=2000, logfile=logfile, cwd=cwd, env=env, **kwargs) else: child = _spawn(command, timeout=timeout, maxread=2000, logfile=logfile, cwd=cwd, env=env, **kwargs) if events is not None: patterns = list(events.keys()) responses = list(events.values()) else: # This assumes EOF or TIMEOUT will eventually cause run to terminate. patterns = None responses = None child_result_list = [] event_count = 0 while True: try: index = child.expect(patterns) if isinstance(child.after, child.allowed_string_types): child_result_list.append(child.before + child.after) else: # child.after may have been a TIMEOUT or EOF, # which we don't want appended to the list. child_result_list.append(child.before) if isinstance(responses[index], child.allowed_string_types): child.send(responses[index]) elif isinstance(responses[index], types.FunctionType): callback_result = responses[index](locals()) sys.stdout.flush() if isinstance(callback_result, child.allowed_string_types): child.send(callback_result) elif callback_result: break else: raise TypeError('The callback must be a string or function.') event_count = event_count + 1 except TIMEOUT: child_result_list.append(child.before) break except EOF: child_result_list.append(child.before) break child_result = child.string_type().join(child_result_list) if withexitstatus: child.close() return (child_result, child.exitstatus) else: return child_result class spawn(object): '''This is the main class interface for Pexpect. Use this class to start and control child applications. ''' string_type = bytes if PY3: allowed_string_types = (bytes, str) @staticmethod def _chr(c): return bytes([c]) linesep = os.linesep.encode('ascii') @staticmethod def write_to_stdout(b): try: return sys.stdout.buffer.write(b) except AttributeError: # If stdout has been replaced, it may not have .buffer return sys.stdout.write(b.decode('ascii', 'replace')) else: allowed_string_types = (basestring,) # analysis:ignore _chr = staticmethod(chr) linesep = os.linesep write_to_stdout = sys.stdout.write encoding = None def __init__(self, command, args=[], timeout=30, maxread=2000, searchwindowsize=None, logfile=None, cwd=None, env=None, ignore_sighup=True): '''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. The searchwindowsize attribute sets the how far back in the incoming seach buffer Pexpect will search for pattern matches. Every time Pexpect reads some data from the child it will append the data to the incoming buffer. The default is to search from the beginning of the incoming buffer each time new data is read from the child. But this is very inefficient if you are running a command that generates a large amount of data where you want to match. The searchwindowsize does not affect the size of the incoming data buffer. You will still have access to the full buffer after expect() returns. 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 = file('mylog.txt','w') child.logfile = fout Example log to stdout:: child = pexpect.spawn('some_command') 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 To separately log output sent to the child use logfile_send:: self.logfile_send = fout If ``ignore_sighup`` is True, the child process will ignore SIGHUP signals. For now, the default is True, to preserve the behaviour of earlier versions of Pexpect, but you should pass this explicitly if you want to rely on it. 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 0 to return to the old behavior. Most Linux machines don't like this to be below 0.03. I don't know why. 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. 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. ''' self.STDIN_FILENO = pty.STDIN_FILENO self.STDOUT_FILENO = pty.STDOUT_FILENO self.STDERR_FILENO = pty.STDERR_FILENO self.stdin = sys.stdin self.stdout = sys.stdout self.stderr = sys.stderr self.searcher = None self.ignorecase = False self.before = None self.after = None self.match = None self.match_index = None self.terminated = True self.exitstatus = None self.signalstatus = None # status returned by os.waitpid self.status = None self.flag_eof = False self.pid = None # the chile filedescriptor is initially closed self.child_fd = -1 self.timeout = timeout self.delimiter = EOF self.logfile = logfile # input from child (read_nonblocking) self.logfile_read = None # output to send (send, sendline) self.logfile_send = None # max bytes to read at one time into buffer self.maxread = maxread # This is the read buffer. See maxread. self.buffer = self.string_type() # Data before searchwindowsize point is preserved, but not searched. self.searchwindowsize = searchwindowsize # Delay used before sending data to child. Time in seconds. # Most Linux machines don't like this to be below 0.03 (30 ms). self.delaybeforesend = 0.05 # Used by close() to give kernel time to update process status. # Time in seconds. self.delayafterclose = 0.1 # Used by terminate() to give kernel time to update process status. # Time in seconds. self.delayafterterminate = 0.1 self.softspace = False self.name = '<' + repr(self) + '>' self.closed = True self.cwd = cwd self.env = env self.ignore_sighup = ignore_sighup # This flags if we are running on irix self.__irix_hack = (sys.platform.lower().find('irix') >= 0) # Solaris uses internal __fork_pty(). All others use pty.fork(). if ((sys.platform.lower().find('solaris') >= 0) or (sys.platform.lower().find('sunos5') >= 0)): self.use_native_pty_fork = False else: self.use_native_pty_fork = True # Support subclasses that do not use command or args. if command is None: self.command = None self.args = None self.name = '' else: self._spawn(command, args) @staticmethod def _coerce_expect_string(s): if not isinstance(s, bytes): return s.encode('ascii') return s @staticmethod def _coerce_send_string(s): if not isinstance(s, bytes): return s.encode('utf-8') return s @staticmethod def _coerce_read_string(s): return s def __del__(self): '''This makes sure that no system resources are left open. Python only garbage collects Python objects. OS file descriptors are not Python objects, so they must be handled explicitly. If the child file descriptor was opened outside of this class (passed to the constructor) then this does not close it. ''' if not self.closed: # It is possible for __del__ methods to execute during the # teardown of the Python VM itself. Thus self.close() may # trigger an exception because os.close may be None. try: self.close() # which exception, shouldnt' we catch explicitly .. ? except: pass def __str__(self): '''This returns a human-readable string that represents the state of the object. ''' s = [] s.append(repr(self)) s.append('version: ' + __version__) s.append('command: ' + str(self.command)) s.append('args: %r' % (self.args,)) s.append('searcher: %r' % (self.searcher,)) s.append('buffer (last 100 chars): %r' % (self.buffer)[-100:],) s.append('before (last 100 chars): %r' % (self.before)[-100:],) s.append('after: %r' % (self.after,)) s.append('match: %r' % (self.match,)) s.append('match_index: ' + str(self.match_index)) s.append('exitstatus: ' + str(self.exitstatus)) s.append('flag_eof: ' + str(self.flag_eof)) s.append('pid: ' + str(self.pid)) s.append('child_fd: ' + str(self.child_fd)) s.append('closed: ' + str(self.closed)) s.append('timeout: ' + str(self.timeout)) s.append('delimiter: ' + str(self.delimiter)) s.append('logfile: ' + str(self.logfile)) s.append('logfile_read: ' + str(self.logfile_read)) s.append('logfile_send: ' + str(self.logfile_send)) s.append('maxread: ' + str(self.maxread)) s.append('ignorecase: ' + str(self.ignorecase)) s.append('searchwindowsize: ' + str(self.searchwindowsize)) s.append('delaybeforesend: ' + str(self.delaybeforesend)) s.append('delayafterclose: ' + str(self.delayafterclose)) s.append('delayafterterminate: ' + str(self.delayafterterminate)) return '\n'.join(s) def _spawn(self, command, args=[]): '''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. ''' # The pid and child_fd of this object get set by this method. # Note that it is difficult for this method to fail. # You cannot detect if the child process cannot start. # So the only way you can tell if the child process started # or not is to try to read from the file descriptor. If you get # EOF immediately then it means that the child is already dead. # That may not necessarily be bad because you may have spawned a child # that performs some task; creates no stdout output; and then dies. # If command is an int type then it may represent a file descriptor. if isinstance(command, type(0)): raise ExceptionPexpect('Command 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.') if not isinstance(args, type([])): raise TypeError('The argument, args, must be a list.') if args == []: self.args = split_command_line(command) self.command = self.args[0] else: # Make a shallow copy of the args list. self.args = args[:] self.args.insert(0, command) self.command = command command_with_path = which(self.command) if command_with_path is None: raise ExceptionPexpect('The command was not found or was not ' + 'executable: %s.' % self.command) self.command = command_with_path self.args[0] = self.command self.name = '<' + ' '.join(self.args) + '>' assert self.pid is None, 'The pid member must be None.' assert self.command is not None, 'The command member must not be None.' if self.use_native_pty_fork: try: self.pid, self.child_fd = pty.fork() except OSError: err = sys.exc_info()[1] raise ExceptionPexpect('pty.fork() failed: ' + str(err)) else: # Use internal __fork_pty self.pid, self.child_fd = self.__fork_pty() if self.pid == 0: # Child try: # used by setwinsize() self.child_fd = sys.stdout.fileno() self.setwinsize(24, 80) # which exception, shouldnt' we catch explicitly .. ? except: # Some platforms do not like setwinsize (Cygwin). # This will cause problem when running applications that # are very picky about window size. # This is a serious limitation, but not a show stopper. pass # Do not allow child to inherit open file descriptors from parent. max_fd = resource.getrlimit(resource.RLIMIT_NOFILE)[0] for i in range(3, max_fd): try: os.close(i) except OSError: pass if self.ignore_sighup: signal.signal(signal.SIGHUP, signal.SIG_IGN) if self.cwd is not None: os.chdir(self.cwd) if self.env is None: os.execv(self.command, self.args) else: os.execvpe(self.command, self.args, self.env) # Parent self.terminated = False self.closed = False def __fork_pty(self): '''This implements a substitute for the forkpty system call. This should be more portable than the pty.fork() function. Specifically, this should work on Solaris. Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to resolve the issue with Python's pty.fork() not supporting Solaris, particularly ssh. Based on patch to posixmodule.c authored by Noah Spurrier:: http://mail.python.org/pipermail/python-dev/2003-May/035281.html ''' parent_fd, child_fd = os.openpty() if parent_fd < 0 or child_fd < 0: raise ExceptionPexpect("Could not open with os.openpty().") pid = os.fork() if pid < 0: raise ExceptionPexpect("Failed os.fork().") elif pid == 0: # Child. os.close(parent_fd) self.__pty_make_controlling_tty(child_fd) os.dup2(child_fd, 0) os.dup2(child_fd, 1) os.dup2(child_fd, 2) if child_fd > 2: os.close(child_fd) else: # Parent. os.close(child_fd) return pid, parent_fd def __pty_make_controlling_tty(self, tty_fd): '''This makes the pseudo-terminal the controlling tty. This should be more portable than the pty.fork() function. Specifically, this should work on Solaris. ''' child_name = os.ttyname(tty_fd) # Disconnect from controlling tty. Harmless if not already connected. try: fd = os.open("/dev/tty", os.O_RDWR | os.O_NOCTTY) if fd >= 0: os.close(fd) # which exception, shouldnt' we catch explicitly .. ? except: # Already disconnected. This happens if running inside cron. pass os.setsid() # Verify we are disconnected from controlling tty # by attempting to open it again. try: fd = os.open("/dev/tty", os.O_RDWR | os.O_NOCTTY) if fd >= 0: os.close(fd) raise ExceptionPexpect('Failed to disconnect from ' + 'controlling tty. It is still possible to open /dev/tty.') # which exception, shouldnt' we catch explicitly .. ? except: # Good! We are disconnected from a controlling tty. pass # Verify we can open child pty. fd = os.open(child_name, os.O_RDWR) if fd < 0: raise ExceptionPexpect("Could not open child pty, " + child_name) else: os.close(fd) # Verify we now have a controlling tty. fd = os.open("/dev/tty", os.O_WRONLY) if fd < 0: raise ExceptionPexpect("Could not open controlling tty, /dev/tty") else: os.close(fd) def fileno(self): '''This returns the file descriptor of the pty for the child. ''' return self.child_fd def 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). ''' if not self.closed: self.flush() os.close(self.child_fd) # Give kernel time to update process status. time.sleep(self.delayafterclose) if self.isalive(): if not self.terminate(force): raise ExceptionPexpect('Could not terminate the child.') self.child_fd = -1 self.closed = True #self.pid = None def flush(self): '''This does nothing. It is here to support the interface for a File-like object. ''' pass def isatty(self): '''This returns True if the file descriptor is open and connected to a tty(-like) device, else False. ''' return os.isatty(self.child_fd) def 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. ''' if timeout == -1: timeout = self.timeout if timeout is not None: end_time = time.time() + timeout while True: if not self.getecho(): return True if timeout < 0 and timeout is not None: return False if timeout is not None: timeout = end_time - time.time() time.sleep(0.1) def 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(). ''' attr = termios.tcgetattr(self.child_fd) if attr[3] & termios.ECHO: return True return False def 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']) ''' self.child_fd attr = termios.tcgetattr(self.child_fd) if state: attr[3] = attr[3] | termios.ECHO else: attr[3] = attr[3] & ~termios.ECHO # I tried TCSADRAIN and TCSAFLUSH, but # these were inconsistent and blocked on some platforms. # TCSADRAIN would probably be ideal if it worked. termios.tcsetattr(self.child_fd, termios.TCSANOW, attr) def _log(self, s, direction): if self.logfile is not None: self.logfile.write(s) self.logfile.flush() second_log = self.logfile_send if (direction=='send') else self.logfile_read if second_log is not None: second_log.write(s) second_log.flush() def 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 log file was set using setlog() then all data will also be written to the log file. 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 effected 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. ''' if self.closed: raise ValueError('I/O operation on closed file.') if timeout == -1: timeout = self.timeout # Note that some systems such as Solaris do not give an EOF when # the child dies. In fact, you can still try to read # from the child_fd -- it will block forever or until TIMEOUT. # For this case, I test isalive() before doing any reading. # If isalive() is false, then I pretend that this is the same as EOF. if not self.isalive(): # timeout of 0 means "poll" r, w, e = self.__select([self.child_fd], [], [], 0) if not r: self.flag_eof = True raise EOF('End Of File (EOF). Braindead platform.') elif self.__irix_hack: # Irix takes a long time before it realizes a child was terminated. # FIXME So does this mean Irix systems are forced to always have # FIXME a 2 second delay when calling read_nonblocking? That sucks. r, w, e = self.__select([self.child_fd], [], [], 2) if not r and not self.isalive(): self.flag_eof = True raise EOF('End Of File (EOF). Slow platform.') r, w, e = self.__select([self.child_fd], [], [], timeout) if not r: if not self.isalive(): # Some platforms, such as Irix, will claim that their # processes are alive; timeout on the select; and # then finally admit that they are not alive. self.flag_eof = True raise EOF('End of File (EOF). Very slow platform.') else: raise TIMEOUT('Timeout exceeded.') if self.child_fd in r: try: s = os.read(self.child_fd, size) except OSError: # Linux does this self.flag_eof = True raise EOF('End Of File (EOF). Exception style platform.') if s == b'': # BSD style self.flag_eof = True raise EOF('End Of File (EOF). Empty string style platform.') s = self._coerce_read_string(s) self._log(s, 'read') return s raise ExceptionPexpect('Reached an unexpected state.') def 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. ''' if size == 0: return self.string_type() if size < 0: # delimiter default is EOF self.expect(self.delimiter) return self.before # I could have done this more directly by not using expect(), but # I deliberately decided to couple read() to expect() so that # I would catch any bugs early and ensure consistant behavior. # It's a little less efficient, but there is less for me to # worry about if I have to later modify read() or expect(). # Note, it's OK if size==-1 in the regex. That just means it # will never match anything in which case we stop only on EOF. cre = re.compile(self._coerce_expect_string('.{%d}' % size), re.DOTALL) # delimiter default is EOF index = self.expect([cre, self.delimiter]) if index == 0: ### FIXME self.before should be ''. Should I assert this? return self.after return self.before def 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. ''' if size == 0: return self.string_type() # delimiter default is EOF index = self.expect([b'\r\n', self.delimiter]) if index == 0: return self.before + b'\r\n' else: return self.before def __iter__(self): '''This is to support iterators over a file-like object. ''' return iter(self.readline, self.string_type()) def 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.''' lines = [] while True: line = self.readline() if not line: break lines.append(line) return lines def write(self, s): '''This is similar to send() except that there is no return value. ''' self.send(s) def 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. ''' for s in sequence: self.write(s) def 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. ''' time.sleep(self.delaybeforesend) s = self._coerce_send_string(s) self._log(s, 'send') return self._send(s) def _send(self, s): return os.write(self.child_fd, s) def sendline(self, s=''): '''Wraps send(), sending string ``s`` to child process, with os.linesep automatically appended. Returns number of bytes written. ''' n = self.send(s) n = n + self.send(self.linesep) return n def 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, '\a'):: child.sendcontrol('g') See also, sendintr() and sendeof(). ''' char = char.lower() a = ord(char) if a >= 97 and a <= 122: a = a - ord('a') + 1 return self.send(self._chr(a)) d = {'@': 0, '`': 0, '[': 27, '{': 27, '\\': 28, '|': 28, ']': 29, '}': 29, '^': 30, '~': 30, '_': 31, '?': 127} if char not in d: return 0 return self.send(self._chr(d[char])) def 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. ''' ### Hmmm... how do I send an EOF? ###C if ((m = write(pty, *buf, p - *buf)) < 0) ###C return (errno == EWOULDBLOCK) ? n : -1; #fd = sys.stdin.fileno() #old = termios.tcgetattr(fd) # remember current state #attr = termios.tcgetattr(fd) #attr[3] = attr[3] | termios.ICANON # ICANON must be set to see EOF #try: # use try/finally to ensure state gets restored # termios.tcsetattr(fd, termios.TCSADRAIN, attr) # if hasattr(termios, 'CEOF'): # os.write(self.child_fd, '%c' % termios.CEOF) # else: # # Silly platform does not define CEOF so assume CTRL-D # os.write(self.child_fd, '%c' % 4) #finally: # restore state # termios.tcsetattr(fd, termios.TCSADRAIN, old) if hasattr(termios, 'VEOF'): char = ord(termios.tcgetattr(self.child_fd)[6][termios.VEOF]) else: # platform does not define VEOF so assume CTRL-D char = 4 self.send(self._chr(char)) def sendintr(self): '''This sends a SIGINT to the child. It does not require the SIGINT to be the first character on a line. ''' if hasattr(termios, 'VINTR'): char = ord(termios.tcgetattr(self.child_fd)[6][termios.VINTR]) else: # platform does not define VINTR so assume CTRL-C char = 3 self.send(self._chr(char)) def eof(self): '''This returns True if the EOF exception was ever raised. ''' return self.flag_eof def 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. ''' if not self.isalive(): return True try: self.kill(signal.SIGHUP) time.sleep(self.delayafterterminate) if not self.isalive(): return True self.kill(signal.SIGCONT) time.sleep(self.delayafterterminate) if not self.isalive(): return True self.kill(signal.SIGINT) time.sleep(self.delayafterterminate) if not self.isalive(): return True if force: self.kill(signal.SIGKILL) time.sleep(self.delayafterterminate) if not self.isalive(): return True else: return False return False except OSError: # I think there are kernel timing issues that sometimes cause # this to happen. I think isalive() reports True, but the # process is dead to the kernel. # Make one last attempt to see if the kernel is up to date. time.sleep(self.delayafterterminate) if not self.isalive(): return True else: return False def 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. ''' if self.isalive(): pid, status = os.waitpid(self.pid, 0) else: raise ExceptionPexpect('Cannot wait for dead child process.') self.exitstatus = os.WEXITSTATUS(status) if os.WIFEXITED(status): self.status = status self.exitstatus = os.WEXITSTATUS(status) self.signalstatus = None self.terminated = True elif os.WIFSIGNALED(status): self.status = status self.exitstatus = None self.signalstatus = os.WTERMSIG(status) self.terminated = True elif os.WIFSTOPPED(status): # You can't call wait() on a child process in the stopped state. raise ExceptionPexpect('Called wait() on a stopped child ' + 'process. This is not supported. Is some other ' + 'process attempting job control with our child pid?') return self.exitstatus def 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. ''' if self.terminated: return False if self.flag_eof: # This is for Linux, which requires the blocking form # of waitpid to # get status of a defunct process. # This is super-lame. The flag_eof would have been set # in read_nonblocking(), so this should be safe. waitpid_options = 0 else: waitpid_options = os.WNOHANG try: pid, status = os.waitpid(self.pid, waitpid_options) except OSError: err = sys.exc_info()[1] # No child processes if err.errno == errno.ECHILD: raise ExceptionPexpect('isalive() encountered condition ' + 'where "terminated" is 0, but there was no child ' + 'process. Did someone else call waitpid() ' + 'on our process?') else: raise err # I have to do this twice for Solaris. # I can't even believe that I figured this out... # If waitpid() returns 0 it means that no child process # wishes to report, and the value of status is undefined. if pid == 0: try: ### os.WNOHANG) # Solaris! pid, status = os.waitpid(self.pid, waitpid_options) except OSError as e: # This should never happen... if e.errno == errno.ECHILD: raise ExceptionPexpect('isalive() encountered condition ' + 'that should never happen. There was no child ' + 'process. Did someone else call waitpid() ' + 'on our process?') else: raise # If pid is still 0 after two calls to waitpid() then the process # really is alive. This seems to work on all platforms, except for # Irix which seems to require a blocking call on waitpid or select, # so I let read_nonblocking take care of this situation # (unfortunately, this requires waiting through the timeout). if pid == 0: return True if pid == 0: return True if os.WIFEXITED(status): self.status = status self.exitstatus = os.WEXITSTATUS(status) self.signalstatus = None self.terminated = True elif os.WIFSIGNALED(status): self.status = status self.exitstatus = None self.signalstatus = os.WTERMSIG(status) self.terminated = True elif os.WIFSTOPPED(status): raise ExceptionPexpect('isalive() encountered condition ' + 'where child process is stopped. This is not ' + 'supported. Is some other process attempting ' + 'job control with our child pid?') return False def 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. ''' # Same as os.kill, but the pid is given for you. if self.isalive(): os.kill(self.pid, sig) def _pattern_type_err(self, pattern): raise TypeError('got {badtype} ({badobj!r}) as pattern, must be one' ' of: {goodtypes}, pexpect.EOF, pexpect.TIMEOUT'\ .format(badtype=type(pattern), badobj=pattern, goodtypes=', '.join([str(ast)\ for ast in self.allowed_string_types]) ) ) def 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(clp, timeout) ... ''' if patterns is None: return [] if not isinstance(patterns, list): patterns = [patterns] # Allow dot to match \n compile_flags = re.DOTALL if self.ignorecase: compile_flags = compile_flags | re.IGNORECASE compiled_pattern_list = [] for idx, p in enumerate(patterns): if isinstance(p, self.allowed_string_types): p = self._coerce_expect_string(p) compiled_pattern_list.append(re.compile(p, compile_flags)) elif p is EOF: compiled_pattern_list.append(EOF) elif p is TIMEOUT: compiled_pattern_list.append(TIMEOUT) elif isinstance(p, type(re.compile(''))): compiled_pattern_list.append(p) else: self._pattern_type_err(p) return compiled_pattern_list def expect(self, pattern, timeout=-1, searchwindowsize=-1): '''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 After a match is found the instance attributes 'before', 'after' and 'match' will be set. You can see all the data read before the match in 'before'. You can see the data that was matched in 'after'. The re.MatchObject used in the re match will be in 'match'. If an error occurred then 'before' will be set to all the data read so far and 'after' and 'match' will be None. If timeout is -1 then timeout will be set to the self.timeout value. 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(). ''' compiled_pattern_list = self.compile_pattern_list(pattern) return self.expect_list(compiled_pattern_list, timeout, searchwindowsize) def expect_list(self, pattern_list, timeout=-1, searchwindowsize=-1): '''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(). If timeout==-1 then the self.timeout value is used. If searchwindowsize==-1 then the self.searchwindowsize value is used. ''' return self.expect_loop(searcher_re(pattern_list), timeout, searchwindowsize) def expect_exact(self, pattern_list, timeout=-1, searchwindowsize=-1): '''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.''' if (isinstance(pattern_list, self.allowed_string_types) or pattern_list in (TIMEOUT, EOF)): pattern_list = [pattern_list] def prepare_pattern(pattern): if pattern in (TIMEOUT, EOF): return pattern if isinstance(pattern, self.allowed_string_types): return self._coerce_expect_string(pattern) self._pattern_type_err(pattern) try: pattern_list = iter(pattern_list) except TypeError: self._pattern_type_err(pattern_list) pattern_list = [prepare_pattern(p) for p in pattern_list] return self.expect_loop(searcher_string(pattern_list), timeout, searchwindowsize) def 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. ''' self.searcher = searcher if timeout == -1: timeout = self.timeout if timeout is not None: end_time = time.time() + timeout if searchwindowsize == -1: searchwindowsize = self.searchwindowsize try: incoming = self.buffer freshlen = len(incoming) while True: # Keep reading until exception or return. index = searcher.search(incoming, freshlen, searchwindowsize) if index >= 0: self.buffer = incoming[searcher.end:] self.before = incoming[: searcher.start] self.after = incoming[searcher.start: searcher.end] self.match = searcher.match self.match_index = index return self.match_index # No match at this point if (timeout is not None) and (timeout < 0): raise TIMEOUT('Timeout exceeded in expect_any().') # Still have time left, so read more data c = self.read_nonblocking(self.maxread, timeout) freshlen = len(c) time.sleep(0.0001) incoming = incoming + c if timeout is not None: timeout = end_time - time.time() except EOF: err = sys.exc_info()[1] self.buffer = self.string_type() self.before = incoming self.after = EOF index = searcher.eof_index if index >= 0: self.match = EOF self.match_index = index return self.match_index else: self.match = None self.match_index = None raise EOF(str(err) + '\n' + str(self)) except TIMEOUT: err = sys.exc_info()[1] self.buffer = incoming self.before = incoming self.after = TIMEOUT index = searcher.timeout_index if index >= 0: self.match = TIMEOUT self.match_index = index return self.match_index else: self.match = None self.match_index = None raise TIMEOUT(str(err) + '\n' + str(self)) except: self.before = incoming self.after = None self.match = None self.match_index = None raise def getwinsize(self): '''This returns the terminal window size of the child tty. The return value is a tuple of (rows, cols). ''' TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912) s = struct.pack('HHHH', 0, 0, 0, 0) x = fcntl.ioctl(self.child_fd, TIOCGWINSZ, s) return struct.unpack('HHHH', x)[0:2] def 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. ''' # Check for buggy platforms. Some Python versions on some platforms # (notably OSF1 Alpha and RedHat 7.1) truncate the value for # termios.TIOCSWINSZ. It is not clear why this happens. # These platforms don't seem to handle the signed int very well; # yet other platforms like OpenBSD have a large negative value for # TIOCSWINSZ and they don't have a truncate problem. # Newer versions of Linux have totally different values for TIOCSWINSZ. # Note that this fix is a hack. TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561) if TIOCSWINSZ == 2148037735: # Same bits, but with sign. TIOCSWINSZ = -2146929561 # Note, assume ws_xpixel and ws_ypixel are zero. s = struct.pack('HHHH', rows, cols, 0, 0) fcntl.ioctl(self.fileno(), TIOCSWINSZ, s) def interact(self, escape_character=chr(29), 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 stop. The default for escape_character is ^]. This should not be confused with ASCII 27 -- the ESC character. ASCII 29 was chosen for historical merit because this is the character used by 'telnet' as the escape character. The escape_character will not be sent to the child process. 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() ''' # Flush the buffer. self.write_to_stdout(self.buffer) self.stdout.flush() self.buffer = self.string_type() mode = tty.tcgetattr(self.STDIN_FILENO) tty.setraw(self.STDIN_FILENO) if PY3: escape_character = escape_character.encode('latin-1') try: self.__interact_copy(escape_character, input_filter, output_filter) finally: tty.tcsetattr(self.STDIN_FILENO, tty.TCSAFLUSH, mode) def __interact_writen(self, fd, data): '''This is used by the interact() method. ''' while data != b'' and self.isalive(): n = os.write(fd, data) data = data[n:] def __interact_read(self, fd): '''This is used by the interact() method. ''' return os.read(fd, 1000) def __interact_copy(self, escape_character=None, input_filter=None, output_filter=None): '''This is used by the interact() method. ''' while self.isalive(): r, w, e = self.__select([self.child_fd, self.STDIN_FILENO], [], []) if self.child_fd in r: try: data = self.__interact_read(self.child_fd) except OSError as e: # The subprocess may have closed before we get to reading it if e.errno != errno.EIO: raise if output_filter: data = output_filter(data) if self.logfile is not None: self.logfile.write(data) self.logfile.flush() os.write(self.STDOUT_FILENO, data) if self.STDIN_FILENO in r: data = self.__interact_read(self.STDIN_FILENO) if input_filter: data = input_filter(data) i = data.rfind(escape_character) if i != -1: data = data[:i] self.__interact_writen(self.child_fd, data) break self.__interact_writen(self.child_fd, data) def __select(self, iwtd, owtd, ewtd, timeout=None): '''This is a wrapper around select.select() that ignores signals. If select.select raises a select.error exception and errno is an EINTR error then it is ignored. Mainly this is used to ignore sigwinch (terminal resize). ''' # if select() is interrupted by a signal (errno==EINTR) then # we loop back and enter the select() again. if timeout is not None: end_time = time.time() + timeout while True: try: return select.select(iwtd, owtd, ewtd, timeout) except select.error: err = sys.exc_info()[1] if err.errno == errno.EINTR: # if we loop back we have to subtract the # amount of time we already waited. if timeout is not None: timeout = end_time - time.time() if timeout < 0: return([], [], []) else: # something else caused the select.error, so # this actually is an exception. raise ############################################################################## # The following methods are no longer supported or allowed. def setmaxread(self, maxread): '''This method is no longer supported or allowed. I don't like getters and setters without a good reason. ''' raise ExceptionPexpect('This method is no longer supported ' + 'or allowed. Just assign a value to the ' + 'maxread member variable.') def setlog(self, fileobject): '''This method is no longer supported or allowed. ''' raise ExceptionPexpect('This method is no longer supported ' + 'or allowed. Just assign a value to the logfile ' + 'member variable.') ############################################################################## # End of spawn class ############################################################################## class spawnu(spawn): """Works like spawn, but accepts and returns unicode strings. Extra parameters: :param encoding: The encoding to use for communications (default: 'utf-8') :param errors: How to handle encoding/decoding errors; one of 'strict' (the default), 'ignore', or 'replace', as described for :meth:`~bytes.decode` and :meth:`~str.encode`. """ if PY3: string_type = str allowed_string_types = (str, ) _chr = staticmethod(chr) linesep = os.linesep else: string_type = unicode allowed_string_types = (unicode, ) _chr = staticmethod(unichr) linesep = os.linesep.decode('ascii') # This can handle unicode in both Python 2 and 3 write_to_stdout = sys.stdout.write def __init__(self, *args, **kwargs): self.encoding = kwargs.pop('encoding', 'utf-8') self.errors = kwargs.pop('errors', 'strict') self._decoder = codecs.getincrementaldecoder(self.encoding)(errors=self.errors) super(spawnu, self).__init__(*args, **kwargs) @staticmethod def _coerce_expect_string(s): return s @staticmethod def _coerce_send_string(s): return s def _coerce_read_string(self, s): return self._decoder.decode(s, final=False) def _send(self, s): return os.write(self.child_fd, s.encode(self.encoding, self.errors)) class searcher_string(object): '''This is a plain string search helper for the spawn.expect_any() method. This helper class is for speed. For more powerful regex patterns see the helper class, searcher_re. Attributes: eof_index - index of EOF, or -1 timeout_index - index of TIMEOUT, or -1 After a successful match by the search() method the following attributes are available: start - index into the buffer, first byte of match end - index into the buffer, first byte after match match - the matching string itself ''' def __init__(self, strings): '''This creates an instance of searcher_string. This argument 'strings' may be a list; a sequence of strings; or the EOF or TIMEOUT types. ''' self.eof_index = -1 self.timeout_index = -1 self._strings = [] for n, s in enumerate(strings): if s is EOF: self.eof_index = n continue if s is TIMEOUT: self.timeout_index = n continue self._strings.append((n, s)) def __str__(self): '''This returns a human-readable string that represents the state of the object.''' ss = [(ns[0], ' %d: "%s"' % ns) for ns in self._strings] ss.append((-1, 'searcher_string:')) if self.eof_index >= 0: ss.append((self.eof_index, ' %d: EOF' % self.eof_index)) if self.timeout_index >= 0: ss.append((self.timeout_index, ' %d: TIMEOUT' % self.timeout_index)) ss.sort() ss = list(zip(*ss))[1] return '\n'.join(ss) def search(self, buffer, freshlen, searchwindowsize=None): '''This searches 'buffer' for the first occurence of one of the search strings. 'freshlen' must indicate the number of bytes at the end of 'buffer' which have not been searched before. It helps to avoid searching the same, possibly big, buffer over and over again. See class spawn for the 'searchwindowsize' argument. If there is a match this returns the index of that string, and sets 'start', 'end' and 'match'. Otherwise, this returns -1. ''' first_match = None # 'freshlen' helps a lot here. Further optimizations could # possibly include: # # using something like the Boyer-Moore Fast String Searching # Algorithm; pre-compiling the search through a list of # strings into something that can scan the input once to # search for all N strings; realize that if we search for # ['bar', 'baz'] and the input is '...foo' we need not bother # rescanning until we've read three more bytes. # # Sadly, I don't know enough about this interesting topic. /grahn for index, s in self._strings: if searchwindowsize is None: # the match, if any, can only be in the fresh data, # or at the very end of the old data offset = -(freshlen + len(s)) else: # better obey searchwindowsize offset = -searchwindowsize n = buffer.find(s, offset) if n >= 0 and (first_match is None or n < first_match): first_match = n best_index, best_match = index, s if first_match is None: return -1 self.match = best_match self.start = first_match self.end = self.start + len(self.match) return best_index class searcher_re(object): '''This is regular expression string search helper for the spawn.expect_any() method. This helper class is for powerful pattern matching. For speed, see the helper class, searcher_string. Attributes: eof_index - index of EOF, or -1 timeout_index - index of TIMEOUT, or -1 After a successful match by the search() method the following attributes are available: start - index into the buffer, first byte of match end - index into the buffer, first byte after match match - the re.match object returned by a succesful re.search ''' def __init__(self, patterns): '''This creates an instance that searches for 'patterns' Where 'patterns' may be a list or other sequence of compiled regular expressions, or the EOF or TIMEOUT types.''' self.eof_index = -1 self.timeout_index = -1 self._searches = [] for n, s in zip(list(range(len(patterns))), patterns): if s is EOF: self.eof_index = n continue if s is TIMEOUT: self.timeout_index = n continue self._searches.append((n, s)) def __str__(self): '''This returns a human-readable string that represents the state of the object.''' #ss = [(n, ' %d: re.compile("%s")' % # (n, repr(s.pattern))) for n, s in self._searches] ss = list() for n, s in self._searches: try: ss.append((n, ' %d: re.compile("%s")' % (n, s.pattern))) except UnicodeEncodeError: # for test cases that display __str__ of searches, dont throw # another exception just because stdout is ascii-only, using # repr() ss.append((n, ' %d: re.compile(%r)' % (n, s.pattern))) ss.append((-1, 'searcher_re:')) if self.eof_index >= 0: ss.append((self.eof_index, ' %d: EOF' % self.eof_index)) if self.timeout_index >= 0: ss.append((self.timeout_index, ' %d: TIMEOUT' % self.timeout_index)) ss.sort() ss = list(zip(*ss))[1] return '\n'.join(ss) def search(self, buffer, freshlen, searchwindowsize=None): '''This searches 'buffer' for the first occurence of one of the regular expressions. 'freshlen' must indicate the number of bytes at the end of 'buffer' which have not been searched before. See class spawn for the 'searchwindowsize' argument. If there is a match this returns the index of that string, and sets 'start', 'end' and 'match'. Otherwise, returns -1.''' first_match = None # 'freshlen' doesn't help here -- we cannot predict the # length of a match, and the re module provides no help. if searchwindowsize is None: searchstart = 0 else: searchstart = max(0, len(buffer) - searchwindowsize) for index, s in self._searches: match = s.search(buffer, searchstart) if match is None: continue n = match.start() if first_match is None or n < first_match: first_match = n the_match = match best_index = index if first_match is None: return -1 self.start = first_match self.match = the_match self.end = self.match.end() return best_index def which(filename): '''This takes a given filename; tries to find it in the environment path; then checks if it is executable. This returns the full path to the filename if found and executable. Otherwise this returns None.''' # Special case where filename contains an explicit path. if os.path.dirname(filename) != '': if os.access(filename, os.X_OK): return filename if 'PATH' not in os.environ or os.environ['PATH'] == '': p = os.defpath else: p = os.environ['PATH'] pathlist = p.split(os.pathsep) for path in pathlist: ff = os.path.join(path, filename) if os.access(ff, os.X_OK): return ff return None def split_command_line(command_line): '''This splits a command line into a list of arguments. It splits arguments on spaces, but handles embedded quotes, doublequotes, and escaped characters. It's impossible to do this with a regular expression, so I wrote a little state machine to parse the command line. ''' arg_list = [] arg = '' # Constants to name the states we can be in. state_basic = 0 state_esc = 1 state_singlequote = 2 state_doublequote = 3 # The state when consuming whitespace between commands. state_whitespace = 4 state = state_basic for c in command_line: if state == state_basic or state == state_whitespace: if c == '\\': # Escape the next character state = state_esc elif c == r"'": # Handle single quote state = state_singlequote elif c == r'"': # Handle double quote state = state_doublequote elif c.isspace(): # Add arg to arg_list if we aren't in the middle of whitespace. if state == state_whitespace: # Do nothing. None else: arg_list.append(arg) arg = '' state = state_whitespace else: arg = arg + c state = state_basic elif state == state_esc: arg = arg + c state = state_basic elif state == state_singlequote: if c == r"'": state = state_basic else: arg = arg + c elif state == state_doublequote: if c == r'"': state = state_basic else: arg = arg + c if arg != '': arg_list.append(arg) return arg_list # vi:set sr et ts=4 sw=4 ft=python : pexpect-3.1/pexpect/FSM.py0000644000175400017540000003215312267623031017610 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This module implements a Finite State Machine (FSM). In addition to state this FSM also maintains a user defined "memory". So this FSM can be used as a Push-down Automata (PDA) since a PDA is a FSM + memory. The following describes how the FSM works, but you will probably also need to see the example function to understand how the FSM is used in practice. You define an FSM by building tables of transitions. For a given input symbol the process() method uses these tables to decide what action to call and what the next state will be. The FSM has a table of transitions that associate: (input_symbol, current_state) --> (action, next_state) Where "action" is a function you define. The symbols and states can be any objects. You use the add_transition() and add_transition_list() methods to add to the transition table. The FSM also has a table of transitions that associate: (current_state) --> (action, next_state) You use the add_transition_any() method to add to this transition table. The FSM also has one default transition that is not associated with any specific input_symbol or state. You use the set_default_transition() method to set the default transition. When an action function is called it is passed a reference to the FSM. The action function may then access attributes of the FSM such as input_symbol, current_state, or "memory". The "memory" attribute can be any object that you want to pass along to the action functions. It is not used by the FSM itself. For parsing you would typically pass a list to be used as a stack. The processing sequence is as follows. The process() method is given an input_symbol to process. The FSM will search the table of transitions that associate: (input_symbol, current_state) --> (action, next_state) If the pair (input_symbol, current_state) is found then process() will call the associated action function and then set the current state to the next_state. If the FSM cannot find a match for (input_symbol, current_state) it will then search the table of transitions that associate: (current_state) --> (action, next_state) If the current_state is found then the process() method will call the associated action function and then set the current state to the next_state. Notice that this table lacks an input_symbol. It lets you define transitions for a current_state and ANY input_symbol. Hence, it is called the "any" table. Remember, it is always checked after first searching the table for a specific (input_symbol, current_state). For the case where the FSM did not match either of the previous two cases the FSM will try to use the default transition. If the default transition is defined then the process() method will call the associated action function and then set the current state to the next_state. This lets you define a default transition as a catch-all case. You can think of it as an exception handler. There can be only one default transition. Finally, if none of the previous cases are defined for an input_symbol and current_state then the FSM will raise an exception. This may be desirable, but you can always prevent this just by defining a default transition. Noah Spurrier 20020822 PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' class ExceptionFSM(Exception): '''This is the FSM Exception class.''' def __init__(self, value): self.value = value def __str__(self): return 'ExceptionFSM: ' + str(self.value) class FSM: '''This is a Finite State Machine (FSM). ''' def __init__(self, initial_state, memory=None): '''This creates the FSM. You set the initial state here. The "memory" attribute is any object that you want to pass along to the action functions. It is not used by the FSM. For parsing you would typically pass a list to be used as a stack. ''' # Map (input_symbol, current_state) --> (action, next_state). self.state_transitions = {} # Map (current_state) --> (action, next_state). self.state_transitions_any = {} self.default_transition = None self.input_symbol = None self.initial_state = initial_state self.current_state = self.initial_state self.next_state = None self.action = None self.memory = memory def reset (self): '''This sets the current_state to the initial_state and sets input_symbol to None. The initial state was set by the constructor __init__(). ''' self.current_state = self.initial_state self.input_symbol = None def add_transition (self, input_symbol, state, action=None, next_state=None): '''This adds a transition that associates: (input_symbol, current_state) --> (action, next_state) The action may be set to None in which case the process() method will ignore the action and only set the next_state. The next_state may be set to None in which case the current state will be unchanged. You can also set transitions for a list of symbols by using add_transition_list(). ''' if next_state is None: next_state = state self.state_transitions[(input_symbol, state)] = (action, next_state) def add_transition_list (self, list_input_symbols, state, action=None, next_state=None): '''This adds the same transition for a list of input symbols. You can pass a list or a string. Note that it is handy to use string.digits, string.whitespace, string.letters, etc. to add transitions that match character classes. The action may be set to None in which case the process() method will ignore the action and only set the next_state. The next_state may be set to None in which case the current state will be unchanged. ''' if next_state is None: next_state = state for input_symbol in list_input_symbols: self.add_transition (input_symbol, state, action, next_state) def add_transition_any (self, state, action=None, next_state=None): '''This adds a transition that associates: (current_state) --> (action, next_state) That is, any input symbol will match the current state. The process() method checks the "any" state associations after it first checks for an exact match of (input_symbol, current_state). The action may be set to None in which case the process() method will ignore the action and only set the next_state. The next_state may be set to None in which case the current state will be unchanged. ''' if next_state is None: next_state = state self.state_transitions_any [state] = (action, next_state) def set_default_transition (self, action, next_state): '''This sets the default transition. This defines an action and next_state if the FSM cannot find the input symbol and the current state in the transition list and if the FSM cannot find the current_state in the transition_any list. This is useful as a final fall-through state for catching errors and undefined states. The default transition can be removed by setting the attribute default_transition to None. ''' self.default_transition = (action, next_state) def get_transition (self, input_symbol, state): '''This returns (action, next state) given an input_symbol and state. This does not modify the FSM state, so calling this method has no side effects. Normally you do not call this method directly. It is called by process(). The sequence of steps to check for a defined transition goes from the most specific to the least specific. 1. Check state_transitions[] that match exactly the tuple, (input_symbol, state) 2. Check state_transitions_any[] that match (state) In other words, match a specific state and ANY input_symbol. 3. Check if the default_transition is defined. This catches any input_symbol and any state. This is a handler for errors, undefined states, or defaults. 4. No transition was defined. If we get here then raise an exception. ''' if (input_symbol, state) in self.state_transitions: return self.state_transitions[(input_symbol, state)] elif state in self.state_transitions_any: return self.state_transitions_any[state] elif self.default_transition is not None: return self.default_transition else: raise ExceptionFSM ('Transition is undefined: (%s, %s).' % (str(input_symbol), str(state)) ) def process (self, input_symbol): '''This is the main method that you call to process input. This may cause the FSM to change state and call an action. This method calls get_transition() to find the action and next_state associated with the input_symbol and current_state. If the action is None then the action is not called and only the current state is changed. This method processes one complete input symbol. You can process a list of symbols (or a string) by calling process_list(). ''' self.input_symbol = input_symbol (self.action, self.next_state) = self.get_transition (self.input_symbol, self.current_state) if self.action is not None: self.action (self) self.current_state = self.next_state self.next_state = None def process_list (self, input_symbols): '''This takes a list and sends each element to process(). The list may be a string or any iterable object. ''' for s in input_symbols: self.process (s) ############################################################################## # The following is an example that demonstrates the use of the FSM class to # process an RPN expression. Run this module from the command line. You will # get a prompt > for input. Enter an RPN Expression. Numbers may be integers. # Operators are * / + - Use the = sign to evaluate and print the expression. # For example: # # 167 3 2 2 * * * 1 - = # # will print: # # 2003 ############################################################################## import sys import string PY3 = (sys.version_info[0] >= 3) # # These define the actions. # Note that "memory" is a list being used as a stack. # def BeginBuildNumber (fsm): fsm.memory.append (fsm.input_symbol) def BuildNumber (fsm): s = fsm.memory.pop () s = s + fsm.input_symbol fsm.memory.append (s) def EndBuildNumber (fsm): s = fsm.memory.pop () fsm.memory.append (int(s)) def DoOperator (fsm): ar = fsm.memory.pop() al = fsm.memory.pop() if fsm.input_symbol == '+': fsm.memory.append (al + ar) elif fsm.input_symbol == '-': fsm.memory.append (al - ar) elif fsm.input_symbol == '*': fsm.memory.append (al * ar) elif fsm.input_symbol == '/': fsm.memory.append (al / ar) def DoEqual (fsm): print(str(fsm.memory.pop())) def Error (fsm): print('That does not compute.') print(str(fsm.input_symbol)) def main(): '''This is where the example starts and the FSM state transitions are defined. Note that states are strings (such as 'INIT'). This is not necessary, but it makes the example easier to read. ''' f = FSM ('INIT', []) f.set_default_transition (Error, 'INIT') f.add_transition_any ('INIT', None, 'INIT') f.add_transition ('=', 'INIT', DoEqual, 'INIT') f.add_transition_list (string.digits, 'INIT', BeginBuildNumber, 'BUILDING_NUMBER') f.add_transition_list (string.digits, 'BUILDING_NUMBER', BuildNumber, 'BUILDING_NUMBER') f.add_transition_list (string.whitespace, 'BUILDING_NUMBER', EndBuildNumber, 'INIT') f.add_transition_list ('+-*/', 'INIT', DoOperator, 'INIT') print() print('Enter an RPN Expression.') print('Numbers may be integers. Operators are * / + -') print('Use the = sign to evaluate and print the expression.') print('For example: ') print(' 167 3 2 2 * * * 1 - =') inputstr = (input if PY3 else raw_input)('> ') # analysis:ignore f.process_list(inputstr) if __name__ == '__main__': main() pexpect-3.1/pexpect/screen.py0000644000175400017540000002601012220666300020430 0ustar takluyvertakluyver00000000000000'''This implements a virtual screen. This is used to support ANSI terminal emulation. The screen representation and state is implemented in this class. Most of the methods are inspired by ANSI screen control codes. The :class:`~pexpect.ANSI.ANSI` class extends this class to add parsing of ANSI escape codes. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import copy NUL = 0 # Fill character; ignored on input. ENQ = 5 # Transmit answerback message. BEL = 7 # Ring the bell. BS = 8 # Move cursor left. HT = 9 # Move cursor to next tab stop. LF = 10 # Line feed. VT = 11 # Same as LF. FF = 12 # Same as LF. CR = 13 # Move cursor to left margin or newline. SO = 14 # Invoke G1 character set. SI = 15 # Invoke G0 character set. XON = 17 # Resume transmission. XOFF = 19 # Halt transmission. CAN = 24 # Cancel escape sequence. SUB = 26 # Same as CAN. ESC = 27 # Introduce a control sequence. DEL = 127 # Fill character; ignored on input. SPACE = chr(32) # Space or blank character. def constrain (n, min, max): '''This returns a number, n constrained to the min and max bounds. ''' if n < min: return min if n > max: return max return n class screen: '''This object maintains the state of a virtual text screen as a rectangluar array. This maintains a virtual cursor position and handles scrolling as characters are added. This supports most of the methods needed by an ANSI text screen. Row and column indexes are 1-based (not zero-based, like arrays). ''' def __init__ (self, r=24,c=80): '''This initializes a blank screen of the given dimensions.''' self.rows = r self.cols = c self.cur_r = 1 self.cur_c = 1 self.cur_saved_r = 1 self.cur_saved_c = 1 self.scroll_row_start = 1 self.scroll_row_end = self.rows self.w = [ [SPACE] * self.cols for c in range(self.rows)] def __str__ (self): '''This returns a printable representation of the screen. The end of each screen line is terminated by a newline. ''' return '\n'.join ([ ''.join(c) for c in self.w ]) def dump (self): '''This returns a copy of the screen as a string. This is similar to __str__ except that lines are not terminated with line feeds. ''' return ''.join ([ ''.join(c) for c in self.w ]) def pretty (self): '''This returns a copy of the screen as a string with an ASCII text box around the screen border. This is similar to __str__ except that it adds a box. ''' top_bot = '+' + '-'*self.cols + '+\n' return top_bot + '\n'.join(['|'+line+'|' for line in str(self).split('\n')]) + '\n' + top_bot def fill (self, ch=SPACE): self.fill_region (1,1,self.rows,self.cols, ch) def fill_region (self, rs,cs, re,ce, ch=SPACE): rs = constrain (rs, 1, self.rows) re = constrain (re, 1, self.rows) cs = constrain (cs, 1, self.cols) ce = constrain (ce, 1, self.cols) if rs > re: rs, re = re, rs if cs > ce: cs, ce = ce, cs for r in range (rs, re+1): for c in range (cs, ce + 1): self.put_abs (r,c,ch) def cr (self): '''This moves the cursor to the beginning (col 1) of the current row. ''' self.cursor_home (self.cur_r, 1) def lf (self): '''This moves the cursor down with scrolling. ''' old_r = self.cur_r self.cursor_down() if old_r == self.cur_r: self.scroll_up () self.erase_line() def crlf (self): '''This advances the cursor with CRLF properties. The cursor will line wrap and the screen may scroll. ''' self.cr () self.lf () def newline (self): '''This is an alias for crlf(). ''' self.crlf() def put_abs (self, r, c, ch): '''Screen array starts at 1 index.''' r = constrain (r, 1, self.rows) c = constrain (c, 1, self.cols) ch = str(ch)[0] self.w[r-1][c-1] = ch def put (self, ch): '''This puts a characters at the current cursor position. ''' self.put_abs (self.cur_r, self.cur_c, ch) def insert_abs (self, r, c, ch): '''This inserts a character at (r,c). Everything under and to the right is shifted right one character. The last character of the line is lost. ''' r = constrain (r, 1, self.rows) c = constrain (c, 1, self.cols) for ci in range (self.cols, c, -1): self.put_abs (r,ci, self.get_abs(r,ci-1)) self.put_abs (r,c,ch) def insert (self, ch): self.insert_abs (self.cur_r, self.cur_c, ch) def get_abs (self, r, c): r = constrain (r, 1, self.rows) c = constrain (c, 1, self.cols) return self.w[r-1][c-1] def get (self): self.get_abs (self.cur_r, self.cur_c) def get_region (self, rs,cs, re,ce): '''This returns a list of lines representing the region. ''' rs = constrain (rs, 1, self.rows) re = constrain (re, 1, self.rows) cs = constrain (cs, 1, self.cols) ce = constrain (ce, 1, self.cols) if rs > re: rs, re = re, rs if cs > ce: cs, ce = ce, cs sc = [] for r in range (rs, re+1): line = '' for c in range (cs, ce + 1): ch = self.get_abs (r,c) line = line + ch sc.append (line) return sc def cursor_constrain (self): '''This keeps the cursor within the screen area. ''' self.cur_r = constrain (self.cur_r, 1, self.rows) self.cur_c = constrain (self.cur_c, 1, self.cols) def cursor_home (self, r=1, c=1): # [{ROW};{COLUMN}H self.cur_r = r self.cur_c = c self.cursor_constrain () def cursor_back (self,count=1): # [{COUNT}D (not confused with down) self.cur_c = self.cur_c - count self.cursor_constrain () def cursor_down (self,count=1): # [{COUNT}B (not confused with back) self.cur_r = self.cur_r + count self.cursor_constrain () def cursor_forward (self,count=1): # [{COUNT}C self.cur_c = self.cur_c + count self.cursor_constrain () def cursor_up (self,count=1): # [{COUNT}A self.cur_r = self.cur_r - count self.cursor_constrain () def cursor_up_reverse (self): # M (called RI -- Reverse Index) old_r = self.cur_r self.cursor_up() if old_r == self.cur_r: self.scroll_up() def cursor_force_position (self, r, c): # [{ROW};{COLUMN}f '''Identical to Cursor Home.''' self.cursor_home (r, c) def cursor_save (self): # [s '''Save current cursor position.''' self.cursor_save_attrs() def cursor_unsave (self): # [u '''Restores cursor position after a Save Cursor.''' self.cursor_restore_attrs() def cursor_save_attrs (self): # 7 '''Save current cursor position.''' self.cur_saved_r = self.cur_r self.cur_saved_c = self.cur_c def cursor_restore_attrs (self): # 8 '''Restores cursor position after a Save Cursor.''' self.cursor_home (self.cur_saved_r, self.cur_saved_c) def scroll_constrain (self): '''This keeps the scroll region within the screen region.''' if self.scroll_row_start <= 0: self.scroll_row_start = 1 if self.scroll_row_end > self.rows: self.scroll_row_end = self.rows def scroll_screen (self): # [r '''Enable scrolling for entire display.''' self.scroll_row_start = 1 self.scroll_row_end = self.rows def scroll_screen_rows (self, rs, re): # [{start};{end}r '''Enable scrolling from row {start} to row {end}.''' self.scroll_row_start = rs self.scroll_row_end = re self.scroll_constrain() def scroll_down (self): # D '''Scroll display down one line.''' # Screen is indexed from 1, but arrays are indexed from 0. s = self.scroll_row_start - 1 e = self.scroll_row_end - 1 self.w[s+1:e+1] = copy.deepcopy(self.w[s:e]) def scroll_up (self): # M '''Scroll display up one line.''' # Screen is indexed from 1, but arrays are indexed from 0. s = self.scroll_row_start - 1 e = self.scroll_row_end - 1 self.w[s:e] = copy.deepcopy(self.w[s+1:e+1]) def erase_end_of_line (self): # [0K -or- [K '''Erases from the current cursor position to the end of the current line.''' self.fill_region (self.cur_r, self.cur_c, self.cur_r, self.cols) def erase_start_of_line (self): # [1K '''Erases from the current cursor position to the start of the current line.''' self.fill_region (self.cur_r, 1, self.cur_r, self.cur_c) def erase_line (self): # [2K '''Erases the entire current line.''' self.fill_region (self.cur_r, 1, self.cur_r, self.cols) def erase_down (self): # [0J -or- [J '''Erases the screen from the current line down to the bottom of the screen.''' self.erase_end_of_line () self.fill_region (self.cur_r + 1, 1, self.rows, self.cols) def erase_up (self): # [1J '''Erases the screen from the current line up to the top of the screen.''' self.erase_start_of_line () self.fill_region (self.cur_r-1, 1, 1, self.cols) def erase_screen (self): # [2J '''Erases the screen with the background color.''' self.fill () def set_tab (self): # H '''Sets a tab at the current position.''' pass def clear_tab (self): # [g '''Clears tab at the current position.''' pass def clear_all_tabs (self): # [3g '''Clears all tabs.''' pass # Insert line Esc [ Pn L # Delete line Esc [ Pn M # Delete character Esc [ Pn P # Scrolling region Esc [ Pn(top);Pn(bot) r pexpect-3.1/pexpect/pxssh.py0000644000175400017540000004260512252463473020341 0ustar takluyvertakluyver00000000000000'''This class extends pexpect.spawn to specialize setting up SSH connections. This adds methods for login, logout, and expecting the shell prompt. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from pexpect import ExceptionPexpect, TIMEOUT, EOF, spawn import time import os __all__ = ['ExceptionPxssh', 'pxssh'] # Exception classes used by this module. class ExceptionPxssh(ExceptionPexpect): '''Raised for pxssh exceptions. ''' class pxssh (spawn): '''This class extends pexpect.spawn to specialize setting up SSH connections. This adds methods for login, logout, and expecting the shell prompt. It does various tricky things to handle many situations in the SSH login process. For example, if the session is your first login, then pxssh automatically accepts the remote certificate; or if you have public key authentication setup then pxssh won't wait for the password prompt. pxssh uses the shell prompt to synchronize output from the remote host. In order to make this more robust it sets the shell prompt to something more unique than just $ or #. This should work on most Borne/Bash or Csh style shells. Example that runs a few commands on a remote server and prints the result:: import pxssh import getpass try: s = pxssh.pxssh() hostname = raw_input('hostname: ') username = raw_input('username: ') password = getpass.getpass('password: ') s.login (hostname, username, password) s.sendline ('uptime') # run a command s.prompt() # match the prompt print s.before # print everything before the prompt. s.sendline ('ls -l') s.prompt() print s.before s.sendline ('df') s.prompt() print s.before s.logout() except pxssh.ExceptionPxssh, e: print "pxssh failed on login." print str(e) Note that if you have ssh-agent running while doing development with pxssh 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 using 'force_password' attribute:: s = pxssh.pxssh() s.force_password = True hostname = raw_input('hostname: ') username = raw_input('username: ') password = getpass.getpass('password: ') s.login (hostname, username, password) ''' def __init__ (self, timeout=30, maxread=2000, searchwindowsize=None, logfile=None, cwd=None, env=None): spawn.__init__(self, None, timeout=timeout, maxread=maxread, searchwindowsize=searchwindowsize, logfile=logfile, cwd=cwd, env=env) self.name = '' #SUBTLE HACK ALERT! Note that the command that SETS the prompt uses a #slightly different string than the regular expression to match it. This #is because when you set the prompt the command will echo back, but we #don't want to match the echoed command. So if we make the set command #slightly different than the regex we eliminate the problem. To make the #set command different we add a backslash in front of $. The $ doesn't #need to be escaped, but it doesn't hurt and serves to make the set #prompt command different than the regex. # used to match the command-line prompt self.UNIQUE_PROMPT = "\[PEXPECT\][\$\#] " self.PROMPT = self.UNIQUE_PROMPT # used to set shell command-line prompt to UNIQUE_PROMPT. self.PROMPT_SET_SH = "PS1='[PEXPECT]\$ '" self.PROMPT_SET_CSH = "set prompt='[PEXPECT]\$ '" self.SSH_OPTS = ("-o'RSAAuthentication=no'" + " -o 'PubkeyAuthentication=no'") # Disabling host key checking, makes you vulnerable to MITM attacks. # + " -o 'StrictHostKeyChecking=no'" # + " -o 'UserKnownHostsFile /dev/null' ") # Disabling X11 forwarding gets rid of the annoying SSH_ASKPASS from # displaying a GUI password dialog. I have not figured out how to # disable only SSH_ASKPASS without also disabling X11 forwarding. # Unsetting SSH_ASKPASS on the remote side doesn't disable it! Annoying! #self.SSH_OPTS = "-x -o'RSAAuthentication=no' -o 'PubkeyAuthentication=no'" self.force_password = False self.auto_prompt_reset = True def levenshtein_distance(self, a,b): '''This calculates the Levenshtein distance between a and b. ''' n, m = len(a), len(b) if n > m: a,b = b,a n,m = m,n current = range(n+1) for i in range(1,m+1): previous, current = current, [i]+[0]*n for j in range(1,n+1): add, delete = previous[j]+1, current[j-1]+1 change = previous[j-1] if a[j-1] != b[i-1]: change = change + 1 current[j] = min(add, delete, change) return current[n] def try_read_prompt(self, timeout_multiplier): '''This facilitates using communication timeouts to perform synchronization as quickly as possible, while supporting high latency connections with a tunable worst case performance. Fast connections should be read almost immediately. Worst case performance for this method is timeout_multiplier * 3 seconds. ''' # maximum time allowed to read the first response first_char_timeout = timeout_multiplier * 0.5 # maximum time allowed between subsequent characters inter_char_timeout = timeout_multiplier * 0.1 # maximum time for reading the entire prompt total_timeout = timeout_multiplier * 3.0 prompt = b'' begin = time.time() expired = 0.0 timeout = first_char_timeout while expired < total_timeout: try: prompt += self.read_nonblocking(size=1, timeout=timeout) expired = time.time() - begin # updated total time expired timeout = inter_char_timeout except TIMEOUT: break return prompt def sync_original_prompt (self, sync_multiplier=1.0): '''This attempts to find the prompt. Basically, press enter and record the response; press enter again and record the response; if the two responses are similar then assume we are at the original prompt. This can be a slow function. Worst case with the default sync_multiplier can take 12 seconds. Low latency connections are more likely to fail with a low sync_multiplier. Best case sync time gets worse with a high sync multiplier (500 ms with default). ''' # All of these timing pace values are magic. # I came up with these based on what seemed reliable for # connecting to a heavily loaded machine I have. self.sendline() time.sleep(0.1) try: # Clear the buffer before getting the prompt. self.try_read_prompt(sync_multiplier) except TIMEOUT: pass self.sendline() x = self.try_read_prompt(sync_multiplier) self.sendline() a = self.try_read_prompt(sync_multiplier) self.sendline() b = self.try_read_prompt(sync_multiplier) ld = self.levenshtein_distance(a,b) len_a = len(a) if len_a == 0: return False if float(ld)/len_a < 0.4: return True return False ### TODO: This is getting messy and I'm pretty sure this isn't perfect. ### TODO: I need to draw a flow chart for this. def login (self,server,username,password='',terminal_type='ansi',original_prompt=r"[#$]",login_timeout=10,port=None,auto_prompt_reset=True,ssh_key=None,quiet=True,sync_multiplier=1,check_local_ip=True): '''This logs the user into the given server. It uses the 'original_prompt' to try to find the prompt right after login. When it finds the prompt it immediately tries to reset the prompt to something more easily matched. The default 'original_prompt' is very optimistic and is easily fooled. It's more reliable to try to match the original prompt as exactly as possible to prevent false matches by server strings such as the "Message Of The Day". On many systems you can disable the MOTD on the remote server by creating a zero-length file called "~/.hushlogin" on the remote server. If a prompt cannot be found then this will not necessarily cause the login to fail. In the case of a timeout when looking for the prompt we assume that the original prompt was so weird that we could not match it, so we use a few tricks to guess when we have reached the prompt. Then we hope for the best and blindly try to reset the prompt to something more unique. If that fails then login() raises an :class:`ExceptionPxssh` exception. In some situations it is not possible or desirable to reset the original prompt. In this case, set :attr:`auto_prompt_reset` to False to inhibit setting the prompt to the UNIQUE_PROMPT. Remember that pxssh uses a unique prompt in the prompt() method. If the original prompt is not reset then this will disable the prompt() method unless you manually set the PROMPT attribute. ''' ssh_options = '' if quiet: ssh_options = ssh_options + ' -q' if not check_local_ip: ssh_options = ssh_options + " -o'NoHostAuthenticationForLocalhost=yes'" if self.force_password: ssh_options = ssh_options + ' ' + self.SSH_OPTS if port is not None: ssh_options = ssh_options + ' -p %s'%(str(port)) if ssh_key is not None: try: os.path.isfile(ssh_key) except: raise ExceptionPxssh ('private ssh key does not exist') ssh_options = ssh_options + ' -i %s' % (ssh_key) cmd = "ssh %s -l %s %s" % (ssh_options, username, server) # This does not distinguish between a remote server 'password' prompt # and a local ssh 'passphrase' prompt (for unlocking a private key). spawn._spawn(self, cmd) i = self.expect(["(?i)are you sure you want to continue connecting", original_prompt, "(?i)(?:password)|(?:passphrase for key)", "(?i)permission denied", "(?i)terminal type", TIMEOUT, "(?i)connection closed by remote host"], timeout=login_timeout) # First phase if i==0: # New certificate -- always accept it. # This is what you get if SSH does not have the remote host's # public key stored in the 'known_hosts' cache. self.sendline("yes") i = self.expect(["(?i)are you sure you want to continue connecting", original_prompt, "(?i)(?:password)|(?:passphrase for key)", "(?i)permission denied", "(?i)terminal type", TIMEOUT]) if i==2: # password or passphrase self.sendline(password) i = self.expect(["(?i)are you sure you want to continue connecting", original_prompt, "(?i)(?:password)|(?:passphrase for key)", "(?i)permission denied", "(?i)terminal type", TIMEOUT]) if i==4: self.sendline(terminal_type) i = self.expect(["(?i)are you sure you want to continue connecting", original_prompt, "(?i)(?:password)|(?:passphrase for key)", "(?i)permission denied", "(?i)terminal type", TIMEOUT]) # Second phase if i==0: # This is weird. This should not happen twice in a row. self.close() raise ExceptionPxssh ('Weird error. Got "are you sure" prompt twice.') elif i==1: # can occur if you have a public key pair set to authenticate. ### TODO: May NOT be OK if expect() got tricked and matched a false prompt. pass elif i==2: # password prompt again # For incorrect passwords, some ssh servers will # ask for the password again, others return 'denied' right away. # If we get the password prompt again then this means # we didn't get the password right the first time. self.close() raise ExceptionPxssh ('password refused') elif i==3: # permission denied -- password was bad. self.close() raise ExceptionPxssh ('permission denied') elif i==4: # terminal type again? WTF? self.close() raise ExceptionPxssh ('Weird error. Got "terminal type" prompt twice.') elif i==5: # Timeout #This is tricky... I presume that we are at the command-line prompt. #It may be that the shell prompt was so weird that we couldn't match #it. Or it may be that we couldn't log in for some other reason. I #can't be sure, but it's safe to guess that we did login because if #I presume wrong and we are not logged in then this should be caught #later when I try to set the shell prompt. pass elif i==6: # Connection closed by remote host self.close() raise ExceptionPxssh ('connection closed') else: # Unexpected self.close() raise ExceptionPxssh ('unexpected login response') if not self.sync_original_prompt(sync_multiplier): self.close() raise ExceptionPxssh ('could not synchronize with original prompt') # We appear to be in. # set shell prompt to something unique. if auto_prompt_reset: if not self.set_unique_prompt(): self.close() raise ExceptionPxssh ('could not set shell prompt\n'+self.before) return True def logout (self): '''This sends exit to the remote shell. If there are stopped jobs then this automatically sends exit twice. ''' self.sendline("exit") index = self.expect([EOF, "(?i)there are stopped jobs"]) if index==1: self.sendline("exit") self.expect(EOF) self.close() def prompt (self, timeout=-1): '''This matches the shell prompt. This is little more than a short-cut to the expect() method. This returns True if the shell prompt was matched. This returns False if a timeout was raised. Note that if you called :meth:`login` with :attr:`auto_prompt_reset` set to False then before calling :meth:`prompt` you must set the :attr:`PROMPT` attribute to a regex that it will use for matching the prompt. 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. ''' if timeout == -1: timeout = self.timeout i = self.expect([self.PROMPT, TIMEOUT], timeout=timeout) if i==1: return False return True def set_unique_prompt (self): '''This sets the remote prompt to something more unique than # or $. This makes it easier for the :meth:`prompt` method to match the shell prompt unambiguously. This method is called automatically by the :meth:`login` method, but you may want to call it manually if you somehow reset the shell prompt. For example, if you 'su' to a different user then you will need to manually reset the prompt. This sends shell commands to the remote host to set the prompt, so this assumes the remote host is ready to receive commands. Alternatively, you may use your own prompt pattern. Just set the PROMPT attribute to a regular expression that matches it. In this case you should call login() with auto_prompt_reset=False; then set the PROMPT attribute. After that the prompt() method will try to match your prompt pattern.''' self.sendline ("unset PROMPT_COMMAND") self.sendline (self.PROMPT_SET_SH) # sh-style i = self.expect ([TIMEOUT, self.PROMPT], timeout=10) if i == 0: # csh-style self.sendline (self.PROMPT_SET_CSH) i = self.expect ([TIMEOUT, self.PROMPT], timeout=10) if i == 0: return False return True # vi:ts=4:sw=4:expandtab:ft=python: pexpect-3.1/examples/0000755000175400017540000000000012270016336016751 5ustar takluyvertakluyver00000000000000pexpect-3.1/examples/astat.py0000755000175400017540000000550212267623031020446 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This runs Apache Status on the remote host and returns the number of requests per second. ./astat.py [-s server_hostname] [-u username] [-p password] -s : hostname of the remote server to login to. -u : username to user for login. -p : Password to user for login. Example: This will print information about the given host: ./astat.py -s www.example.com -u mylogin -p mypassword PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import import os, sys, time, re, getopt, getpass import pexpect, pxssh try: raw_input except NameError: raw_input = input def exit_with_usage(): print(globals()['__doc__']) os._exit(1) def main(): ###################################################################### ## Parse the options, arguments, get ready, etc. ###################################################################### try: optlist, args = getopt.getopt(sys.argv[1:], 'h?s:u:p:', ['help','h','?']) except Exception as e: print(str(e)) exit_with_usage() options = dict(optlist) if len(args) > 1: exit_with_usage() if [elem for elem in options if elem in ['-h','--h','-?','--?','--help']]: print("Help:") exit_with_usage() if '-s' in options: hostname = options['-s'] else: hostname = raw_input('hostname: ') if '-u' in options: username = options['-u'] else: username = raw_input('username: ') if '-p' in options: password = options['-p'] else: password = getpass.getpass('password: ') # # Login via SSH # p = pxssh.pxssh() p.login(hostname, username, password) p.sendline('apachectl status') p.expect('([0-9]+\.[0-9]+)\s*requests/sec') requests_per_second = p.match.groups()[0] p.logout() print(requests_per_second) if __name__ == "__main__": main() pexpect-3.1/examples/table_test.html0000644000175400017540000000764012216111566021775 0ustar takluyvertakluyver00000000000000 TEST
/ h o m e / n o a h /  
pexpect-3.1/examples/uptime.py0000755000175400017540000000707212227101142020627 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This displays uptime information using uptime. This is redundant, but it demonstrates expecting for a regular expression that uses subgroups. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import absolute_import from __future__ import print_function from __future__ import unicode_literals import pexpect import re # There are many different styles of uptime results. I try to parse them all. Yeee! # Examples from different machines: # [x86] Linux 2.4 (Redhat 7.3) # 2:06pm up 63 days, 18 min, 3 users, load average: 0.32, 0.08, 0.02 # [x86] Linux 2.4.18-14 (Redhat 8.0) # 3:07pm up 29 min, 1 user, load average: 2.44, 2.51, 1.57 # [PPC - G4] MacOS X 10.1 SERVER Edition # 2:11PM up 3 days, 13:50, 3 users, load averages: 0.01, 0.00, 0.00 # [powerpc] Darwin v1-58.corefa.com 8.2.0 Darwin Kernel Version 8.2.0 # 10:35 up 18:06, 4 users, load averages: 0.52 0.47 0.36 # [Sparc - R220] Sun Solaris (8) # 2:13pm up 22 min(s), 1 user, load average: 0.02, 0.01, 0.01 # [x86] Linux 2.4.18-14 (Redhat 8) # 11:36pm up 4 days, 17:58, 1 user, load average: 0.03, 0.01, 0.00 # AIX jwdir 2 5 0001DBFA4C00 # 09:43AM up 23:27, 1 user, load average: 0.49, 0.32, 0.23 # OpenBSD box3 2.9 GENERIC#653 i386 # 6:08PM up 4 days, 22:26, 1 user, load averages: 0.13, 0.09, 0.08 # Note that, for Python 3 compatibility reasons, we are using spawnu and # importing unicode_literals (above). spawnu accepts Unicode input and # unicode_literals makes all string literals in this script Unicode by default. p = pexpect.spawnu('uptime') # This parses uptime output into the major groups using regex group matching. p.expect('up\s+(.*?),\s+([0-9]+) users?,\s+load averages?: ([0-9]+\.[0-9][0-9]),?\s+([0-9]+\.[0-9][0-9]),?\s+([0-9]+\.[0-9][0-9])') duration, users, av1, av5, av15 = p.match.groups() # The duration is a little harder to parse because of all the different # styles of uptime. I'm sure there is a way to do this all at once with # one single regex, but I bet it would be hard to read and maintain. # If anyone wants to send me a version using a single regex I'd be happy to see it. days = '0' hours = '0' mins = '0' if 'day' in duration: p.match = re.search('([0-9]+)\s+day',duration) days = str(int(p.match.group(1))) if ':' in duration: p.match = re.search('([0-9]+):([0-9]+)',duration) hours = str(int(p.match.group(1))) mins = str(int(p.match.group(2))) if 'min' in duration: p.match = re.search('([0-9]+)\s+min',duration) mins = str(int(p.match.group(1))) # Print the parsed fields in CSV format. print('days, hours, minutes, users, cpu avg 1 min, cpu avg 5 min, cpu avg 15 min') print('%s, %s, %s, %s, %s, %s, %s' % (days, hours, mins, users, av1, av5, av15)) pexpect-3.1/examples/script.py0000755000175400017540000000737712267623031020652 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This spawns a sub-shell (bash) and gives the user interactive control. The entire shell session is logged to a file called script.log. This behaves much like the classic BSD command 'script'. ./script.py [-a] [-c command] {logfilename} logfilename : This is the name of the log file. Default is script.log. -a : Append to log file. Default is to overwrite log file. -c : spawn command. Default is to spawn the sh shell. Example: This will start a bash shell and append to the log named my_session.log: ./script.py -a -c bash my_session.log PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import import os, sys, time, getopt import signal, fcntl, termios, struct import pexpect global_pexpect_instance = None # Used by signal handler def exit_with_usage(): print(globals()['__doc__']) os._exit(1) def main(): ###################################################################### # Parse the options, arguments, get ready, etc. ###################################################################### try: optlist, args = getopt.getopt(sys.argv[1:], 'h?ac:', ['help','h','?']) except Exception as e: print(str(e)) exit_with_usage() options = dict(optlist) if len(args) > 1: exit_with_usage() if [elem for elem in options if elem in ['-h','--h','-?','--?','--help']]: print("Help:") exit_with_usage() if len(args) == 1: script_filename = args[0] else: script_filename = "script.log" if '-a' in options: fout = open(script_filename, "ab") else: fout = open(script_filename, "wb") if '-c' in options: command = options['-c'] else: command = "sh" # Begin log with date/time in the form CCCCyymm.hhmmss fout.write ('# %4d%02d%02d.%02d%02d%02d \n' % time.localtime()[:-3]) ###################################################################### # Start the interactive session ###################################################################### p = pexpect.spawn(command) p.logfile = fout global global_pexpect_instance global_pexpect_instance = p signal.signal(signal.SIGWINCH, sigwinch_passthrough) print("Script recording started. Type ^] (ASCII 29) to escape from the script shell.") p.interact(chr(29)) fout.close() return 0 def sigwinch_passthrough (sig, data): # Check for buggy platforms (see pexpect.setwinsize()). if 'TIOCGWINSZ' in dir(termios): TIOCGWINSZ = termios.TIOCGWINSZ else: TIOCGWINSZ = 1074295912 # assume s = struct.pack ("HHHH", 0, 0, 0, 0) a = struct.unpack ('HHHH', fcntl.ioctl(sys.stdout.fileno(), TIOCGWINSZ , s)) global global_pexpect_instance global_pexpect_instance.setwinsize(a[0],a[1]) if __name__ == "__main__": main() pexpect-3.1/examples/passmass.py0000755000175400017540000000760612267623031021173 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''Change passwords on the named machines. passmass host1 host2 host3 . . . Note that login shell prompt on remote machine must end in # or $. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import import pexpect import sys, getpass try: raw_input except NameError: raw_input = input USAGE = '''passmass host1 host2 host3 . . .''' COMMAND_PROMPT = '[$#] ' TERMINAL_PROMPT = r'Terminal type\?' TERMINAL_TYPE = 'vt100' SSH_NEWKEY = r'Are you sure you want to continue connecting \(yes/no\)\?' def login(host, user, password): child = pexpect.spawn('ssh -l %s %s'%(user, host)) fout = file ("LOG.TXT","wb") child.setlog (fout) i = child.expect([pexpect.TIMEOUT, SSH_NEWKEY, '[Pp]assword: ']) if i == 0: # Timeout print('ERROR!') print('SSH could not login. Here is what SSH said:') print(child.before, child.after) sys.exit (1) if i == 1: # SSH does not have the public key. Just accept it. child.sendline ('yes') child.expect ('[Pp]assword: ') child.sendline(password) # Now we are either at the command prompt or # the login process is asking for our terminal type. i = child.expect (['Permission denied', TERMINAL_PROMPT, COMMAND_PROMPT]) if i == 0: print('Permission denied on host:', host) sys.exit (1) if i == 1: child.sendline (TERMINAL_TYPE) child.expect (COMMAND_PROMPT) return child # (current) UNIX password: def change_password(child, user, oldpassword, newpassword): child.sendline('passwd') i = child.expect(['[Oo]ld [Pp]assword', '.current.*password', '[Nn]ew [Pp]assword']) # Root does not require old password, so it gets to bypass the next step. if i == 0 or i == 1: child.sendline(oldpassword) child.expect('[Nn]ew [Pp]assword') child.sendline(newpassword) i = child.expect(['[Nn]ew [Pp]assword', '[Rr]etype', '[Rr]e-enter']) if i == 0: print('Host did not like new password. Here is what it said...') print(child.before) child.send (chr(3)) # Ctrl-C child.sendline('') # This should tell remote passwd command to quit. return child.sendline(newpassword) def main(): if len(sys.argv) <= 1: print(USAGE) return 1 user = raw_input('Username: ') password = getpass.getpass('Current Password: ') newpassword = getpass.getpass('New Password: ') newpasswordconfirm = getpass.getpass('Confirm New Password: ') if newpassword != newpasswordconfirm: print('New Passwords do not match.') return 1 for host in sys.argv[1:]: child = login(host, user, password) if child == None: print('Could not login to host:', host) continue print('Changing password on host:', host) change_password(child, user, password, newpassword) child.expect(COMMAND_PROMPT) child.sendline('exit') if __name__ == '__main__': main() pexpect-3.1/examples/monitor.py0000755000175400017540000001641512267623031021026 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' This runs a sequence of commands on a remote host using SSH. It runs a simple system checks such as uptime and free to monitor the state of the remote host. ./monitor.py [-s server_hostname] [-u username] [-p password] -s : hostname of the remote server to login to. -u : username to user for login. -p : Password to user for login. Example: This will print information about the given host: ./monitor.py -s www.example.com -u mylogin -p mypassword It works like this: Login via SSH (This is the hardest part). Run and parse 'uptime'. Run 'iostat'. Run 'vmstat'. Run 'netstat' Run 'free'. Exit the remote host. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import import os, sys, re, getopt, getpass import pexpect try: raw_input except NameError: raw_input = input # # Some constants. # COMMAND_PROMPT = '[#$] ' ### This is way too simple for industrial use -- we will change is ASAP. TERMINAL_PROMPT = '(?i)terminal type\?' TERMINAL_TYPE = 'vt100' # This is the prompt we get if SSH does not have the remote host's public key stored in the cache. SSH_NEWKEY = '(?i)are you sure you want to continue connecting' def exit_with_usage(): print(globals()['__doc__']) os._exit(1) def main(): global COMMAND_PROMPT, TERMINAL_PROMPT, TERMINAL_TYPE, SSH_NEWKEY ###################################################################### ## Parse the options, arguments, get ready, etc. ###################################################################### try: optlist, args = getopt.getopt(sys.argv[1:], 'h?s:u:p:', ['help','h','?']) except Exception as e: print(str(e)) exit_with_usage() options = dict(optlist) if len(args) > 1: exit_with_usage() if [elem for elem in options if elem in ['-h','--h','-?','--?','--help']]: print("Help:") exit_with_usage() if '-s' in options: host = options['-s'] else: host = raw_input('hostname: ') if '-u' in options: user = options['-u'] else: user = raw_input('username: ') if '-p' in options: password = options['-p'] else: password = getpass.getpass('password: ') # # Login via SSH # child = pexpect.spawn('ssh -l %s %s'%(user, host)) i = child.expect([pexpect.TIMEOUT, SSH_NEWKEY, COMMAND_PROMPT, '(?i)password']) if i == 0: # Timeout print('ERROR! could not login with SSH. Here is what SSH said:') print(child.before, child.after) print(str(child)) sys.exit (1) if i == 1: # In this case SSH does not have the public key cached. child.sendline ('yes') child.expect ('(?i)password') if i == 2: # This may happen if a public key was setup to automatically login. # But beware, the COMMAND_PROMPT at this point is very trivial and # could be fooled by some output in the MOTD or login message. pass if i == 3: child.sendline(password) # Now we are either at the command prompt or # the login process is asking for our terminal type. i = child.expect ([COMMAND_PROMPT, TERMINAL_PROMPT]) if i == 1: child.sendline (TERMINAL_TYPE) child.expect (COMMAND_PROMPT) # # Set command prompt to something more unique. # COMMAND_PROMPT = "\[PEXPECT\]\$ " child.sendline ("PS1='[PEXPECT]\$ '") # In case of sh-style i = child.expect ([pexpect.TIMEOUT, COMMAND_PROMPT], timeout=10) if i == 0: print("# Couldn't set sh-style prompt -- trying csh-style.") child.sendline ("set prompt='[PEXPECT]\$ '") i = child.expect ([pexpect.TIMEOUT, COMMAND_PROMPT], timeout=10) if i == 0: print("Failed to set command prompt using sh or csh style.") print("Response was:") print(child.before) sys.exit (1) # Now we should be at the command prompt and ready to run some commands. print('---------------------------------------') print('Report of commands run on remote host.') print('---------------------------------------') # Run uname. child.sendline ('uname -a') child.expect (COMMAND_PROMPT) print(child.before) if 'linux' in child.before.lower(): LINUX_MODE = 1 else: LINUX_MODE = 0 # Run and parse 'uptime'. child.sendline ('uptime') child.expect('up\s+(.*?),\s+([0-9]+) users?,\s+load averages?: ([0-9]+\.[0-9][0-9]),?\s+([0-9]+\.[0-9][0-9]),?\s+([0-9]+\.[0-9][0-9])') duration, users, av1, av5, av15 = child.match.groups() days = '0' hours = '0' mins = '0' if 'day' in duration: child.match = re.search('([0-9]+)\s+day',duration) days = str(int(child.match.group(1))) if ':' in duration: child.match = re.search('([0-9]+):([0-9]+)',duration) hours = str(int(child.match.group(1))) mins = str(int(child.match.group(2))) if 'min' in duration: child.match = re.search('([0-9]+)\s+min',duration) mins = str(int(child.match.group(1))) print() print('Uptime: %s days, %s users, %s (1 min), %s (5 min), %s (15 min)' % ( duration, users, av1, av5, av15)) child.expect (COMMAND_PROMPT) # Run iostat. child.sendline ('iostat') child.expect (COMMAND_PROMPT) print(child.before) # Run vmstat. child.sendline ('vmstat') child.expect (COMMAND_PROMPT) print(child.before) # Run free. if LINUX_MODE: child.sendline ('free') # Linux systems only. child.expect (COMMAND_PROMPT) print(child.before) # Run df. child.sendline ('df') child.expect (COMMAND_PROMPT) print(child.before) # Run lsof. child.sendline ('lsof') child.expect (COMMAND_PROMPT) print(child.before) # # Run netstat # child.sendline ('netstat') # child.expect (COMMAND_PROMPT) # print child.before # # Run MySQL show status. # child.sendline ('mysql -p -e "SHOW STATUS;"') # child.expect (PASSWORD_PROMPT_MYSQL) # child.sendline (password_mysql) # child.expect (COMMAND_PROMPT) # print # print child.before # Now exit the remote host. child.sendline ('exit') index = child.expect([pexpect.EOF, "(?i)there are stopped jobs"]) if index==1: child.sendline("exit") child.expect(EOF) if __name__ == "__main__": main() pexpect-3.1/examples/python.py0000755000175400017540000000355012227101142020642 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This starts the python interpreter; captures the startup message; then gives the user interactive control over the session. Why? For fun... PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import absolute_import from __future__ import print_function from __future__ import unicode_literals import pexpect # Don't do this unless you like being John Malkovich # c = pexpect.spawnu('/usr/bin/env python ./python.py') # Note that, for Python 3 compatibility reasons, we are using spawnu and # importing unicode_literals (above). spawnu accepts Unicode input and # unicode_literals makes all string literals in this script Unicode by default. c = pexpect.spawnu('/usr/bin/env python') c.expect('>>>') print('And now for something completely different...') print(''.join(reversed((c.before)))) print('Yes, it\'s python, but it\'s backwards.') print() print('Escape character is \'^]\'.') print(c.after, end=' ') c.interact() c.kill(1) print('is alive:', c.isalive()) pexpect-3.1/examples/ssh_tunnel.py0000755000175400017540000000663512227101142021512 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This starts an SSH tunnel to a given host. If the SSH process ever dies then this script will detect that and restart it. I use this under Cygwin to keep open encrypted tunnels to port 25 (SMTP), port 143 (IMAP4), and port 110 (POP3). I set my mail client to talk to localhost and I keep this script running in the background. Note that this is a rather stupid script at the moment because it just looks to see if any ssh process is running. It should really make sure that our specific ssh process is running. The problem is that ssh is missing a very useful feature. It has no way to report the process id of the background daemon that it creates with the -f command. This would be a really useful script if I could figure a way around this problem. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import import pexpect import getpass import time try: raw_input except NameError: raw_input = input # SMTP:25 IMAP4:143 POP3:110 tunnel_command = 'ssh -C -N -f -L 25:127.0.0.1:25 -L 143:127.0.0.1:143 -L 110:127.0.0.1:110 %(user)@%(host)' host = raw_input('Hostname: ') user = raw_input('Username: ') X = getpass.getpass('Password: ') def get_process_info (): # This seems to work on both Linux and BSD, but should otherwise be considered highly UNportable. ps = pexpect.run ('ps ax -O ppid') pass def start_tunnel (): try: ssh_tunnel = pexpect.spawn (tunnel_command % globals()) ssh_tunnel.expect ('password:') time.sleep (0.1) ssh_tunnel.sendline (X) time.sleep (60) # Cygwin is slow to update process status. ssh_tunnel.expect (pexpect.EOF) except Exception as e: print(str(e)) def main (): while True: ps = pexpect.spawn ('ps') time.sleep (1) index = ps.expect (['/usr/bin/ssh', pexpect.EOF, pexpect.TIMEOUT]) if index == 2: print('TIMEOUT in ps command...') print(str(ps)) time.sleep (13) if index == 1: print(time.asctime(), end=' ') print('restarting tunnel') start_tunnel () time.sleep (11) print('tunnel OK') else: # print 'tunnel OK' time.sleep (7) if __name__ == '__main__': main () # This was for older SSH versions that didn't have -f option #tunnel_command = 'ssh -C -n -L 25:%(host)s:25 -L 110:%(host)s:110 %(user)s@%(host)s -f nothing.sh' #nothing_script = '''#!/bin/sh #while true; do sleep 53; done #''' pexpect-3.1/examples/ftp.py0000755000175400017540000000550312227101142020112 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This demonstrates an FTP "bookmark". This connects to an ftp site; does a few ftp stuff; and then gives the user interactive control over the session. In this case the "bookmark" is to a directory on the OpenBSD ftp server. It puts you in the i386 packages directory. You can easily modify this for other sites. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import absolute_import from __future__ import print_function from __future__ import unicode_literals import pexpect import sys # Note that, for Python 3 compatibility reasons, we are using spawnu and # importing unicode_literals (above). spawnu accepts Unicode input and # unicode_literals makes all string literals in this script Unicode by default. child = pexpect.spawnu('ftp ftp.openbsd.org') child.expect('(?i)name .*: ') child.sendline('anonymous') child.expect('(?i)password') child.sendline('pexpect@sourceforge.net') child.expect('ftp> ') child.sendline('cd /pub/OpenBSD/3.7/packages/i386') child.expect('ftp> ') child.sendline('bin') child.expect('ftp> ') child.sendline('prompt') child.expect('ftp> ') child.sendline('pwd') child.expect('ftp> ') print("Escape character is '^]'.\n") sys.stdout.write (child.after) sys.stdout.flush() child.interact() # Escape character defaults to ^] # At this point this script blocks until the user presses the escape character # or until the child exits. The human user and the child should be talking # to each other now. # At this point the script is running again. print('Left interactve mode.') # The rest is not strictly necessary. This just demonstrates a few functions. # This makes sure the child is dead; although it would be killed when Python exits. if child.isalive(): child.sendline('bye') # Try to ask ftp child to exit. child.close() # Print the final state of the child. Normally isalive() should be FALSE. if child.isalive(): print('Child did not exit gracefully.') else: print('Child exited gracefully.') pexpect-3.1/examples/df.py0000755000175400017540000000366512227101142017721 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This collects filesystem capacity info using the 'df' command. Tuples of filesystem name and percentage are stored in a list. A simple report is printed. Filesystems over 95% capacity are highlighted. Note that this does not parse filesystem names after the first space, so names with spaces in them will be truncated. This will produce ambiguous results for automount filesystems on Apple OSX. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import import pexpect child = pexpect.spawn ('df') # parse 'df' output into a list. pattern = "\n(\S+).*?([0-9]+)%" filesystem_list = [] for dummy in range (0, 1000): i = child.expect ([pattern, pexpect.EOF]) if i == 0: filesystem_list.append (child.match.groups()) else: break # Print report print() for m in filesystem_list: s = "Filesystem %s is at %s%%" % (m[0], m[1]) # highlight filesystems over 95% capacity if int(m[1]) > 95: s = '! ' + s else: s = ' ' + s print(s) pexpect-3.1/examples/topip.py0000755000175400017540000002444712267623031020476 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' This runs netstat on a local or remote server. It calculates some simple statistical information on the number of external inet connections. It groups by IP address. This can be used to detect if one IP address is taking up an excessive number of connections. It can also send an email alert if a given IP address exceeds a threshold between runs of the script. This script can be used as a drop-in Munin plugin or it can be used stand-alone from cron. I used this on a busy web server that would sometimes get hit with denial of service attacks. This made it easy to see if a script was opening many multiple connections. A typical browser would open fewer than 10 connections at once. A script might open over 100 simultaneous connections. ./topip.py [-s server_hostname] [-u username] [-p password] {-a from_addr,to_addr} {-n N} {-v} {--ipv6} -s : hostname of the remote server to login to. -u : username to user for login. -p : password to user for login. -n : print stddev for the the number of the top 'N' ipaddresses. -v : verbose - print stats and list of top ipaddresses. -a : send alert if stddev goes over 20. -l : to log message to /var/log/topip.log --ipv6 : this parses netstat output that includes ipv6 format. Note that this actually only works with ipv4 addresses, but for versions of netstat that print in ipv6 format. --stdev=N : Where N is an integer. This sets the trigger point for alerts and logs. Default is to trigger if the max value is over 5 standard deviations. Example: This will print stats for the top IP addresses connected to the given host: ./topip.py -s www.example.com -u mylogin -p mypassword -n 10 -v This will send an alert email if the maxip goes over the stddev trigger value and the the current top ip is the same as the last top ip (/tmp/topip.last): ./topip.py -s www.example.com -u mylogin -p mypassword \\ -n 10 -v -a alert@example.com,user@example.com This will print the connection stats for the localhost in Munin format: ./topip.py PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import absolute_import from __future__ import print_function from __future__ import unicode_literals # See http://pexpect.sourceforge.net/ import pexpect import pxssh import os import sys import time import getopt import pickle import getpass import smtplib from pprint import pprint try: raw_input except NameError: raw_input = input TOPIP_LOG_FILE = '/var/log/topip.log' TOPIP_LAST_RUN_STATS = '/var/run/topip.last' def exit_with_usage(): print(globals()['__doc__']) os._exit(1) def stats(r): '''This returns a dict of the median, average, standard deviation, min and max of the given sequence. >>> from topip import stats >>> print stats([5,6,8,9]) {'med': 8, 'max': 9, 'avg': 7.0, 'stddev': 1.5811388300841898, 'min': 5} >>> print stats([1000,1006,1008,1014]) {'med': 1008, 'max': 1014, 'avg': 1007.0, 'stddev': 5.0, 'min': 1000} >>> print stats([1,3,4,5,18,16,4,3,3,5,13]) {'med': 4, 'max': 18, 'avg': 6.8181818181818183, 'stddev': 5.6216817577237475, 'min': 1} >>> print stats([1,3,4,5,18,16,4,3,3,5,13,14,5,6,7,8,7,6,6,7,5,6,4,14,7]) {'med': 6, 'max': 18, 'avg': 7.0800000000000001, 'stddev': 4.3259218670706474, 'min': 1} ''' total = sum(r) avg = float(total)/float(len(r)) sdsq = sum([(i-avg)**2 for i in r]) s = sorted(list(r)) return dict(list(zip(['med', 'avg', 'stddev', 'min', 'max'], (s[len(s)//2], avg, (sdsq/len(r))**.5, min(r), max(r))))) def send_alert (message, subject, addr_from, addr_to, smtp_server='localhost'): '''This sends an email alert. ''' message = ( 'From: %s\r\nTo: %s\r\nSubject: %s\r\n\r\n' % (addr_from, addr_to, subject) + message ) server = smtplib.SMTP(smtp_server) server.sendmail(addr_from, addr_to, message) server.quit() def main(): # Parse the options, arguments, etc. try: optlist, args = getopt.getopt(sys.argv[1:], 'h?valqs:u:p:n:', ['help','h','?','ipv6','stddev=']) except Exception as e: print(str(e)) exit_with_usage() options = dict(optlist) munin_flag = False if len(args) > 0: if args[0] == 'config': print('graph_title Netstat Connections per IP') print('graph_vlabel Socket connections per IP') print('connections_max.label max') print('connections_max.info Maximum number of connections per IP') print('connections_avg.label avg') print('connections_avg.info Average number of connections per IP') print('connections_stddev.label stddev') print('connections_stddev.info Standard deviation') return 0 elif args[0] != '': print(args, len(args)) return 0 exit_with_usage() if [elem for elem in options if elem in ['-h','--h','-?','--?','--help']]: print('Help:') exit_with_usage() if '-s' in options: hostname = options['-s'] else: # if host was not specified then assume localhost munin plugin. munin_flag = True hostname = 'localhost' # If localhost then don't ask for username/password. if hostname != 'localhost' and hostname != '127.0.0.1': if '-u' in options: username = options['-u'] else: username = raw_input('username: ') if '-p' in options: password = options['-p'] else: password = getpass.getpass('password: ') use_localhost = False else: use_localhost = True if '-l' in options: log_flag = True else: log_flag = False if '-n' in options: average_n = int(options['-n']) else: average_n = None if '-v' in options: verbose = True else: verbose = False if '-a' in options: alert_flag = True (alert_addr_from, alert_addr_to) = tuple(options['-a'].split(',')) else: alert_flag = False if '--ipv6' in options: ipv6_flag = True else: ipv6_flag = False if '--stddev' in options: stddev_trigger = float(options['--stddev']) else: stddev_trigger = 5 if ipv6_flag: netstat_pattern = '(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+::ffff:(\S+):(\S+)\s+.*?\r' else: netstat_pattern = '(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(?:::ffff:)*(\S+):(\S+)\s+.*?\r' #netstat_pattern = '(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+):(\S+)\s+.*?\r' # run netstat (either locally or via SSH). if use_localhost: p = pexpect.spawn('netstat -n -t') PROMPT = pexpect.TIMEOUT else: p = pxssh.pxssh() p.login(hostname, username, password) p.sendline('netstat -n -t') PROMPT = p.PROMPT # For each matching netstat_pattern put the ip address in the list. ip_list = {} try: while 1: i = p.expect([PROMPT, netstat_pattern]) if i == 0: break k = p.match.groups()[4].decode('utf-8') if k in ip_list: ip_list[k] = ip_list[k] + 1 else: ip_list[k] = 1 except: pass # remove a few common, uninteresting addresses from the dictionary. ip_list = dict([ (key,value) for key,value in ip_list.items() if '192.168.' not in key]) ip_list = dict([ (key,value) for key,value in ip_list.items() if '127.0.0.1' not in key]) ip_list = list(ip_list.items()) if len(ip_list) < 1: if verbose: print('Warning: no networks connections worth looking at.') return 0 ip_list.sort(key=lambda x:x[1]) # generate some stats for the ip addresses found. if average_n is not None and average_n <= 1: average_n = None # Reminder: the * unary operator treats the list elements as arguments. zipped = zip(*ip_list[0:average_n]) s = stats(list(zipped)[1]) s['maxip'] = ip_list[0] # print munin-style or verbose results for the stats. if munin_flag: print('connections_max.value', s['max']) print('connections_avg.value', s['avg']) print('connections_stddev.value', s['stddev']) return 0 if verbose: pprint (s) print() pprint (ip_list[0:average_n]) # load the stats from the last run. try: last_stats = pickle.load(file(TOPIP_LAST_RUN_STATS)) except: last_stats = {'maxip':None} if ( s['maxip'][1] > (s['stddev'] * stddev_trigger) and s['maxip']==last_stats['maxip'] ): if verbose: print('The maxip has been above trigger for two consecutive samples.') if alert_flag: if verbose: print('SENDING ALERT EMAIL') send_alert(str(s), 'ALERT on %s' % hostname, alert_addr_from, alert_addr_to) if log_flag: if verbose: print('LOGGING THIS EVENT') fout = file(TOPIP_LOG_FILE,'a') #dts = time.strftime('%Y:%m:%d:%H:%M:%S', time.localtime()) dts = time.asctime() fout.write ('%s - %d connections from %s\n' % (dts,s['maxip'][1],str(s['maxip'][0]))) fout.close() # save state to TOPIP_LAST_RUN_STATS try: pickle.dump(s, file(TOPIP_LAST_RUN_STATS,'w')) os.chmod (TOPIP_LAST_RUN_STATS, 0o664) except: pass # p.logout() if __name__ == '__main__': main() pexpect-3.1/examples/hive.py0000755000175400017540000004254612267623031020276 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''hive -- Hive Shell This lets you ssh to a group of servers and control them as if they were one. Each command you enter is sent to each host in parallel. The response of each host is collected and printed. In normal synchronous mode Hive will wait for each host to return the shell command line prompt. The shell prompt is used to sync output. Example: $ hive.py --sameuser --samepass host1.example.com host2.example.net username: myusername password: connecting to host1.example.com - OK connecting to host2.example.net - OK targetting hosts: 192.168.1.104 192.168.1.107 CMD (? for help) > uptime ======================================================================= host1.example.com ----------------------------------------------------------------------- uptime 23:49:55 up 74 days, 5:14, 2 users, load average: 0.15, 0.05, 0.01 ======================================================================= host2.example.net ----------------------------------------------------------------------- uptime 23:53:02 up 1 day, 13:36, 2 users, load average: 0.50, 0.40, 0.46 ======================================================================= Other Usage Examples: 1. You will be asked for your username and password for each host. hive.py host1 host2 host3 ... hostN 2. You will be asked once for your username and password. This will be used for each host. hive.py --sameuser --samepass host1 host2 host3 ... hostN 3. Give a username and password on the command-line: hive.py user1:pass2@host1 user2:pass2@host2 ... userN:passN@hostN You can use an extended host notation to specify username, password, and host instead of entering auth information interactively. Where you would enter a host name use this format: username:password@host This assumes that ':' is not part of the password. If your password contains a ':' then you can use '\\:' to indicate a ':' and '\\\\' to indicate a single '\\'. Remember that this information will appear in the process listing. Anyone on your machine can see this auth information. This is not secure. This is a crude script that begs to be multithreaded. But it serves its purpose. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import # TODO add feature to support username:password@host combination # TODO add feature to log each host output in separate file import sys import os import re import optparse import types import time import getpass import readline import atexit try: import pexpect import pxssh except ImportError: sys.stderr.write("You do not have 'pexpect' installed.\n") sys.stderr.write("On Ubuntu you need the 'python-pexpect' package.\n") sys.stderr.write(" aptitude -y install python-pexpect\n") exit(1) try: raw_input except NameError: raw_input = input histfile = os.path.join(os.environ["HOME"], ".hive_history") try: readline.read_history_file(histfile) except IOError: pass atexit.register(readline.write_history_file, histfile) CMD_HELP='''Hive commands are preceded by a colon : (just think of vi). :target name1 name2 name3 ... set list of hosts to target commands :target all reset list of hosts to target all hosts in the hive. :to name command send a command line to the named host. This is similar to :target, but sends only one command and does not change the list of targets for future commands. :sync set mode to wait for shell prompts after commands are run. This is the default. When Hive first logs into a host it sets a special shell prompt pattern that it can later look for to synchronize output of the hosts. If you 'su' to another user then it can upset the synchronization. If you need to run something like 'su' then use the following pattern: CMD (? for help) > :async CMD (? for help) > sudo su - root CMD (? for help) > :prompt CMD (? for help) > :sync :async set mode to not expect command line prompts (see :sync). Afterwards commands are send to target hosts, but their responses are not read back until :sync is run. This is useful to run before commands that will not return with the special shell prompt pattern that Hive uses to synchronize. :refresh refresh the display. This shows the last few lines of output from all hosts. This is similar to resync, but does not expect the promt. This is useful for seeing what hosts are doing during long running commands. :resync This is similar to :sync, but it does not change the mode. It looks for the prompt and thus consumes all input from all targetted hosts. :prompt force each host to reset command line prompt to the special pattern used to synchronize all the hosts. This is useful if you 'su' to a different user where Hive would not know the prompt to match. :send my text This will send the 'my text' wihtout a line feed to the targetted hosts. This output of the hosts is not automatically synchronized. :control X This will send the given control character to the targetted hosts. For example, ":control c" will send ASCII 3. :exit This will exit the hive shell. ''' def login (args, cli_username=None, cli_password=None): # I have to keep a separate list of host names because Python dicts are not ordered. # I want to keep the same order as in the args list. host_names = [] hive_connect_info = {} hive = {} # build up the list of connection information (hostname, username, password, port) for host_connect_string in args: hcd = parse_host_connect_string (host_connect_string) hostname = hcd['hostname'] port = hcd['port'] if port == '': port = None if len(hcd['username']) > 0: username = hcd['username'] elif cli_username is not None: username = cli_username else: username = raw_input('%s username: ' % hostname) if len(hcd['password']) > 0: password = hcd['password'] elif cli_password is not None: password = cli_password else: password = getpass.getpass('%s password: ' % hostname) host_names.append(hostname) hive_connect_info[hostname] = (hostname, username, password, port) # build up the list of hive connections using the connection information. for hostname in host_names: print('connecting to', hostname) try: fout = file("log_"+hostname, "w") hive[hostname] = pxssh.pxssh() # Disable host key checking. hive[hostname].SSH_OPTS = (hive[hostname].SSH_OPTS + " -o 'StrictHostKeyChecking=no'" + " -o 'UserKnownHostsFile /dev/null' ") hive[hostname].force_password = True hive[hostname].login(*hive_connect_info[hostname]) print(hive[hostname].before) hive[hostname].logfile = fout print('- OK') except Exception as e: print('- ERROR', end=' ') print(str(e)) print('Skipping', hostname) hive[hostname] = None return host_names, hive def main (): global options, args, CMD_HELP rows = 24 cols = 80 if options.sameuser: cli_username = raw_input('username: ') else: cli_username = None if options.samepass: cli_password = getpass.getpass('password: ') else: cli_password = None host_names, hive = login(args, cli_username, cli_password) synchronous_mode = True target_hostnames = host_names[:] print('targetting hosts:', ' '.join(target_hostnames)) while True: cmd = raw_input('CMD (? for help) > ') cmd = cmd.strip() if cmd=='?' or cmd==':help' or cmd==':h': print(CMD_HELP) continue elif cmd==':refresh': refresh (hive, target_hostnames, timeout=0.5) for hostname in target_hostnames: print('/' + '=' * (cols - 2)) print('| ' + hostname) print('\\' + '-' * (cols - 2)) if hive[hostname] is None: print('# DEAD: %s' % hostname) else: print(hive[hostname].before) print('#' * 79) continue elif cmd==':resync': resync (hive, target_hostnames, timeout=0.5) for hostname in target_hostnames: print('/' + '=' * (cols - 2)) print('| ' + hostname) print('\\' + '-' * (cols - 2)) if hive[hostname] is None: print('# DEAD: %s' % hostname) else: print(hive[hostname].before) print('#' * 79) continue elif cmd==':sync': synchronous_mode = True resync (hive, target_hostnames, timeout=0.5) continue elif cmd==':async': synchronous_mode = False continue elif cmd==':prompt': for hostname in target_hostnames: try: if hive[hostname] is not None: hive[hostname].set_unique_prompt() except Exception as e: print("Had trouble communicating with %s, so removing it from the target list." % hostname) print(str(e)) hive[hostname] = None continue elif cmd[:5] == ':send': cmd, txt = cmd.split(None,1) for hostname in target_hostnames: try: if hive[hostname] is not None: hive[hostname].send(txt) except Exception as e: print("Had trouble communicating with %s, so removing it from the target list." % hostname) print(str(e)) hive[hostname] = None continue elif cmd[:3] == ':to': cmd, hostname, txt = cmd.split(None,2) print('/' + '=' * (cols - 2)) print('| ' + hostname) print('\\' + '-' * (cols - 2)) if hive[hostname] is None: print('# DEAD: %s' % hostname) continue try: hive[hostname].sendline (txt) hive[hostname].prompt(timeout=2) print(hive[hostname].before) except Exception as e: print("Had trouble communicating with %s, so removing it from the target list." % hostname) print(str(e)) hive[hostname] = None continue elif cmd[:7] == ':expect': cmd, pattern = cmd.split(None,1) print('looking for', pattern) try: for hostname in target_hostnames: if hive[hostname] is not None: hive[hostname].expect(pattern) print(hive[hostname].before) except Exception as e: print("Had trouble communicating with %s, so removing it from the target list." % hostname) print(str(e)) hive[hostname] = None continue elif cmd[:7] == ':target': target_hostnames = cmd.split()[1:] if len(target_hostnames) == 0 or target_hostnames[0] == all: target_hostnames = host_names[:] print('targetting hosts:', ' '.join(target_hostnames)) continue elif cmd == ':exit' or cmd == ':q' or cmd == ':quit': break elif cmd[:8] == ':control' or cmd[:5] == ':ctrl' : cmd, c = cmd.split(None,1) if ord(c)-96 < 0 or ord(c)-96 > 255: print('/' + '=' * (cols - 2)) print('| Invalid character. Must be [a-zA-Z], @, [, ], \\, ^, _, or ?') print('\\' + '-' * (cols - 2)) continue for hostname in target_hostnames: try: if hive[hostname] is not None: hive[hostname].sendcontrol(c) except Exception as e: print("Had trouble communicating with %s, so removing it from the target list." % hostname) print(str(e)) hive[hostname] = None continue elif cmd == ':esc': for hostname in target_hostnames: if hive[hostname] is not None: hive[hostname].send(chr(27)) continue # # Run the command on all targets in parallel # for hostname in target_hostnames: try: if hive[hostname] is not None: hive[hostname].sendline (cmd) except Exception as e: print("Had trouble communicating with %s, so removing it from the target list." % hostname) print(str(e)) hive[hostname] = None # # print the response for each targeted host. # if synchronous_mode: for hostname in target_hostnames: try: print('/' + '=' * (cols - 2)) print('| ' + hostname) print('\\' + '-' * (cols - 2)) if hive[hostname] is None: print('# DEAD: %s' % hostname) else: hive[hostname].prompt(timeout=2) print(hive[hostname].before) except Exception as e: print("Had trouble communicating with %s, so removing it from the target list." % hostname) print(str(e)) hive[hostname] = None print('#' * 79) def refresh (hive, hive_names, timeout=0.5): '''This waits for the TIMEOUT on each host. ''' # TODO This is ideal for threading. for hostname in hive_names: if hive[hostname] is not None: hive[hostname].expect([pexpect.TIMEOUT,pexpect.EOF],timeout=timeout) def resync (hive, hive_names, timeout=2, max_attempts=5): '''This waits for the shell prompt for each host in an effort to try to get them all to the same state. The timeout is set low so that hosts that are already at the prompt will not slow things down too much. If a prompt match is made for a hosts then keep asking until it stops matching. This is a best effort to consume all input if it printed more than one prompt. It's kind of kludgy. Note that this will always introduce a delay equal to the timeout for each machine. So for 10 machines with a 2 second delay you will get AT LEAST a 20 second delay if not more. ''' # TODO This is ideal for threading. for hostname in hive_names: if hive[hostname] is not None: for attempts in range(0, max_attempts): if not hive[hostname].prompt(timeout=timeout): break def parse_host_connect_string (hcs): '''This parses a host connection string in the form username:password@hostname:port. All fields are options expcet hostname. A dictionary is returned with all four keys. Keys that were not included are set to empty strings ''. Note that if your password has the '@' character then you must backslash escape it. ''' if '@' in hcs: p = re.compile (r'(?P[^@:]*)(:?)(?P.*)(?!\\)@(?P[^:]*):?(?P[0-9]*)') else: p = re.compile (r'(?P)(?P)(?P[^:]*):?(?P[0-9]*)') m = p.search (hcs) d = m.groupdict() d['password'] = d['password'].replace('\\@','@') return d if __name__ == '__main__': start_time = time.time() parser = optparse.OptionParser(formatter=optparse.TitledHelpFormatter(), usage=globals()['__doc__'], version='$Id: hive.py 533 2012-10-20 02:19:33Z noah $',conflict_handler="resolve") parser.add_option ('-v', '--verbose', action='store_true', default=False, help='verbose output') parser.add_option ('--samepass', action='store_true', default=False, help='Use same password for each login.') parser.add_option ('--sameuser', action='store_true', default=False, help='Use same username for each login.') (options, args) = parser.parse_args() if len(args) < 1: parser.error ('missing argument') if options.verbose: print(time.asctime()) main() if options.verbose: print(time.asctime()) if options.verbose: print('TOTAL TIME IN MINUTES:', end=' ') if options.verbose: print((time.time() - start_time) / 60.0) pexpect-3.1/examples/chess3.py0000755000175400017540000001136312227101142020512 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This demonstrates controlling a screen oriented application (curses). It starts two instances of gnuchess and then pits them against each other. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import import pexpect import string import ANSI REGEX_MOVE = '(?:[a-z]|\x1b\[C)(?:[0-9]|\x1b\[C)(?:[a-z]|\x1b\[C)(?:[0-9]|\x1b\[C)' REGEX_MOVE_PART = '(?:[0-9]|\x1b\[C)(?:[a-z]|\x1b\[C)(?:[0-9]|\x1b\[C)' class Chess: def __init__(self, engine = "/usr/local/bin/gnuchess -a -h 1"): self.child = pexpect.spawn (engine) self.term = ANSI.ANSI () # self.child.expect ('Chess') # if self.child.after != 'Chess': # raise IOError, 'incompatible chess program' # self.term.process_list (self.before) # self.term.process_list (self.after) self.last_computer_move = '' def read_until_cursor (self, r,c): fout = open ('log','a') while 1: k = self.child.read(1, 10) self.term.process (k) fout.write ('(r,c):(%d,%d)\n' %(self.term.cur_r, self.term.cur_c)) fout.flush() if self.term.cur_r == r and self.term.cur_c == c: fout.close() return 1 sys.stdout.write (k) sys.stdout.flush() def do_scan (self): fout = open ('log','a') while 1: c = self.child.read(1,10) self.term.process (c) fout.write ('(r,c):(%d,%d)\n' %(self.term.cur_r, self.term.cur_c)) fout.flush() sys.stdout.write (c) sys.stdout.flush() def do_move (self, move): self.read_until_cursor (19,60) self.child.sendline (move) return move def get_computer_move (self): print('Here') i = self.child.expect (['\[17;59H', '\[17;58H']) print(i) if i == 0: self.child.expect (REGEX_MOVE) if len(self.child.after) < 4: self.child.after = self.child.after + self.last_computer_move[3] if i == 1: self.child.expect (REGEX_MOVE_PART) self.child.after = self.last_computer_move[0] + self.child.after print('', self.child.after) self.last_computer_move = self.child.after return self.child.after def switch (self): self.child.sendline ('switch') def set_depth (self, depth): self.child.sendline ('depth') self.child.expect ('depth=') self.child.sendline ('%d' % depth) def quit(self): self.child.sendline ('quit') import sys, os print('Starting...') white = Chess() white.do_move('b2b4') white.read_until_cursor (19,60) c1 = white.term.get_abs(17,58) c2 = white.term.get_abs(17,59) c3 = white.term.get_abs(17,60) c4 = white.term.get_abs(17,61) fout = open ('log','a') fout.write ('Computer:%s%s%s%s\n' %(c1,c2,c3,c4)) fout.close() white.do_move('c2c4') white.read_until_cursor (19,60) c1 = white.term.get_abs(17,58) c2 = white.term.get_abs(17,59) c3 = white.term.get_abs(17,60) c4 = white.term.get_abs(17,61) fout = open ('log','a') fout.write ('Computer:%s%s%s%s\n' %(c1,c2,c3,c4)) fout.close() white.do_scan () #white.do_move ('b8a6') #move_white = white.get_computer_move() #print 'move white:', move_white sys.exit(1) black = Chess() white = Chess() white.child.expect ('Your move is') white.switch() move_white = white.get_first_computer_move() print('first move white:', move_white) black.do_first_move (move_white) move_black = black.get_first_computer_move() print('first move black:', move_black) white.do_move (move_black) done = 0 while not done: move_white = white.get_computer_move() print('move white:', move_white) black.do_move (move_white) move_black = black.get_computer_move() print('move black:', move_black) white.do_move (move_black) print('tail of loop') g.quit() pexpect-3.1/examples/chess2.py0000755000175400017540000001163412227101142020512 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This demonstrates controlling a screen oriented application (curses). It starts two instances of gnuchess and then pits them against each other. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import import pexpect import string import ANSI import sys, os, time class Chess: def __init__(self, engine = "/usr/local/bin/gnuchess -a -h 1"): self.child = pexpect.spawn (engine) self.term = ANSI.ANSI () #self.child.expect ('Chess') #if self.child.after != 'Chess': # raise IOError, 'incompatible chess program' #self.term.process_list (self.child.before) #self.term.process_list (self.child.after) self.last_computer_move = '' def read_until_cursor (self, r,c, e=0): '''Eventually something like this should move into the screen class or a subclass. Maybe a combination of pexpect and screen... ''' fout = open ('log','a') while self.term.cur_r != r or self.term.cur_c != c: try: k = self.child.read(1, 10) except Exception as e: print('EXCEPTION, (r,c):(%d,%d)\n' %(self.term.cur_r, self.term.cur_c)) sys.stdout.flush() self.term.process (k) fout.write ('(r,c):(%d,%d)\n' %(self.term.cur_r, self.term.cur_c)) fout.flush() if e: sys.stdout.write (k) sys.stdout.flush() if self.term.cur_r == r and self.term.cur_c == c: fout.close() return 1 print('DIDNT EVEN HIT.') fout.close() return 1 def expect_region (self): '''This is another method that would be moved into the screen class. ''' pass def do_scan (self): fout = open ('log','a') while 1: c = self.child.read(1,10) self.term.process (c) fout.write ('(r,c):(%d,%d)\n' %(self.term.cur_r, self.term.cur_c)) fout.flush() sys.stdout.write (c) sys.stdout.flush() def do_move (self, move, e = 0): time.sleep(1) self.read_until_cursor (19,60, e) self.child.sendline (move) def wait (self, color): while 1: r = self.term.get_region (14,50,14,60)[0] r = r.strip() if r == color: return time.sleep (1) def parse_computer_move (self, s): i = s.find ('is: ') cm = s[i+3:i+9] return cm def get_computer_move (self, e = 0): time.sleep(1) self.read_until_cursor (19,60, e) time.sleep(1) r = self.term.get_region (17,50,17,62)[0] cm = self.parse_computer_move (r) return cm def switch (self): print('switching') self.child.sendline ('switch') def set_depth (self, depth): self.child.sendline ('depth') self.child.expect ('depth=') self.child.sendline ('%d' % depth) def quit(self): self.child.sendline ('quit') def LOG (s): print(s) sys.stdout.flush () fout = open ('moves.log', 'a') fout.write (s + '\n') fout.close() print('Starting...') black = Chess() white = Chess() white.read_until_cursor (19,60,1) white.switch() done = 0 while not done: white.wait ('Black') move_white = white.get_computer_move(1) LOG ( 'move white:'+ move_white ) black.do_move (move_white) black.wait ('White') move_black = black.get_computer_move() LOG ( 'move black:'+ move_black ) white.do_move (move_black, 1) g.quit() pexpect-3.1/examples/cgishell.cgi0000755000175400017540000006047612227101142021237 0ustar takluyvertakluyver00000000000000#!/usr/bin/python ##!/usr/bin/env python """CGI shell server This exposes a shell terminal on a web page. It uses AJAX to send keys and receive screen updates. The client web browser needs nothing but CSS and Javascript. --hostname : sets the remote host name to open an ssh connection to. --username : sets the user name to login with --password : (optional) sets the password to login with --port : set the local port for the server to listen on --watch : show the virtual screen after each client request This project is probably not the most security concious thing I've ever built. This should be considered an experimental tool -- at best. """ from __future__ import absolute_import from __future__ import print_function import sys,os sys.path.insert (0,os.getcwd()) # let local modules precede any installed modules import socket, random, string, traceback, cgi, time, getopt, getpass, threading, resource, signal import pxssh, pexpect, ANSI def exit_with_usage(exit_code=1): print(globals()['__doc__']) os._exit(exit_code) def client (command, host='localhost', port=-1): """This sends a request to the server and returns the response. If port <= 0 then host is assumed to be the filename of a Unix domain socket. If port > 0 then host is an inet hostname. """ if port <= 0: s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) s.connect(host) else: s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) s.connect((host, port)) s.send(command) data = s.recv (2500) s.close() return data def server (hostname, username, password, socket_filename='/tmp/server_sock', daemon_mode = True, verbose=False): """This starts and services requests from a client. If daemon_mode is True then this forks off a separate daemon process and returns the daemon's pid. If daemon_mode is False then this does not return until the server is done. """ if daemon_mode: mypid_name = '/tmp/%d.pid' % os.getpid() daemon_pid = daemonize(daemon_pid_filename=mypid_name) time.sleep(1) if daemon_pid != 0: os.unlink(mypid_name) return daemon_pid virtual_screen = ANSI.ANSI (24,80) child = pxssh.pxssh() try: child.login (hostname, username, password, login_naked=True) except: return if verbose: print('login OK') virtual_screen.write (child.before) virtual_screen.write (child.after) if os.path.exists(socket_filename): os.remove(socket_filename) s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) s.bind(socket_filename) os.chmod(socket_filename, 0o777) if verbose: print('Listen') s.listen(1) r = roller (endless_poll, (child, child.PROMPT, virtual_screen)) r.start() if verbose: print("started screen-poll-updater in background thread") sys.stdout.flush() try: while True: conn, addr = s.accept() if verbose: print('Connected by', addr) data = conn.recv(1024) request = data.split(' ', 1) if len(request)>1: cmd = request[0].strip() arg = request[1].strip() else: cmd = request[0].strip() arg = '' if cmd == 'exit': r.cancel() break elif cmd == 'sendline': child.sendline (arg) time.sleep(0.1) shell_window = str(virtual_screen) elif cmd == 'send' or cmd=='xsend': if cmd=='xsend': arg = arg.decode("hex") child.send (arg) time.sleep(0.1) shell_window = str(virtual_screen) elif cmd == 'cursor': shell_window = '%x,%x' % (virtual_screen.cur_r, virtual_screen.cur_c) elif cmd == 'refresh': shell_window = str(virtual_screen) elif cmd == 'hash': shell_window = str(hash(str(virtual_screen))) response = [] response.append (shell_window) if verbose: print('\n'.join(response)) sent = conn.send('\n'.join(response)) if sent < len (response): if verbose: print("Sent is too short. Some data was cut off.") conn.close() except e: pass r.cancel() if verbose: print("cleaning up socket") s.close() if os.path.exists(socket_filename): os.remove(socket_filename) if verbose: print("server done!") class roller (threading.Thread): """This class continuously loops a function in a thread. This is basically a thin layer around Thread with a while loop and a cancel. """ def __init__(self, function, args=[], kwargs={}): threading.Thread.__init__(self) self.function = function self.args = args self.kwargs = kwargs self.finished = threading.Event() def cancel(self): """Stop the roller.""" self.finished.set() def run(self): while not self.finished.isSet(): self.function(*self.args, **self.kwargs) def endless_poll (child, prompt, screen, refresh_timeout=0.1): """This keeps the screen updated with the output of the child. This will be run in a separate thread. See roller class. """ #child.logfile_read = screen try: s = child.read_nonblocking(4000, 0.1) screen.write(s) except: pass def daemonize (stdin=None, stdout=None, stderr=None, daemon_pid_filename=None): """This runs the current process in the background as a daemon. The arguments stdin, stdout, stderr allow you to set the filename that the daemon reads and writes to. If they are set to None then all stdio for the daemon will be directed to /dev/null. If daemon_pid_filename is set then the pid of the daemon will be written to it as plain text and the pid will be returned. If daemon_pid_filename is None then this will return None. """ UMASK = 0 WORKINGDIR = "/" MAXFD = 1024 # The stdio file descriptors are redirected to /dev/null by default. if hasattr(os, "devnull"): DEVNULL = os.devnull else: DEVNULL = "/dev/null" if stdin is None: stdin = DEVNULL if stdout is None: stdout = DEVNULL if stderr is None: stderr = DEVNULL try: pid = os.fork() except OSError as e: raise Exception("%s [%d]" % (e.strerror, e.errno)) if pid != 0: # The first child. os.waitpid(pid,0) if daemon_pid_filename is not None: daemon_pid = int(file(daemon_pid_filename,'r').read()) return daemon_pid else: return None # first child os.setsid() signal.signal(signal.SIGHUP, signal.SIG_IGN) try: pid = os.fork() # fork second child except OSError as e: raise Exception("%s [%d]" % (e.strerror, e.errno)) if pid != 0: if daemon_pid_filename is not None: file(daemon_pid_filename,'w').write(str(pid)) os._exit(0) # exit parent (the first child) of the second child. # second child os.chdir(WORKINGDIR) os.umask(UMASK) maxfd = resource.getrlimit(resource.RLIMIT_NOFILE)[1] if maxfd == resource.RLIM_INFINITY: maxfd = MAXFD # close all file descriptors for fd in range(0, maxfd): try: os.close(fd) except OSError: # fd wasn't open to begin with (ignored) pass os.open (DEVNULL, os.O_RDWR) # standard input # redirect standard file descriptors si = open(stdin, 'r') so = open(stdout, 'a+') se = open(stderr, 'a+', 0) os.dup2(si.fileno(), sys.stdin.fileno()) os.dup2(so.fileno(), sys.stdout.fileno()) os.dup2(se.fileno(), sys.stderr.fileno()) return 0 def client_cgi (): """This handles the request if this script was called as a cgi. """ sys.stderr = sys.stdout ajax_mode = False TITLE="Shell" SHELL_OUTPUT="" SID="NOT" print("Content-type: text/html;charset=utf-8\r\n") try: form = cgi.FieldStorage() if 'ajax' in form: ajax_mode = True ajax_cmd = form['ajax'].value SID=form['sid'].value if ajax_cmd == 'send': command = 'xsend' arg = form['arg'].value.encode('hex') result = client (command + ' ' + arg, '/tmp/'+SID) print(result) elif ajax_cmd == 'refresh': command = 'refresh' result = client (command, '/tmp/'+SID) print(result) elif ajax_cmd == 'cursor': command = 'cursor' result = client (command, '/tmp/'+SID) print(result) elif ajax_cmd == 'exit': command = 'exit' result = client (command, '/tmp/'+SID) print(result) elif ajax_cmd == 'hash': command = 'hash' result = client (command, '/tmp/'+SID) print(result) elif 'sid' not in form: SID=random_sid() print(LOGIN_HTML % locals()); else: SID=form['sid'].value if 'start_server' in form: USERNAME = form['username'].value PASSWORD = form['password'].value dpid = server ('127.0.0.1', USERNAME, PASSWORD, '/tmp/'+SID) SHELL_OUTPUT="daemon pid: " + str(dpid) else: if 'cli' in form: command = 'sendline ' + form['cli'].value else: command = 'sendline' SHELL_OUTPUT = client (command, '/tmp/'+SID) print(CGISH_HTML % locals()) except: tb_dump = traceback.format_exc() if ajax_mode: print(str(tb_dump)) else: SHELL_OUTPUT=str(tb_dump) print(CGISH_HTML % locals()) def server_cli(): """This is the command line interface to starting the server. This handles things if the script was not called as a CGI (if you run it from the command line). """ try: optlist, args = getopt.getopt(sys.argv[1:], 'h?d', ['help','h','?', 'hostname=', 'username=', 'password=', 'port=', 'watch']) except Exception as e: print(str(e)) exit_with_usage() command_line_options = dict(optlist) options = dict(optlist) # There are a million ways to cry for help. These are but a few of them. if [elem for elem in command_line_options if elem in ['-h','--h','-?','--?','--help']]: exit_with_usage(0) hostname = "127.0.0.1" #port = 1664 username = os.getenv('USER') password = "" daemon_mode = False if '-d' in options: daemon_mode = True if '--watch' in options: watch_mode = True else: watch_mode = False if '--hostname' in options: hostname = options['--hostname'] if '--port' in options: port = int(options['--port']) if '--username' in options: username = options['--username'] if '--password' in options: password = options['--password'] else: password = getpass.getpass('password: ') server (hostname, username, password, '/tmp/mysock', daemon_mode) def random_sid (): a=random.randint(0,65535) b=random.randint(0,65535) return '%04x%04x.sid' % (a,b) def parse_host_connect_string (hcs): """This parses a host connection string in the form username:password@hostname:port. All fields are options expcet hostname. A dictionary is returned with all four keys. Keys that were not included are set to empty strings ''. Note that if your password has the '@' character then you must backslash escape it. """ if '@' in hcs: p = re.compile (r'(?P[^@:]*)(:?)(?P.*)(?!\\)@(?P[^:]*):?(?P[0-9]*)') else: p = re.compile (r'(?P)(?P)(?P[^:]*):?(?P[0-9]*)') m = p.search (hcs) d = m.groupdict() d['password'] = d['password'].replace('\\@','@') return d def pretty_box (s, rows=24, cols=80): """This puts an ASCII text box around the given string. """ top_bot = '+' + '-'*cols + '+\n' return top_bot + '\n'.join(['|'+line+'|' for line in s.split('\n')]) + '\n' + top_bot def main (): if os.getenv('REQUEST_METHOD') is None: server_cli() else: client_cgi() # It's mostly HTML and Javascript from here on out. CGISH_HTML=""" %(TITLE)s %(SID)s
 
""" LOGIN_HTML=""" Shell Login
username:
password:

""" if __name__ == "__main__": try: main() except Exception as e: print(str(e)) tb_dump = traceback.format_exc() print(str(tb_dump)) pexpect-3.1/examples/README0000644000175400017540000000777212216111566017647 0ustar takluyvertakluyver00000000000000This directory contains scripts that give examples of using Pexpect. hive.py This script creates SSH connections to a list of hosts that you provide. Then you are given a command line prompt. Each shell command that you enter is sent to all the hosts. The response from each host is collected and printed. For example, you could connect to a dozen different machines and reboot them all at once. script.py This implements a command similar to the classic BSD "script" command. This will start a subshell and log all input and output to a file. This demonstrates the interact() method of Pexpect. fix_cvs_files.py This is for cleaning up binary files improperly added to CVS. This script scans the given path to find binary files; checks with CVS to see if the sticky options are set to -kb; finally if sticky options are not -kb then uses 'cvs admin' to set the -kb option. ftp.py This demonstrates an FTP "bookmark". This connects to an ftp site; does a few ftp commands; and then gives the user interactive control over the session. In this case the "bookmark" is to a directory on the OpenBSD ftp server. It puts you in the i386 packages directory. You can easily modify this for other sites. This demonstrates the interact() method of Pexpect. monitor.py This runs a sequence of system status commands on a remote host using SSH. It runs a simple system checks such as uptime and free to monitor the state of the remote host. passmass.py This will login to a list of hosts and change the password of the given user. This demonstrates scripting logins; although, you could more easily do this using the pxssh subclass of Pexpect. See also the "hive.py" example script for a more general example of scripting a collection of servers. python.py This starts the python interpreter and prints the greeting message backwards. It then gives the user interactive control of Python. It's pretty useless! rippy.py This is a wizard for mencoder. It greatly simplifies the process of ripping a DVD to mpeg4 format (XviD, DivX). It can transcode from any video file to another. It has options for resampling the audio stream; removing interlace artifacts, fitting to a target file size, etc. There are lots of options, but the process is simple and easy to use. sshls.py This lists a directory on a remote machine. ssh_tunnel.py This starts an SSH tunnel to a remote machine. It monitors the connection and restarts the tunnel if it goes down. uptime.py This will run the uptime command and parse the output into python variables. This demonstrates using a single regular expression to match the output of a command and capturing different variable in match groups. The regular expression takes into account a wide variety of different formats for uptime output. df.py This collects filesystem capacity info using the 'df' command. Tuples of filesystem name and percentage are stored in a list. A simple report is printed. Filesystems over 95% capacity are highlighted. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. pexpect-3.1/examples/chess.py0000755000175400017540000001062512227101142020427 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This demonstrates controlling a screen oriented application (curses). It starts two instances of gnuchess and then pits them against each other. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import absolute_import import pexpect import string import ANSI REGEX_MOVE = '(?:[a-z]|\x1b\[C)(?:[0-9]|\x1b\[C)(?:[a-z]|\x1b\[C)(?:[0-9]|\x1b\[C)' REGEX_MOVE_PART = '(?:[0-9]|\x1b\[C)(?:[a-z]|\x1b\[C)(?:[0-9]|\x1b\[C)' class Chess: def __init__(self, engine = "/usr/local/bin/gnuchess -a -h 1"): self.child = pexpect.spawn (engine) self.term = ANSI.ANSI () self.child.expect ('Chess') if self.child.after != 'Chess': raise IOError('incompatible chess program') self.term.process_list (self.before) self.term.process_list (self.after) self.last_computer_move = '' def read_until_cursor (self, r,c): while 1: self.child.read(1, 60) self.term.process (c) if self.term.cur_r == r and self.term.cur_c == c: return 1 def do_first_move (self, move): self.child.expect ('Your move is') self.child.sendline (move) self.term.process_list (self.before) self.term.process_list (self.after) return move def do_move (self, move): self.read_until_cursor (19,60) self.child.sendline (move) return move def get_first_computer_move (self): self.child.expect ('My move is') self.child.expect (REGEX_MOVE) return self.child.after def get_computer_move (self): print('Here') i = self.child.expect (['\[17;59H', '\[17;58H']) print(i) if i == 0: self.child.expect (REGEX_MOVE) if len(self.child.after) < 4: self.child.after = self.child.after + self.last_computer_move[3] if i == 1: self.child.expect (REGEX_MOVE_PART) self.child.after = self.last_computer_move[0] + self.child.after print('', self.child.after) self.last_computer_move = self.child.after return self.child.after def switch (self): self.child.sendline ('switch') def set_depth (self, depth): self.child.sendline ('depth') self.child.expect ('depth=') self.child.sendline ('%d' % depth) def quit(self): self.child.sendline ('quit') import sys, os print('Starting...') white = Chess() white.child.echo = 1 white.child.expect ('Your move is') white.set_depth(2) white.switch() move_white = white.get_first_computer_move() print('first move white:', move_white) white.do_move ('e7e5') move_white = white.get_computer_move() print('move white:', move_white) white.do_move ('f8c5') move_white = white.get_computer_move() print('move white:', move_white) white.do_move ('b8a6') move_white = white.get_computer_move() print('move white:', move_white) sys.exit(1) black = Chess() white = Chess() white.child.expect ('Your move is') white.switch() move_white = white.get_first_computer_move() print('first move white:', move_white) black.do_first_move (move_white) move_black = black.get_first_computer_move() print('first move black:', move_black) white.do_move (move_black) done = 0 while not done: move_white = white.get_computer_move() print('move white:', move_white) black.do_move (move_white) move_black = black.get_computer_move() print('move black:', move_black) white.do_move (move_black) print('tail of loop') g.quit() pexpect-3.1/tests/0000755000175400017540000000000012270016336016275 5ustar takluyvertakluyver00000000000000pexpect-3.1/tests/test_winsize.py0000755000175400017540000000500112227101142021365 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import PexpectTestCase import time class TestCaseWinsize(PexpectTestCase.PexpectTestCase): def test_winsize (self): ''' This tests that the child process can set and get the windows size. This makes use of an external script sigwinch_report.py. ''' p1 = pexpect.spawn('%s sigwinch_report.py' % self.PYTHONBIN) p1.expect('READY', timeout=10) p1.setwinsize (11,22) index = p1.expect ([pexpect.TIMEOUT, b'SIGWINCH: \(([0-9]*), ([0-9]*)\)'], timeout=30) if index == 0: self.fail("TIMEOUT -- this platform may not support sigwinch properly.\n" + str(p1)) self.assertEqual(p1.match.group(1, 2), (b"11" ,b"22")) self.assertEqual(p1.getwinsize(), (11, 22)) time.sleep(1) p1.setwinsize (24,80) index = p1.expect ([pexpect.TIMEOUT, b'SIGWINCH: \(([0-9]*), ([0-9]*)\)'], timeout=10) if index == 0: self.fail ("TIMEOUT -- this platform may not support sigwinch properly.\n" + str(p1)) self.assertEqual(p1.match.group(1, 2), (b"24" ,b"80")) self.assertEqual(p1.getwinsize(), (24, 80)) p1.close() # def test_parent_resize (self): # pid = os.getpid() # p1 = pexpect.spawn('%s sigwinch_report.py' % self.PYTHONBIN) # time.sleep(10) # p1.setwinsize (11,22) # os.kill (pid, signal.SIGWINCH) if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(TestCaseWinsize,'test') pexpect-3.1/tests/swapcase_echo.py0000755000175400017540000000217112220666300021454 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import sys, time while True: x = raw_input () time.sleep(1) # without this delay the test would fail about 75% of the time. Why? print(x.swapcase()) sys.stdout.flush() pexpect-3.1/tests/echo_w_prompt.py0000644000175400017540000000027712221113726021517 0ustar takluyvertakluyver00000000000000# -*- coding: utf-8 -*- from __future__ import print_function try: raw_input except NameError: raw_input = input while True: a = raw_input('') print('', a, sep='')pexpect-3.1/tests/test_FSM.py0000644000175400017540000000153012232544730020334 0ustar takluyvertakluyver00000000000000import io import sys import unittest try: import builtins except ImportError: import __builtin__ as builtins PY3 = (sys.version_info[0] >= 3) input_name = 'input' if PY3 else 'raw_input' from pexpect import FSM class FSMTestCase(unittest.TestCase): def test_run_fsm(self): def _input(prompt): return "167 3 2 2 * * * 1 - =" orig_input = getattr(builtins, input_name) orig_stdout = sys.stdout setattr(builtins, input_name, _input) sys.stdout = sio = (io.StringIO if PY3 else io.BytesIO)() try: FSM.main() finally: setattr(builtins, input_name, orig_input) sys.stdout = orig_stdout printed = sio.getvalue() assert '2003' in printed, printed if __name__ == '__main__': unittest.main()pexpect-3.1/tests/test_misc.py0000755000175400017540000003201712235764377020667 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import PexpectTestCase import os, sys import re import signal import time # the program cat(1) may display ^D\x08\x08 when \x04 (EOF, Ctrl-D) is sent _CAT_EOF = b'^D\x08\x08' class TestCaseMisc(PexpectTestCase.PexpectTestCase): def test_isatty (self): child = pexpect.spawn('cat') assert child.isatty(), "Not returning True. Should always be True." def test_read (self): child = pexpect.spawn('cat') child.sendline ("abc") child.sendeof() self.assertEqual(child.read(0), b'') self.assertEqual(child.read(1), b'a') self.assertEqual(child.read(1), b'b') self.assertEqual(child.read(1), b'c') self.assertEqual(child.read(2), b'\r\n') remaining = child.read().replace(_CAT_EOF, b'') self.assertEqual(remaining, b'abc\r\n') def test_readline (self): '''See the note in test_readlines() for an explaination as to why I allow line3 and line4 to return multiple patterns. Basically, this is done to handle a valid condition on slow systems. ''' child = pexpect.spawn('cat') child.sendline ("abc") time.sleep(0.5) child.sendline ("123") time.sleep(0.5) child.sendeof() line1 = child.readline(0) line2 = child.readline() line3 = child.readline(2) line4 = child.readline(1) line5 = child.readline() time.sleep(1) # time for child to "complete" ;/ assert not child.isalive(), child.isalive() assert child.exitstatus == 0, child.exitstatus self.assertEqual(line1, b'') self.assertEqual(line2, b'abc\r\n') assert (line3 == b'abc\r\n' or line3 == b'123\r\n'), line3 assert (line4 == b'123\r\n' or line4 == b'abc\r\n'), line4 self.assertEqual(line5, b'123\r\n') def test_iter (self): '''See the note in test_readlines() for an explaination as to why I allow line3 and line4 to return multiple patterns. Basically, this is done to handle a valid condition on slow systems. ''' child = pexpect.spawn('cat') child.sendline ("abc") time.sleep(0.5) child.sendline ("123") time.sleep(0.5) child.sendeof() # Don't use ''.join() because we want to test the ITERATOR. page = b'' for line in child: page += line page = page.replace(_CAT_EOF, b'') # This is just a really bad test all together, we should write our # own 'cat' utility that only writes to stdout after EOF is recv, # this must take into consideration all possible platform impl.'s # of `cat', and their related terminal and line-buffer handling assert (page == b'abc\r\nabc\r\n123\r\n123\r\n' or page == b'abc\r\n123\r\nabc\r\n123\r\n' or page == b'abc\r\n123abc\r\n\r\n123\r\n') , \ "iterator did not work. page=%r"(page,) def test_readlines(self): '''Note that on some slow or heavily loaded systems that the lines coming back from 'cat' may come even after the EOF. We except to see two copies of the lines we send 'cat'. The first line is the TTY echo, the second line is from 'cat'. Usually 'cat' will respond with 'abc' before we have a chance to send the second line, '123'. If this does not happen then the lines may appear out of order. This is technically not an error. That's just the nature of asynchronous communication. This is why the assert will allow either of the two possible patterns to be returned by lineslined(). The (lame) alternative is to put a long sleep between the two sendline() calls, but then I have to make assumptions about how fast 'cat' can reply. ''' child = pexpect.spawn('cat') child.sendline ("abc") time.sleep(0.5) child.sendline ("123") time.sleep(0.5) child.sendeof() page = b''.join(child.readlines()).replace(_CAT_EOF, b'') assert (page == b'abc\r\nabc\r\n123\r\n123\r\n' or page == b'abc\r\n123\r\nabc\r\n123\r\n'), ( "readlines() did not work. page=%r" % (page,)) time.sleep(1) # time for child to "complete" ;/ assert not child.isalive(), child.isalive() assert child.exitstatus == 0, child.exitstatus def test_write (self): child = pexpect.spawn('cat') child.write('a') child.write('\r') self.assertEqual(child.readline(), b'a\r\n') def test_writelines (self): child = pexpect.spawn('cat') child.writelines(['abc','123','xyz','\r']) child.sendeof() line = child.readline() assert line == b'abc123xyz\r\n', ( "writelines() did not work. line=%r" % (line,)) def test_eof(self): child = pexpect.spawn('cat') child.sendeof() try: child.expect ('the unexpected') except: pass assert child.eof(), "child.eof() did not return True" def test_terminate(self): child = pexpect.spawn('cat') child.terminate(force=1) assert child.terminated, "child.terminated is not True" def test_sighup(self): # If a parent process sets an Ignore handler for SIGHUP (as on Fedora's # build machines), this test breaks. We temporarily restore the default # handler, so the child process will quit. However, we can't simply # replace any installed handler, because getsignal returns None for # handlers not set in Python code, so we wouldn't be able to restore # them. if signal.getsignal(signal.SIGHUP) == signal.SIG_IGN: signal.signal(signal.SIGHUP, signal.SIG_DFL) restore_sig_ign = True else: restore_sig_ign = False try: child = pexpect.spawn(sys.executable + ' getch.py', ignore_sighup=True) child.expect('READY') child.kill(signal.SIGHUP) for _ in range(10): if not child.isalive(): raise AssertionError('Child should not have exited.') time.sleep(0.1) child = pexpect.spawn(sys.executable + ' getch.py', ignore_sighup=False) child.expect('READY') child.kill(signal.SIGHUP) for _ in range(10): if not child.isalive(): break time.sleep(0.1) else: raise AssertionError('Child should have exited.') finally: if restore_sig_ign: signal.signal(signal.SIGHUP, signal.SIG_IGN) def test_bad_child_pid(self): child = pexpect.spawn('cat') child.terminate(force=1) child.terminated = 0 # Force invalid state to test code try: child.isalive() except pexpect.ExceptionPexpect: pass else: self.fail ("child.isalive() should have raised a pexpect.ExceptionPexpect") child.terminated = 1 # Force back to valid state so __del__ won't complain def test_bad_arguments (self): '''This tests that we get a graceful error when passing bad arguments.''' try: p = pexpect.spawn(1) except pexpect.ExceptionPexpect: pass else: self.fail ("pexpect.spawn(1) should have raised a pexpect.ExceptionPexpect.") try: p = pexpect.spawn('ls', '-la') # should really use pexpect.spawn('ls', ['-ls']) except TypeError: pass else: self.fail ("pexpect.spawn('ls', '-la') should have raised a TypeError.") try: p = pexpect.spawn('cat') p.close() p.read_nonblocking(size=1, timeout=3) except ValueError: pass else: self.fail ("read_nonblocking on closed spawn object should have raised a ValueError.") def test_isalive(self): child = pexpect.spawn('cat') assert child.isalive(), child.isalive() child.sendeof() child.expect(pexpect.EOF) assert not child.isalive(), child.isalive() def test_bad_type_in_expect(self): child = pexpect.spawn('cat') try: child.expect({}) # We don't support dicts yet. Should give TypeError except TypeError: pass else: self.fail ("child.expect({}) should have raised a TypeError") def test_env(self): default = pexpect.run('env') userenv = pexpect.run('env', env={'foo':'pexpect'}) assert default!=userenv, "'default' and 'userenv' should be different" assert b'foo' in userenv and b'pexpect' in userenv, "'foo' and 'pexpect' should be in 'userenv'" def test_cwd (self): # This assumes 'pwd' and '/tmp' exist on this platform. default = pexpect.run('pwd') tmpdir = pexpect.run('pwd', cwd='/tmp') assert default!=tmpdir, "'default' and 'tmpdir' should be different" assert (b'tmp' in tmpdir), "'tmp' should be returned by 'pwd' command" def test_which (self): p = os.defpath ep = os.environ['PATH'] os.defpath = ":/tmp" os.environ['PATH'] = ":/tmp" wp = pexpect.which ("ticker.py") assert wp == 'ticker.py', "Should return a string. Returned %s" % wp os.defpath = "/tmp" os.environ['PATH'] = "/tmp" wp = pexpect.which ("ticker.py") assert wp == None, "Executable should not be found. Returned %s" % wp os.defpath = p os.environ['PATH'] = ep def test_searcher_re (self): # This should be done programatically, if we copied and pasted output, # there wouldnt be a whole lot to test, really, other than our ability # to copy and paste correctly :-) ss = pexpect.searcher_re ([ re.compile('this'), re.compile('that'), re.compile('and'), re.compile('the'), re.compile('other') ]) out = ('searcher_re:\n 0: re.compile("this")\n ' '1: re.compile("that")\n 2: re.compile("and")\n ' '3: re.compile("the")\n 4: re.compile("other")') assert ss.__str__() == out, (ss.__str__(), out) ss = pexpect.searcher_re ([ pexpect.TIMEOUT, re.compile('this'), re.compile('that'), re.compile('and'), pexpect.EOF,re.compile('other') ]) out = ('searcher_re:\n 0: TIMEOUT\n 1: re.compile("this")\n ' '2: re.compile("that")\n 3: re.compile("and")\n ' '4: EOF\n 5: re.compile("other")') assert ss.__str__() == out, (ss.__str__(), out) def test_searcher_string (self): ss = pexpect.searcher_string ([ 'this', 'that', 'and', 'the', 'other' ]) out = ('searcher_string:\n 0: "this"\n 1: "that"\n ' '2: "and"\n 3: "the"\n 4: "other"') assert ss.__str__() == out, (ss.__str__(), out) ss = pexpect.searcher_string ([ 'this', pexpect.EOF, 'that', 'and', 'the', 'other', pexpect.TIMEOUT ]) out = ('searcher_string:\n 0: "this"\n 1: EOF\n ' '2: "that"\n 3: "and"\n 4: "the"\n ' '5: "other"\n 6: TIMEOUT') assert ss.__str__() == out, (ss.__str__(), out) def test_nonnative_pty_fork(self): class spawn_ourptyfork(pexpect.spawn): def _spawn(self, command, args=[]): self.use_native_pty_fork = False pexpect.spawn._spawn(self, command, args) p = spawn_ourptyfork('cat') p.sendline('abc') p.expect('abc') p.sendeof() def test_exception_tb(self): p = pexpect.spawn('sleep 1') try: p.expect('BLAH') except pexpect.ExceptionPexpect as e: # get_trace should filter out frames in pexpect's own code tb = e.get_trace() assert 'raise ' not in tb, tb else: assert False, "Should have raised an exception." if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(TestCaseMisc,'test') pexpect-3.1/tests/list100.py0000644000175400017540000000006012221062304020027 0ustar takluyvertakluyver00000000000000# -*- coding: utf-8 -*- print(list(range(100))) pexpect-3.1/tests/test_command_list_split.py0000755000175400017540000000341412216111566023600 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import PexpectTestCase class SplitCommandLineTestCase(PexpectTestCase.PexpectTestCase): def testSplitSizes(self): assert len(pexpect.split_command_line(r'')) == 0 assert len(pexpect.split_command_line(r'one')) == 1 assert len(pexpect.split_command_line(r'one two')) == 2 assert len(pexpect.split_command_line(r'one two')) == 2 assert len(pexpect.split_command_line(r'one two')) == 2 assert len(pexpect.split_command_line(r'one\ one')) == 1 assert len(pexpect.split_command_line('\'one one\'')) == 1 assert len(pexpect.split_command_line(r'one\"one')) == 1 assert len(pexpect.split_command_line(r'This\' is a\'\ test')) == 3 if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(SplitCommandLineTestCase,'test') pexpect-3.1/tests/test_filedescriptor.py0000755000175400017540000000543412220666137022742 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect from pexpect import fdpexpect import unittest import PexpectTestCase import os class ExpectTestCase(PexpectTestCase.PexpectTestCase): def setUp(self): print(self.id()) PexpectTestCase.PexpectTestCase.setUp(self) def test_fd (self): fd = os.open ('TESTDATA.txt', os.O_RDONLY) s = fdpexpect.fdspawn (fd) s.expect(b'This is the end of test data:') s.expect(pexpect.EOF) self.assertEqual(s.before, b' END\n') def test_maxread (self): fd = os.open ('TESTDATA.txt', os.O_RDONLY) s = fdpexpect.fdspawn (fd) s.maxread = 100 s.expect('2') s.expect ('This is the end of test data:') s.expect (pexpect.EOF) self.assertEqual(s.before, b' END\n') def test_fd_isalive (self): fd = os.open ('TESTDATA.txt', os.O_RDONLY) s = fdpexpect.fdspawn(fd) assert s.isalive() os.close(fd) assert not s.isalive(), "Should not be alive after close()" def test_fd_isatty (self): fd = os.open ('TESTDATA.txt', os.O_RDONLY) s = fdpexpect.fdspawn (fd) assert not s.isatty() #os.close(fd) s.close() ### def test_close_does_not_close_fd (self): ### '''Calling close() on a fdpexpect.fdspawn object should not ### close the underlying file descriptor. ### ''' ### fd = os.open ('TESTDATA.txt', os.O_RDONLY) ### s = fdpexpect.fdspawn (fd) ### try: ### s.close() ### self.fail('Expected an Exception.') ### except pexpect.ExceptionPexpect, e: ### pass if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(ExpectTestCase, 'test') #fout = open('delete_me_1','wb') #fout.write(the_old_way) #fout.close #fout = open('delete_me_2', 'wb') #fout.write(the_new_way) #fout.close pexpect-3.1/tests/fakessh/0000755000175400017540000000000012270016336017721 5ustar takluyvertakluyver00000000000000pexpect-3.1/tests/fakessh/ssh0000755000175400017540000000124512232544730020450 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python from __future__ import print_function import getpass import sys PY3 = (sys.version_info[0] >= 3) if not PY3: input = raw_input print("Mock SSH client for tests. Do not enter real security info.") pw = getpass.getpass('password:') if pw != 's3cret': print('Permission denied!') sys.exit(1) prompt = "$" while True: cmd = input(prompt) if cmd.startswith('PS1='): prompt = eval(cmd[4:]).replace('\$', '$') elif cmd == 'ping': print('pong') elif cmd.startswith('ls'): print('file1.py', 'file2.html', sep='\t') elif cmd == 'echo $?': print(0) elif cmd in ('exit', 'logout'): breakpexpect-3.1/tests/test_isalive.py0000755000175400017540000001070412232544730021351 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import signal import sys, os, time import PexpectTestCase class IsAliveTestCase(PexpectTestCase.PexpectTestCase): def test_expect_wait (self): '''This tests that calling wait on a finished process works as expected. ''' p = pexpect.spawn('sleep 3') if not p.isalive(): self.fail ('Child process is not alive. It should be.') time.sleep(1) p.wait() if p.isalive(): self.fail ('Child process is not dead. It should be.') p = pexpect.spawn('sleep 3') if not p.isalive(): self.fail ('Child process is not alive. It should be.') p.kill(9) time.sleep(1) try: p.wait() except pexpect.ExceptionPexpect: pass else: self.fail ('Should have raised ExceptionPython because you can\'t call wait on a dead process.') def test_signal_wait(self): '''Test calling wait with a process terminated by a signal.''' if not hasattr(signal, 'SIGALRM'): return 'SKIP' p = pexpect.spawn(sys.executable, ['alarm_die.py']) p.wait() assert p.exitstatus is None, p.exitstatus self.assertEqual(p.signalstatus, signal.SIGALRM) def test_expect_isalive_dead_after_normal_termination (self): p = pexpect.spawn('ls') p.expect(pexpect.EOF) time.sleep(1) # allow kernel status time to catch up with state. if p.isalive(): self.fail ('Child process is not dead. It should be.') def test_expect_isalive_dead_after_SIGINT (self): p = pexpect.spawn('cat', timeout=5) if not p.isalive(): self.fail ('Child process is not alive. It should be.') p.terminate() # Solaris is kind of slow. # Without this delay then p.expect(...) will not see # that the process is dead and it will timeout. time.sleep(1) p.expect(pexpect.EOF) if p.isalive(): self.fail ('Child process is not dead. It should be.') def test_expect_isalive_dead_after_SIGKILL (self): p = pexpect.spawn('cat', timeout=3) if not p.isalive(): self.fail ('Child process is not alive. It should be.') p.kill(9) # Solaris is kind of slow. # Without this delay then p.expect(...) will not see # that the process is dead and it will timeout. time.sleep(1) p.expect(pexpect.EOF) if p.isalive(): self.fail ('Child process is not dead. It should be.') def test_forced_terminate(self): p = pexpect.spawn(sys.executable, ['needs_kill.py']) p.expect('READY') res = p.terminate(force=True) assert res, res ### Some platforms allow this. Some reset status after call to waitpid. def test_expect_isalive_consistent_multiple_calls (self): '''This tests that multiple calls to isalive() return same value. ''' p = pexpect.spawn('cat') if not p.isalive(): self.fail ('Child process is not alive. It should be.') if not p.isalive(): self.fail ('Second call. Child process is not alive. It should be.') p.kill(9) p.expect(pexpect.EOF) if p.isalive(): self.fail ('Child process is not dead. It should be.') if p.isalive(): self.fail ('Second call. Child process is not dead. It should be.') if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(IsAliveTestCase, 'test') pexpect-3.1/tests/bambi.vt0000644000175400017540000003102212216111566017721 0ustar takluyvertakluyver00000000000000[?25l    The  The Adventures  The Adventures of  The Adventures of BAMBI   Number  Number One :  Number One : BAMBI  Number One : BAMBI versus  Number One : BAMBI versus GODZILLA                                                                ,| *./\|(/|/  /| |/`|',/| \|/  \/_,| /| /, /<|\\/\|/|\  _^_  o / .\  \,--------; __o  / .:::. . /  \___________/  |\ |\  | > | \  / / | \  _^_  o / .\  \,--------; __o  / .:::. . /  \___________/  \| |\  \ | \  / \ / |  _^_  o / .\  \,--------; __o  / .:::. . /  \___________/  \\ \|  \\ \  | \ |\  _^_  o / .\  \,--------; __o  / .:::. . /  \___________/  \\ \|  >\ \  / | /|  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  |\ |\  | > | \  / / | \  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \| |\  \ | \  / \ / |   --,_^_ . .\ __--___o --_ . \ __ \/| |\( .| | \\ /  | " --_ . \ __ \/| |\( .| | \\ /  | " --_ . \ __ \/| |\( .| | \\ /  | " --_ . \ __ \/| |\( .| | \\ /  | " --,_^_ . .\ __--___o |\ | \  |  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  \\ \  | \ |\  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  >\ \  / | /|  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  |\ |\  | > | \  / / | \  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \| |\  \ | \  / \ / |  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  \\ \  | \ |\  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  >\ \  / | /|  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  |\ |\  | > | \  / / | \  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \| |\  \ | \  / \ / |  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  \\ \  | \ |\  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  >\ \  / | /|  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  |\ |\  | > | \  / / | \   --,_^_ . .\ __--___o --_ . \ __ \/| |\( .| | \\ / | \" --_ . \ __ \/| |\( .| | \\ / | \" --,_^_ . .\ __--___o |\ | \ | \ --,_^_ . .\ __--___o |\ | \ | \ --_ . \ __ \/| |\( .| | \\ / | \" --_ . \ __ \/| |\( .| | \\ / | \" --_ . \ __ \/| |\( .| | \\ / | \" --,_^_ . .\ __--___o |\ | \ | \  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \| |\  \ | \  / \ / |  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  \\ \  | \ |\  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  >\ \  / | /|  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  |\ |\  | > | \  / / | \  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \| |\  \ | \  / \ / |  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  \\ \  | \ |\  _^_  o / .\  \,--------; __o  / .:::.. . /  \___________/  \\ \|  >\ \  / | /|   o  \,----------,_^_  / .:::.. . .\  \___________--___o  \\ \|  >\ \  / | /|   o  \,----------_  / .:::.. . \  \___________ \/|  \\ \|( .|  >\ \ \ /  / | /| "  `' `.__________________________________/M ( / (/M (-.___)M / \/)M _______.--'\M ,____________/\M ( / )M ( ) /M \ \ )M ( )M ( ( /M \ ( )M ( \ )M ( ( /M  \ ( ) )M  ( ( / )M  ( \ ) /M  \ ( ) )M  ( ) )M  ( ) /M  \ / )M  ( ) )  / > | \    T T T  T H T H T H  T H E T H E T H E  T H E  T H E E T H E E T H E E  T H E E N T H E E N T H E E N  T H E E N D T H E E N D  ===============  [?25h pexpect-3.1/tests/exit1.py0000755000175400017540000000175112220666300017705 0ustar takluyvertakluyver00000000000000''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import os, sys print("Hello") sys.stdout.flush() os._exit(1) pexpect-3.1/tests/test_run_out_of_pty.py0000755000175400017540000000414212220666300022762 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import PexpectTestCase class ExpectTestCase(PexpectTestCase.PexpectTestCase): # This takes too long to run and isn't all that interesting of a test. def OFF_test_run_out_of_pty (self): '''This assumes that the tested platform has < 10000 pty devices. This test currently does not work under Solaris. Under Solaris it runs out of file descriptors first and ld.so starts to barf: ld.so.1: pt_chmod: fatal: /usr/lib/libc.so.1: Too many open files ''' plist=[] for count in range (0,10000): try: plist.append (pexpect.spawn('ls -l')) except pexpect.ExceptionPexpect: for c in range (0, count): plist[c].close() return except Exception: err = sys.exc_info()[1] self.fail ('Expected ExceptionPexpect. ' + str(err)) self.fail ('Could not run out of pty devices. This may be OK.') if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(ExpectTestCase,'test') pexpect-3.1/tests/TESTDATA.txt0000644000175400017540000000014612216111566020251 0ustar takluyvertakluyver00000000000000This is test data. One 2 THREE IV ..... 110 This is the end of test data: END pexpect-3.1/tests/interact_unicode.py0000644000175400017540000000061012232544730022165 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' Just like interact.py, but using spawnu instead of spawn ''' try: # This allows coverage to measure code run in this process import coverage coverage.process_startup() except ImportError: pass import pexpect import sys def main(): p = pexpect.spawnu(sys.executable + ' echo_w_prompt.py') p.interact() if __name__ == '__main__': main() pexpect-3.1/tests/adhoc.py0000755000175400017540000000241412220666300017726 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function import pexpect import time p = pexpect.spawn ('./a.out') print(p.exitstatus) p.expect (pexpect.EOF) print(p.before) time.sleep(1) print('exitstatus:', p.exitstatus) print('isalive',p.isalive()) print('exitstatus',p.exitstatus) print('isalive',p.isalive()) print('exitstatus',p.exitstatus) pexpect-3.1/tests/ticker.py0000755000175400017540000000202312216111566020131 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import time, sys for i in range(5): print "tick" time.sleep(1) sys.exit(0) pexpect-3.1/tests/test_pickling.py0000644000175400017540000000052212267623031021507 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import pickle import unittest from pexpect import ExceptionPexpect class PickleTest(unittest.TestCase): def test_picking(self): e = ExceptionPexpect('Oh noes!') clone = pickle.loads(pickle.dumps(e)) self.assertEqual(e.value, clone.value) if __name__ == '__main__': unittest.main() pexpect-3.1/tests/test_psh.py0000644000175400017540000000062112232544730020501 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import unittest from pexpect import pxssh, psh from test_pxssh import SSHTestBase class PshTestBase(SSHTestBase): def test_psh(self): ssh = pxssh.pxssh() ssh.login('server', 'user', 's3cret') sh = psh.psh(ssh) res = set(sh.ls()) self.assertEqual(res, set([b'file1.py', b'file2.html'])) if __name__ == '__main__': unittest.main()pexpect-3.1/tests/test_unicode.py0000644000175400017540000001136612227101142021333 0ustar takluyvertakluyver00000000000000# -*- coding: utf-8 -*- from __future__ import unicode_literals import platform import tempfile import pexpect import unittest import PexpectTestCase # the program cat(1) may display ^D\x08\x08 when \x04 (EOF, Ctrl-D) is sent _CAT_EOF = '^D\x08\x08' class UnicodeTests(PexpectTestCase.PexpectTestCase): def test_expect_basic (self): p = pexpect.spawnu('cat') p.sendline('Hello') p.sendline('there') p.sendline('Mr. þython') # þ is more like th than p, but never mind p.expect('Hello') p.expect('there') p.expect('Mr. þython') p.sendeof () p.expect (pexpect.EOF) def test_expect_exact_basic (self): p = pexpect.spawnu('cat') p.sendline('Hello') p.sendline('there') p.sendline('Mr. þython') p.expect_exact('Hello') p.expect_exact('there') p.expect_exact('Mr. þython') p.sendeof() p.expect_exact (pexpect.EOF) def test_expect_echo (self): '''This tests that echo can be turned on and off. ''' p = pexpect.spawnu('cat', timeout=10) self._expect_echo(p) def test_expect_echo_exact (self): '''Like test_expect_echo(), but using expect_exact(). ''' p = pexpect.spawnu('cat', timeout=10) p.expect = p.expect_exact self._expect_echo(p) def _expect_echo (self, p): p.sendline('1234') # Should see this twice (once from tty echo and again from cat). index = p.expect (['1234', 'abcdé', 'wxyz', pexpect.EOF, pexpect.TIMEOUT]) assert index == 0, (index, p.before) index = p.expect (['1234', 'abcdé', 'wxyz', pexpect.EOF]) assert index == 0, index p.setecho(0) # Turn off tty echo p.sendline('abcdé') # Now, should only see this once. p.sendline('wxyz') # Should also be only once. index = p.expect ([pexpect.EOF,pexpect.TIMEOUT, 'abcdé', 'wxyz', '1234']) assert index == 2, index index = p.expect ([pexpect.EOF, 'abcdé', 'wxyz', '7890']) assert index == 2, index p.setecho(1) # Turn on tty echo p.sendline('7890') # Should see this twice. index = p.expect ([pexpect.EOF, 'abcdé', 'wxyz', '7890']) assert index == 3, index index = p.expect ([pexpect.EOF, 'abcdé', 'wxyz', '7890']) assert index == 3, index p.sendeof() def test_log_unicode(self): msg = "abcΩ÷" filename_send = tempfile.mktemp() filename_read = tempfile.mktemp() p = pexpect.spawnu('cat') if platform.python_version_tuple() < ('3', '0', '0'): import codecs def open(fname, mode, **kwargs): if 'newline' in kwargs: del kwargs['newline'] return codecs.open(fname, mode, **kwargs) else: import io open = io.open p.logfile_send = open(filename_send, 'w', encoding='utf-8') p.logfile_read = open(filename_read, 'w', encoding='utf-8') p.sendline(msg) p.sendeof() p.expect(pexpect.EOF) p.close() p.logfile_send.close() p.logfile_read.close() # ensure the 'send' log is correct, with open(filename_send, 'r', encoding='utf-8') as f: self.assertEqual(f.read(), msg + '\n\x04') # ensure the 'read' log is correct, with open(filename_read, 'r', encoding='utf-8', newline='') as f: output = f.read().replace(_CAT_EOF, '') self.assertEqual(output, (msg + '\r\n')*2 ) def test_spawn_expect_ascii_unicode(self): # A bytes-based spawn should be able to handle ASCII-only unicode, for # backwards compatibility. p = pexpect.spawn('cat') p.sendline('Camelot') p.expect('Camelot') p.sendline('Aargh') p.sendline('Aårgh') p.expect_exact('Aargh') p.sendeof() p.expect(pexpect.EOF) def test_spawn_send_unicode(self): # A bytes-based spawn should be able to send arbitrary unicode p = pexpect.spawn('cat') p.sendline('3½') p.sendeof() p.expect(pexpect.EOF) def test_spawn_utf8_incomplete(self): # This test case ensures correct incremental decoding, which # otherwise fails when the stream inspected by os.read() # does not align exactly at a utf-8 multibyte boundry: # UnicodeDecodeError: 'utf8' codec can't decode byte 0xe2 in # position 0: unexpected end of data p = pexpect.spawnu('cat', maxread=1) p.sendline('▁▂▃▄▅▆▇█') p.sendeof() p.expect('▁▂▃▄▅▆▇█') if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(UnicodeTests, 'test') pexpect-3.1/tests/test_constructor.py0000755000175400017540000000356712216111566022312 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import time import PexpectTestCase class TestCaseConstructor(PexpectTestCase.PexpectTestCase): def test_constructor (self): '''This tests that the constructor will work and give the same results for different styles of invoking __init__(). This assumes that the root directory / is static during the test. ''' p1 = pexpect.spawn('/bin/ls -l /bin') p2 = pexpect.spawn('/bin/ls' ,['-l', '/bin']) p1.expect (pexpect.EOF) p2.expect (pexpect.EOF) assert (p1.before == p2.before) def test_named_parameters (self): '''This tests that named parameters work. ''' p = pexpect.spawn ('/bin/ls',timeout=10) p = pexpect.spawn (timeout=10, command='/bin/ls') p = pexpect.spawn (args=[], command='/bin/ls') if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(TestCaseConstructor,'test') pexpect-3.1/tests/echo_wait.py0000755000175400017540000000316512216171044020617 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import signal, time, struct, fcntl, termios, os, sys # a dumb PAM will print the password prompt first then set ECHO # False. What it should do it set ECHO False first then print the # prompt. Otherwise, if we see the password prompt and type out # password real fast before it turns off ECHO then some or all of # our password might be visibly echod back to us. Sounds unlikely? # It happens. print("fake password:") sys.stdout.flush() time.sleep(3) attr = termios.tcgetattr(sys.stdout) attr[3] = attr[3] & ~termios.ECHO termios.tcsetattr(sys.stdout, termios.TCSANOW, attr) time.sleep(12) attr[3] = attr[3] | termios.ECHO termios.tcsetattr(sys.stdout, termios.TCSANOW, attr) time.sleep(2) pexpect-3.1/tests/PexpectTestCase.py0000644000175400017540000000314112232544730021714 0ustar takluyvertakluyver00000000000000 ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function import unittest import sys import os class PexpectTestCase(unittest.TestCase): def setUp(self): self.PYTHONBIN = sys.executable self.original_path = os.getcwd() project_dir = os.environ['PROJECT_PEXPECT_HOME'] newpath = os.path.join (project_dir, 'tests') os.chdir (newpath) os.environ['COVERAGE_PROCESS_START'] = os.path.join(project_dir, '.coveragerc') os.environ['COVERAGE_FILE'] = os.path.join(project_dir, '.coverage') print('\n', self.id(), end=' ') sys.stdout.flush() unittest.TestCase.setUp(self) def tearDown(self): os.chdir (self.original_path) pexpect-3.1/tests/test_pxssh.py0000644000175400017540000000222512232544730021056 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import os import unittest from pexpect import pxssh class SSHTestBase(unittest.TestCase): def setUp(self): self.orig_path = os.environ.get('PATH') fakessh_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), 'fakessh')) os.environ['PATH'] = fakessh_dir + \ ((os.pathsep + self.orig_path) if self.orig_path else '') def tearDown(self): if self.orig_path: os.environ['PATH'] = self.orig_path else: del os.environ['PATH'] class PxsshTestCase(SSHTestBase): def test_fake_ssh(self): ssh = pxssh.pxssh() #ssh.logfile_read = sys.stdout # DEBUG ssh.login('server', 'me', password='s3cret') ssh.sendline('ping') ssh.expect('pong', timeout=10) assert ssh.prompt(timeout=10) ssh.logout() def test_wrong_pw(self): ssh = pxssh.pxssh() try: ssh.login('server', 'me', password='wr0ng') except pxssh.ExceptionPxssh: pass else: assert False, 'Password should have been refused' if __name__ == '__main__': unittest.main()pexpect-3.1/tests/test_run.py0000755000175400017540000000706312227101142020513 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python # encoding: utf-8 ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import subprocess import sys import PexpectTestCase # TODO Many of these test cases blindly assume that sequential # TODO listing of the /bin directory will yield the same results. # TODO This may not always be true, but seems adequate for testing for now. # TODO I should fix this at some point. unicode_type = str if pexpect.PY3 else unicode def timeout_callback (d): # print d["event_count"], if d["event_count"]>3: return 1 return 0 class RunFuncTestCase(PexpectTestCase.PexpectTestCase): runfunc = staticmethod(pexpect.run) cr = b'\r' empty = b'' prep_subprocess_out = staticmethod(lambda x: x) def test_run_exit (self): (data, exitstatus) = self.runfunc('python exit1.py', withexitstatus=1) assert exitstatus == 1, "Exit status of 'python exit1.py' should be 1." def test_run (self): the_old_way = subprocess.Popen(args=['ls', '-l', '/bin'], stdout=subprocess.PIPE).communicate()[0].rstrip() (the_new_way, exitstatus) = self.runfunc('ls -l /bin', withexitstatus=1) the_new_way = the_new_way.replace(self.cr, self.empty).rstrip() self.assertEqual(self.prep_subprocess_out(the_old_way), the_new_way) self.assertEqual(exitstatus, 0) def test_run_callback (self): # TODO it seems like this test could block forever if run fails... self.runfunc("cat", timeout=1, events={pexpect.TIMEOUT:timeout_callback}) def test_run_bad_exitstatus (self): (the_new_way, exitstatus) = self.runfunc('ls -l /najoeufhdnzkxjd', withexitstatus=1) assert exitstatus != 0 class RunUnicodeFuncTestCase(RunFuncTestCase): runfunc = staticmethod(pexpect.runu) cr = b'\r'.decode('ascii') empty = b''.decode('ascii') prep_subprocess_out = staticmethod(lambda x: x.decode('utf-8', 'replace')) def test_run_unicode(self): if pexpect.PY3: c = chr(254) # þ pattern = '' else: c = unichr(254) # analysis:ignore pattern = ''.decode('ascii') def callback(d): if d['event_count'] == 0: return c + '\n' else: return True # Stop the child process output = pexpect.runu(sys.executable + ' echo_w_prompt.py', env={'PYTHONIOENCODING':'utf-8'}, events={pattern:callback}) assert isinstance(output, unicode_type), type(output) assert ''+c in output, output if __name__ == '__main__': unittest.main() pexpect-3.1/tests/test_destructor.py0000755000175400017540000000611712232544730022116 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import PexpectTestCase import gc import platform import time class TestCaseDestructor(PexpectTestCase.PexpectTestCase): def test_destructor (self): if platform.python_implementation() != 'CPython': # Details of garbage collection are different on other implementations return 'SKIP' gc.collect() time.sleep(3) p1 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) p2 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) p3 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) p4 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) fd_t1 = (p1.child_fd,p2.child_fd,p3.child_fd,p4.child_fd) p1.expect(pexpect.EOF) p2.expect(pexpect.EOF) p3.expect(pexpect.EOF) p4.expect(pexpect.EOF) p1.kill(9) p2.kill(9) p3.kill(9) p4.kill(9) p1 = None p2 = None p3 = None p4 = None gc.collect() time.sleep(3) # Some platforms are slow at gc... Solaris! p1 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) p2 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) p3 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) p4 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) fd_t2 = (p1.child_fd,p2.child_fd,p3.child_fd,p4.child_fd) p1.kill(9) p2.kill(9) p3.kill(9) p4.kill(9) del (p1) del (p2) del (p3) del (p4) gc.collect() time.sleep(3) p1 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) p2 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) p3 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) p4 = pexpect.spawn('%s hello_world.py' % self.PYTHONBIN) fd_t3 = (p1.child_fd,p2.child_fd,p3.child_fd,p4.child_fd) assert (fd_t1 == fd_t2 == fd_t3), "pty file descriptors not properly garbage collected (fd_t1,fd_t2,fd_t3)=(%s,%s,%s)" % (str(fd_t1),str(fd_t2),str(fd_t3)) if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(TestCaseDestructor,'test') pexpect-3.1/tests/torturet.vt0000644000175400017540000000616512216111566020551 0ustar takluyvertakluyver00000000000000\<>PrEM1\[?4h #6(0a`opqrs`(B This is the (0`srqpo`a(B #3VT100 series Torture Test Demonstration. #4VT100 series Torture Test Demonstration. #6 Watch the blinking lights     PrEM0\ This file is a VT100-series Torture Test. It demonstrates all the visual attributes of the VT100 terminal. The top line is double-width/single-height with inverse-video line-drawing characters. The 2nd and 3rd lines are double-width/double-height in bold inverse video. They also show the limited scrolling region. The remaining lines will show NORMAL, BOLD, BLINK, INVERSE, and all 16 combinations of those 4 attributes. They show that there is a difference between an underscore character and the underline attribute, and that lower-case decenders go below the underline. A window pane is drawn in the lower right to show how the line-drawing set can be used. At the lower left is the character set double-wide/double-high to show the dot-matrix used. Upper-case characters are 8 by 7 in a 10 by 10 character cell, with 1 blank row on top and 2 on the bottom. The underline attribute uses the first bottom blank row, lower-case decenders use both. This is a normal line __________________________________________________y_ This is a bold line (normal unless the Advanced Video Option is installed) This line is underlined _ " " " " " " _y_ This is a blinking line _ " " " " " " _y_ This is inverse video _ (underlined if no AVO and cursor is underline) _y_ Normal gjpqy Underline  Blink Underline+Blink gjpqy Bold gjpqy Underline  Blink Underline+Blink gjpqy Inverse Underline  Blink Underline+Blink Bold+Inverse Underline  Blink Underline+Blink PrEM1\ #6This is double width #3This is double height #4This is double height #6_ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ioy #3_ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ioy #4_ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ioy ACEGIKMOQSUWY02468iy _BDFHJLNPRTVXZ13579o _BDFHJLNPRTVXZ13579o (0#6`abcdefghijklmnopqrstuvwxyz{|}~ lqwqk #3`abcdefghijklmnopqrstuvwxyz{|}~ tqnqu #4`abcdefghijklmnopqrstuvwxyz{|}~ tqnqu acegikmoqsuwy{} `bdfhjlnprtvxz|~ `bdfhjlnprtvxz|~(B #6`abcdefghijklmnopqrstuvwxyz{|}~(0 mqvqj(B acegikmoqsuwy{} PrEM0\ $PrEM0 works on GIGI  This test created by Joe Smith, 8-May-85   pexpect-3.1/tests/sigwinch_report.py0000755000175400017540000000324612227101142022055 0ustar takluyvertakluyver00000000000000''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function import signal, time, struct, fcntl, termios, sys def getwinsize(): '''This returns the window size of the child tty. The return value is a tuple of (rows, cols). ''' if 'TIOCGWINSZ' in dir(termios): TIOCGWINSZ = termios.TIOCGWINSZ else: TIOCGWINSZ = 1074295912 # Assume s = struct.pack('HHHH', 0, 0, 0, 0) x = fcntl.ioctl(sys.stdout.fileno(), TIOCGWINSZ, s) return struct.unpack('HHHH', x)[0:2] def handler(signum, frame): print('signal') sys.stdout.flush() print('SIGWINCH:', getwinsize ()) sys.stdout.flush() print("setting handler for SIGWINCH") signal.signal(signal.SIGWINCH, handler) print("READY") while 1: sys.stdout.flush() time.sleep(1) pexpect-3.1/tests/depricated_test_filedescriptor.py0000755000175400017540000000525012220666300025112 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import PexpectTestCase import sys import os class ExpectTestCase(PexpectTestCase.PexpectTestCase): def setUp(self): print(self.id()) PexpectTestCase.PexpectTestCase.setUp(self) def test_fd (self): fd = os.open ('TESTDATA.txt', os.O_RDONLY) s = pexpect.spawn (fd) s.expect ('This is the end of test data:') s.expect (pexpect.EOF) assert s.before == ' END\n' def test_maxread (self): fd = os.open ('TESTDATA.txt', os.O_RDONLY) s = pexpect.spawn (fd) s.maxread = 100 s.expect('2') s.expect ('This is the end of test data:') s.expect (pexpect.EOF) assert s.before == ' END\n' def test_fd_isalive (self): fd = os.open ('TESTDATA.txt', os.O_RDONLY) s = pexpect.spawn (fd) assert s.isalive() os.close (fd) assert not s.isalive() def test_fd_isatty (self): fd = os.open ('TESTDATA.txt', os.O_RDONLY) s = pexpect.spawn (fd) assert not s.isatty() os.close(fd) ### def test_close_does_not_close_fd (self): ### '''Calling close() on a pexpect.spawn object should not ### close the underlying file descriptor. ### ''' ### fd = os.open ('TESTDATA.txt', os.O_RDONLY) ### s = pexpect.spawn (fd) ### try: ### s.close() ### self.fail('Expected an Exception.') ### except pexpect.ExceptionPexpect, e: ### pass if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(ExpectTestCase, 'test') #fout = open('delete_me_1','wb') #fout.write(the_old_way) #fout.close #fout = open('delete_me_2', 'wb') #fout.write(the_new_way) #fout.close pexpect-3.1/tests/test_screen.py0000755000175400017540000001303612216707154021200 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from pexpect import screen import unittest import PexpectTestCase fill1_target='XXXXXXXXXX\n' + \ 'XOOOOOOOOX\n' + \ 'XO::::::OX\n' + \ 'XO:oooo:OX\n' + \ 'XO:o..o:OX\n' + \ 'XO:o..o:OX\n' + \ 'XO:oooo:OX\n' + \ 'XO::::::OX\n' + \ 'XOOOOOOOOX\n' + \ 'XXXXXXXXXX' fill2_target = 'XXXXXXXXXXX\n' + \ 'XOOOOOOOOOX\n' + \ 'XO:::::::OX\n' + \ 'XO:ooooo:OX\n' + \ 'XO:o...o:OX\n' + \ 'XO:o.+.o:OX\n' + \ 'XO:o...o:OX\n' + \ 'XO:ooooo:OX\n' + \ 'XO:::::::OX\n' + \ 'XOOOOOOOOOX\n' + \ 'XXXXXXXXXXX' put_target = '\\.3.5.7.9/\n' + \ '.........2\n' + \ '3.........\n' + \ '.........4\n' + \ '5...\\/....\n' + \ '..../\\...6\n' + \ '7.........\n' + \ '.........8\n' + \ '9.........\n' + \ '/2.4.6.8.\\' scroll_target = '\\.3.5.7.9/\n' + \ '\\.3.5.7.9/\n' + \ '\\.3.5.7.9/\n' + \ '\\.3.5.7.9/\n' + \ '5...\\/....\n' + \ '..../\\...6\n' + \ '/2.4.6.8.\\\n' + \ '/2.4.6.8.\\\n' + \ '/2.4.6.8.\\\n' + \ '/2.4.6.8.\\' insert_target = 'ZXZZZZZZXZ\n' +\ '.........2\n' +\ '3.........\n' +\ '.........4\n' +\ 'Z5...\\/...\n' +\ '..../Z\\...\n' +\ '7.........\n' +\ '.........8\n' +\ '9.........\n' +\ 'ZZ/2.4.6ZZ' get_region_target = ['......', '.\\/...', './\\...', '......'] class screenTestCase (PexpectTestCase.PexpectTestCase): def make_screen_with_put (self): s = screen.screen(10,10) s.fill ('.') for r in range (1,s.rows + 1): if r % 2: s.put_abs (r, 1, str(r)) else: s.put_abs (r, s.cols, str(r)) for c in range (1,s.cols + 1): if c % 2: s.put_abs (1, c, str(c)) else: s.put_abs (s.rows, c, str(c)) s.put_abs(1,1, '\\') s.put_abs(1,s.cols, '/') s.put_abs(s.rows,1,'/') s.put_abs(s.rows, s.cols, '\\') s.put_abs(5,5,'\\') s.put_abs(5,6,'/') s.put_abs(6,5,'/') s.put_abs(6,6,'\\') return s def test_fill (self): s = screen.screen (10,10) s.fill_region (10,1,1,10,'X') s.fill_region (2,2,9,9,'O') s.fill_region (8,8,3,3,':') s.fill_region (4,7,7,4,'o') s.fill_region (6,5,5,6,'.') assert str(s) == fill1_target s = screen.screen (11,11) s.fill_region (1,1,11,11,'X') s.fill_region (2,2,10,10,'O') s.fill_region (9,9,3,3,':') s.fill_region (4,8,8,4,'o') s.fill_region (7,5,5,7,'.') s.fill_region (6,6,6,6,'+') assert str(s) == fill2_target def test_put (self): s = self.make_screen_with_put() assert str(s) == put_target def test_get_region (self): s = self.make_screen_with_put() r = s.get_region (4,4,7,9) assert r == get_region_target def test_cursor_save (self): s = self.make_screen_with_put() s.cursor_home (5,5) c = s.get() s.cursor_save() s.cursor_home() s.cursor_forward() s.cursor_down() s.cursor_unsave() assert s.cur_r == 5 and s.cur_c == 5 assert c == s.get() def test_scroll (self): s = self.make_screen_with_put() s.scroll_screen_rows (1,4) s.scroll_down(); s.scroll_down(); s.scroll_down() s.scroll_down(); s.scroll_down(); s.scroll_down() s.scroll_screen_rows (7,10) s.scroll_up(); s.scroll_up(); s.scroll_up() s.scroll_up(); s.scroll_up(); s.scroll_up() assert str(s) == scroll_target def test_insert (self): s = self.make_screen_with_put() s.insert_abs (10,1,'Z') s.insert_abs (1,1,'Z') s.insert_abs (1,1,'Z') s.insert_abs (1,1,'Z') s.insert_abs (1,1,'Z') s.insert_abs (1,1,'Z') s.insert_abs (10,1,'Z') s.insert_abs (1,1,'Z') s.insert_abs (1,1,'Z') s.insert_abs (5,1,'Z') s.insert_abs (6,6,'Z') s.cursor_home (1,1) # Also test relative insert. s.insert ('Z') s.insert ('Z') s.insert ('Z') s.insert ('Z') s.insert_abs (1,8,'X') s.insert_abs (1,2,'X') s.insert_abs (10,9,'Z') s.insert_abs (10,9,'Z') assert str(s) == insert_target # def test_write (self): # s = screen.screen (6,65) # s.fill('.') # s.cursor_home() # for c in write_text: # s.write (c) # print str(s) # assert str(s) == write_target # def test_tetris (self): # s = screen.screen (24,80) # tetris_text = open ('tetris.data').read() # for c in tetris_text: # s.write (c) # assert str(s) == tetris_target if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(screenTestCase,'test') pexpect-3.1/tests/needs_kill.py0000755000175400017540000000054012232544730020764 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python """This script can only be killed by SIGKILL.""" import signal, time # Ignore interrupt, hangup and continue signals - only SIGKILL will work signal.signal(signal.SIGINT, signal.SIG_IGN) signal.signal(signal.SIGHUP, signal.SIG_IGN) signal.signal(signal.SIGCONT, signal.SIG_IGN) print('READY') while True: time.sleep(10) pexpect-3.1/tests/exit667.c0000644000175400017540000000177512216111566017670 0ustar takluyvertakluyver00000000000000/* PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include int main () { printf ("Hello world!\n"); exit(7); } pexpect-3.1/tests/test_performance.py0000755000175400017540000000755312227101714022221 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function import unittest, time, sys import pexpect import PexpectTestCase # This isn't exactly a unit test, but it fits in nicely with the rest of the tests. class PerformanceTestCase (PexpectTestCase.PexpectTestCase): '''Testing the performance of expect, with emphasis on wading through long inputs. ''' if sys.version_info[0] >= 3: @staticmethod def _iter_n(n): s = 'for n in range(1, %d+1): print(n)' % n return s.encode('ascii') else: @staticmethod def _iter_n(n): return 'for n in range(1, %d+1): print(n)' % n def plain_range(self, n): e = pexpect.spawn('python') self.assertEqual(e.expect(b'>>>'), 0) e.sendline(self._iter_n(n)) self.assertEqual(e.expect(br'\.{3}'), 0) e.sendline(b'') self.assertEqual(e.expect([b'inquisition', '%d' % n]), 1) def window_range(self, n): e = pexpect.spawn('python') self.assertEqual(e.expect(b'>>>'), 0) e.sendline(self._iter_n(n)) self.assertEqual(e.expect(r'\.{3}'), 0) e.sendline(b'') self.assertEqual(e.expect([b'inquisition', '%d' % n], searchwindowsize=20), 1) def exact_range(self, n): e = pexpect.spawn('python') self.assertEqual(e.expect_exact([b'>>>']), 0) e.sendline(self._iter_n(n)) self.assertEqual(e.expect_exact([b'...']), 0) e.sendline(b'') self.assertEqual(e.expect_exact([b'inquisition', '%d' % n],timeout=520), 1) def ewin_range(self, n): e = pexpect.spawn('python') self.assertEqual(e.expect_exact([b'>>>']), 0) e.sendline(self._iter_n(n)) self.assertEqual(e.expect_exact([b'...']), 0) e.sendline(b'') self.assertEqual(e.expect_exact([b'inquisition', '%d' % n], searchwindowsize=20), 1) def faster_range(self, n): e = pexpect.spawn('python') self.assertEqual(e.expect(b'>>>'), 0) e.sendline(('list(range(1, %d+1))' % n).encode('ascii')) self.assertEqual(e.expect([b'inquisition', '%d' % n]), 1) def test_100000(self): print() start_time = time.time() self.plain_range (100000) print("100000 calls to plain_range:", (time.time() - start_time)) start_time = time.time() self.window_range(100000) print("100000 calls to window_range:", (time.time() - start_time)) start_time = time.time() self.exact_range (100000) print("100000 calls to exact_range:", (time.time() - start_time)) start_time = time.time() self.ewin_range (100000) print("100000 calls to ewin_range:", (time.time() - start_time)) start_time = time.time() self.faster_range(100000) print("100000 calls to faster_range:", (time.time() - start_time)) if __name__ == "__main__": unittest.main() suite = unittest.makeSuite(PerformanceTestCase,'test') pexpect-3.1/tests/globe.vt0000644000175400017540000007200012216111566017740 0ustar takluyvertakluyver00000000000000 _-o#&&*''''?d:>b\_ _o/"`'' '',, dMF9MMMMMHo_ .o&#' `"MbHMMMMMMMMMMMHo. .o"" ' vodM*$&&HMMMMMMMMMM?. ,' $M&ood,~'`(&##MMMMMMH\ / ,MMMMMMM#b?#bobMMMMHMMML & ?MMMMMMMMMMMMMMMMM7MMM$R*Hk ?$. :MMMMMMMMMMMMMMMMMMM/HMMM|`*L | |MMMMMMMMMMMMMMMMMMMMbMH' T, $H#: `*MMMMMMMMMMMMMMMMMMMMb#}' `? ]MMH# ""*""""*#MMMMMMMMMMMMM' - MMMMMb_ |MMMMMMMMMMMP' : HMMMMMMMHo `MMMMMMMMMT . ?MMMMMMMMP 9MMMMMMMM} - -?MMMMMMM |MMMMMMMMM?,d- ' :|MMMMMM- `MMMMMMMT .M|. : .9MMM[ &MMMMM*' `' . :9MMk `MMM#" - &M} ` .- `&. . `~, . ./ . _ .- '`--._,dd###pp=""'  _v->#H#P? "':o<>\_ .,dP` `'' "'-o.+H6&MMMHo_ oHMH9' `?&bHMHMMMMMMHo. oMP"' ' ooMP*#&HMMMMMMM?. ,M* - `*MSdob//`^&##MMMH\ d*' .,MMMMMMH#o>#ooMMMMMb HM- :HMMMMMMMMMMMMMMM&HM[R\ d"Z\. 9MMMMMMMMMMMMMMMMM[HMM|: -H - MMMMMMMMMMMMMMMMMMMbMP' : :??Mb# `9MMMMMMMMMMMMMMMMMMH#! . : MMMMH#, "*""""`#HMMMMMMMMMMH - ||MMMMMM6\. {MMMMMMMMMH' : :|MMMMMMMMMMHo `9MMMMMMMM' . . HMMMMMMMMMMP' !MMMMMMMM ` - `#MMMMMMMMM HMMMMMMM*,/ : : ?MMMMMMMF HMMMMMM',P' : . HMMMMR' {MMMMP' ^' - : `HMMMT iMMH' .' -.`HMH . -:*H . ' -`\,, . .- ' . _ .-` '`~\.__,obb#q==~'''  .ovr:HMM#?:`' >b\_ .,:&Hi' `' "' \\|&bSMHo_ oHMMM#*} `?&dMMMMMMHo. .dMMMH"'''' ,oHH*&&9MMMM?. ,MMM*' `*M\bd<|"*&#MH\ dHH?' :MMMMMM#bd#odMML H' |\ `dMMMMMMMMMMMMMM9Mk JL/"7+,. `MMMMMMMMMMMMMMMH9ML -`Hp ' |MMMMMMMMMMMMMMMMHH|: : \\#M#d? `HMMMMMMMMMMMMMMMMH. . JMMMMM##, ``*""'"*#MMMMMMMMH -. ,MMMMMMMM6o_ |MMMMMMMM': : |MMMMMMMMMMMMMb\ TMMMMMMT : . ?MMMMMMMMMMMMM' :MMMMMM|.` - ?HMMMMMMMMMM: HMMMMMM\|: : 9MMMMMMMMH' `MMMMMP.P. . `MMMMMMT'' HMMM*''- - TMMMMM' MM*' - '. HMM# - -. `9M: .' -. `b,, . . ' '-\ ., .-` '-:b~\\_,oddq==--"  _oo##'9MMHb':'-,o_ .oH":HH$' ""' "' -\7*R&o_ .oHMMMHMH#9: "\bMMMMHo. dMMMMMM*""'`' .oHM"H9MM?. ,MMMMMM' "HLbd<|?&H\ JMMH#H' |MMMMM#b>bHb :MH ."\ `|MMMMMMMMMMMM& .:M:d-"|:b.. 9MMMMMMMMMMMMM+ : "*H| - &MMMMMMMMMMMMMH: . `LvdHH#d? `?MMMMMMMMMMMMMb : iMMMMMMH#b `"*"'"#HMMMMMM . . ,MMMMMMMMMMb\. {MMMMMH - |MMMMMMMMMMMMMMHb, `MMMMM| : |MMMMMMMMMMMMMMH' &MMMM, - `#MMMMMMMMMMMM |MMMM6- : `MMMMMMMMMM+ ]MMMT/ . `MMMMMMMP" HMM*` - |MMMMMH' ,M#'- '. :MMMH| .- . |MM - ` . `#?.. . ..' -. _. .- '-|.#qo__,,ob=~~-''  _ooppH[`MMMD::--\_ _oHMR":&M&. ""' "' /&\\_ oHMMMMMHMMH#9, `"#&H6?*MMH:-.._ .oHMMMR:"&MZ\ `"' " |$-_ ..dMMMMMMMMdMMM#9\ `'HHo. . ,dMMMMMMMMMMM"`' ` ?MP?. . |MMMMMMMMMMM' `"$b&\ - |MMMMHH##M' HMMH? - TTMM| >.. \MMMMMH : |MM\,#-""$~b\. `MMMMMM+ . ``"H&# - &MMMMMM| : *\v,#MHddc. `9MMMMMb . MMMMMMMM##\ `"":HM - . .HMMMMMMMMMMRo_. |M : |MMMMMMMMMMMMMMMM#\ :M - `HMMMMMMMMMMMMMMM' |T : `*HMMMMMMMMMMMM' H' : MMMMMMMMMMM| |T . MMMMMMMM?' ./ `. MMMMMMH' ./ -. |MMMH#' . . `MM* . ' -. #M: . . .- ` . ., .- '-.-~ooHH__,,v~--`  _ood>H&H&Z?#M#b-\. .\HMMMMMR?`\M6b."`' ''``v. .. .MMMMMMMMMMHMMM#&. ``~o. . ,HMMMMMMMMMMMM*"'-` &b. . .MMMMMMMMMMMMH' `"&\ - RMMMMM#H##R' 4Mb - |7MMM' ?:: `|MMb / HMM__#|`"\>?v.. `MMML . `"'#Hd| ` 9MMM: - |\,\?HH#bbL `9MMb : !MMMMMMMH#b, `""T . . ,MMMMMMMMMMMbo. | : 4MMMMMMMMMMMMMMMHo | : ?MMMMMMMMMMMMMMM? : -. `#MMMMMMMMMMMM: .- : |MMMMMMMMMM? . - JMMMMMMMT' : `. MMMMMMH' - -. |MMM#*` - . HMH' . ' -. #H:. .- ` . .\ .- '-..-+oodHL_,--/-`  _,\?dZkMHF&$*q#b.. .//9MMMMMMM?:'HM\\"`-''`.. ..` :MMMMMMMMMMHMMMMH?_ `-\ . .dMMMMMMMMMMMMMM'"'" `\. . |MMMMMMMMMMMMMR \\ - T9MMMMMHH##M" `? : (9MMM' !':. &k .: HMM\_?p "":-b\. `ML - "'"H&#, : |M| : ?\,\dMH#b#. 9b : |MMMMMMM##, `* : . +MMMMMMMMMMMo_ - : HMMMMMMMMMMMMMM#, : : 9MMMMMMMMMMMMMH' . : . *HMMMMMMMMMMP .' : MMMMMMMMMH' . - :MMMMMMM'` . `. 9MMMMM*' - -. {MMM#' : - |MM" .' `. &M'.. . ..' ' . ._ .- '-. -voboo#&:,-.-`  _oo:\bk99M[<$$+b\. .$*"MMMMMMMM[:"\Mb\?^" . . '` HMMMMMMMMMMHMMMM+?. `. . .HMMMMMMMMMMMMMMP"'' . . `MMMMMMMMMMMMMM| -`. - `&MMMMMMHH##H: : : `(*MMM} `|\ | : `- ?MMb__#|""`|+v.. \ . `''*H#b - :| : `*\v,#M#b#, \ . 9MMMMMMHb. : : . #MMMMMMMMMb\ - - .HMMMMMMMMMMMMb : : `MMMMMMMMMMMMH . -: . `#MMMMMMMMMP ' : ]MMMMMMMH' : - ,MMMMMM?' . `: HMMMMH" - -. .HMM#* .- `. .HH*' . `-. &R". .- -. ._ .- '-. .voodoodc?..-`  _\oo\?ddk9MRbS>v\_ ..:>*""MMMMMMMMM:?|H?$?-. ..- - "HMMMMMMMMMMHMMMH\_-. . dMMMMMMMMMMMMMMT" . . TMMMMMMMMMMMMMM `. - `&HMMMMMM#H#H: . - `\7HMMH |\. . : ` HMM\_?c`""+?\.. : - "``#&#| . - : `?,\#MHdb. . : |MMMMMH#. : : . ,HMMMMMMMb, - : ' 4MMMMMMMMMMH` : . 9MMMMMMMMMT- :.` `#MMMMMMMH ' : ' HMMMMMH': - |MMMMH" - `: |MMMH*' .' '? dMM#' . \. .dH" .' -. ,M'- ..' ` . .. ..-` '-. .\ooooboo<^.-`  _o,:o?\?dM&MHcc~,. ..^':&#""HMMMMMMMM$:?&&?. .` -` 'HMMMMMMMMMHMMMp\. . ' |MMMMMMMMMMMMMM"' . . `9MMMMMMMMMMMMM -. - `*9MMMMMHH##[ . - `\Z9MMM `~\ . : '| ?MMb_?p""-?v.. : - `"'*&#, - . : `?,oHH#? . -- |MMMMH,: : . |MMMMMM6, : - |MMMMMMMM ? HMMMMMMP -- . ' |HMMMMM' :.` . ' JMMMM+ \ ,MMMP: : |MMH?: -:\. dM#" . \ ,H*' .' -. d':..' ` . .,.- '-.. .\oooodov~^-`  _o\:,??\??MR9#cb\_ .v/''':&#""#HMMMMMMM$?*d\. ..~' - -` `"#MMMMMMMMMMMHv. .-' HMMMMMMMMMMMR!. : `9MMMMMMMMMMM| -. . `*9MMMMMH##| . - `(#MMH `:, . : '| `HMb_>/"|\,.: .' `"'#&b - . : ?\oHH?. : !MMM& : . . HMMMM /. - -MMMMM \`. 9MMMP :. . . - |MMM' \... ' .MMT &. .dMP \, .HM* \. `\. ,H&' `- `| - ,&': `. ,/\ ' '-.. _.- "---.._\o,oov+--'"  _,d?,:?o?:?HM>#b\_ ..H*"''`'H#*"**MMMMMM6$$v_ v//" - `` `'#MMMMMMMMHo. /"` |MMMMMMMMMM:. ,> `HMMMMMMMMH:. : `#HMMMMHH\ - ' `Z#MM, `,: : '\ ?HH_>:`\, : "'*&| `: . <\Hb : MM : . iMM Mb\. {MM ::.`- - !MP `&. . . - :M' 9H, \ ' |T HM? ,P *ML ?? :&. `o .d' ': |T /" -. .<'' `... ..- "`-=.,_,,,oov-~.-`  _,oc>?_:b?o?HH#b\_ .v/99*""" '*H#""*HMMMMMZ,_ oH* /" - ' "`#MMMMM#o. ./*>- `MMMMMMMb ,b/' `#MMMMMMM\ :' ``HMMMMb: /- `|&MH `\ / `-. |Hb??\ ,- ' "`&,. 1 \} !. T $,. . 1 ?`M??. M ?.::| '\ - ? M?&. . . - ,' 9MMH\ .. ' ` . HMMM#. :' 9#MMb .. -:"# `b. .- . ` {! / - ,-' ' . .- ```^==\_.,,,ov--\-`  _\o##??,:io??$#b\_ .oH#"H9*""" "`#H*"*#MMMHo_ oHMM- -' - '' ``*HMMHo. dM#S>-` ?MMMM?. ,&&,/' "#MMMH\ d?-" `*HMMb H? "ZHb: /: \ H?L |:| . `*: :?: \ >" : M|\,_ | !|":HH?-'. : :^'_:?"\ `-- - . - |ML?b . .. - - :HMMMMH\ \ ` : >MMMMMM#. . ^M*HMMM| - `. `"#+ `?v .` . `- +?' - ` . ..' - . .- "`\b=p?.._\\vv---`  _,o#bH\??::?o?cbo_ .o#MH#**SH""' "`*H#"*#MHo_ oHMMMH^ ^" - ` '*HHo. .dMMM#">>- `HM?. ,MH:R_o/ `*MH\ dMM' ' "ML HMR! ' `#k d&'. -. `L :M :: ` `- /| !| - k.$-" : }9R:!,,_. . \::\':`*M#\-'. - : "''..:"!`\ '- - ` - ,HMb.H| . _ - .' : ,MMMMMMMb. .. . .`HMMMMMMMM? . `.`9M#*HMMMM : -.' "##* `b, . . ` ,/' .' ` . ..' - . ..- "`*#d##c.._\v----`  _,o#&oHb?\o::d?>\_ .oHHMMM#**$M""` "`*HH"#&o_ oHMMMMMMD' .'' - ' ``bo. .dMMMMMH*'/|- `\b. ,MMMM?T|_o/ `\\ dMMMMP '' `| HMMMH& - `\ /MH7' : -- : -:MM {. . . :i?' .!& . :{, o| ' : -T?9M\:-'o,_ . : \?::``"`?9MHo./.. - . '"`'^ _.`"!"^. `- - ` - ,bMM?.M\ . . - . .' : .oMMMMMMMMb. .. ` . . `HMMMMMMMMMMb - - 9MH*#HMMMMH .' '. ' `"*##' `b. : . ` .d'' .' -. . ' -. .-` "`*##H###:._\--.-`  _oo#H&d#b?\b:_>>\_ .oHMMMMMMH*"*9R"'-``*#P\-_ oHMMMMMMMMM$ ." ' `^- .dMMMMMMMMH*",?- '\. ,MMMMMMM:?}.,d' `. dMMMMMMMH /'' : HMMMMMMM&' - - dPTMMP>' : -. : |? -MM} .\ . J' ::*' -$L . : ?b .,H- ' : - |6.&MP:: !.,_. - : `\:: "' "`:"MM#,-^, - : - ````:' _.:"?``\ `- . : .?bMML.]# - _ ` . .' - .o#MMMMMMMMH\ \. . . - `HMMMMMMMMMMMH : `. `HMM#*#MMMMMH' - -. ' ``##*' i+ : - `' v/' .' `- ..' ' . .- "`*##HMH##:__,-.-`  _oo##Mbb&bo??o_>\_ .oHMMMMMMMMM**#?M*' "?*&.. oHMMMMMMMMMMMM4 `" - `. .dMMMMMMMMMMMM#"\?.- . ,MMMMMMMMMM}"9:_,d' -. dMMMMMMMMMMM| ^'' . &MMMMMMMMMMH\ - . :{M*"MMMPT"' : `-. : .'M' 'MMM. -T, . . - k i:?'' -|& . : ` -o& .,H- " : - `M:`HMP|:'!.o._. . : "<:::'<^ '"``9MH#,-^ . - - '''``''._.`"?`^| ^ - : : ?#dMM_.M? . . - ..' : ,ddMMMMMMMMMb. .. ' . . TMMMMMMMMMMMMM, : - ?MMH**#MMMMMH' : '. ' "`##*' &. : -. `' ,~" .' -. ..' ` . .- ```*##HMMMH#<:,..-`  _,dd#HMb&dHo?\?:\_ .oHMMMMMMMMMMMH***9P'`"\v. oHMMMMMMMMMMMMMMM> `' -. .dMMMMMMMMMMMMMMMH*'|~-' . ,MMMMMMMMMMMMM6>`H._,& -. dMMMMMMMMMMMMMMM| `" . H*MMMMMMMMMMMMMH&. - . d' HMM""&MMMPT'' :. `.- ,' MP `TMMM, |: . - | #: ? *" : &L : ! `' /?H ,#r `' : . ?M: HMM^<~->,o._ : : `9:::'`*-``':`9MHb,|-, ' : . `"''':' :_ ""!"^. `| : `. _dbHM6_|H. . . ' .' \ _odHMMMMMMMMH, .. ` : `- |MMMMMMMMMMMMM| : `. 9MMH**#MMMMMH' : -. ' "?##" d : . ' ,/" .' `.. ..' ` . .- '`"#HHMMMMM#<>..-`  _oo##bHMb&d#bd,>\_ .oHMMMMMMMMMMMMMM***9R"-.. oHMMMMMMMMMMMMMMMMMH\ ? `-. .dMMMMMMMMMMMMMMMMMMM#".}-' . ,MMMMMMMMMMMMMMMMM6/`H _o} -. dMMMMMMMMMMMMMMMMMMML `'' . HbP*HMMMMMMMMMMMMMMM*: - , dMH' `MMMP'"HMMMR'T" : : |H' -MR' `?MMMb P, . . 1& *| |.`*" .-`&| . M' " |\&| .,#~ "' : T :HL.|HMH\c~`|v,\_ : | `"|:::':`-`` '"MM#\-'. -: % ``'``'`' :_ '?'`| ``. : ||, ,#dMM?.M? . .` - ?\ .,odMMMMMMMMM? \ ` : / |MMMMMMMMMMMMM: .' `. TMMH#*9MMMMM* : -. ` "*#*' ,: . . ` .v'' .' `. ..' '- . .- "`\+HHMMMMMMHr~.-`  _,,>#b&HMHd&&bb>\_ _oHMMMMMMMMMMMMMMMMH**H:. oHMMMMMMMMMMMMMMMMMMMM#v`? `. .dMMMMMMMMMMMMMMMMMMMMMMH*`+| . ,MMMMMMMMMMMMMMMMMMMMMb|?+.,H -. ddHMMMMMMMMMMMMMMMMMMMMMb `' . HMMkZ**HMMMMMMMMMMMMMMMMH\ - . : dTMMM* `9MMMP'"*MMMMPT"` .. : |M6H'' 4MP' `"HMMM| !|. . . 1MHp' #L $ *"' .-:&. . MMM' " q:H. .o#-``' : MM' ?H?.|MMH::::-o,_. - M[ `*?:::'|` `"`:9MH\~-. ` &M. ""'`'^'.:.`?'`. '| -: `M|d, .dbHM[.1? .. : 9||| . _obMMMMMMMMH, . : H.^ MMMMMMMMMMMM} - \ |MMH#*HMMMMH' .' . ` `#*' ,:- ` '' .-'. `. .- '- . .-` '`\bqHMMMMMMHHb--`  .,:,#&6dHHHb&##o\_ .oHHMMMMMMMMMMMMMMMMMH*\,. oHMMMMMMMMMMMMMMMMMMMMMMHb:'-. .dMMMMMMMMMMMMMMMMMMMMMMMMMH|\/' . ,&HMMMMMMMMMMMMMMMMMMMMMMM/"&.,d. -. dboMMHMMMMMMMMMMMMMMMMMMMMMML `' . HMHMMM$Z***MMMMMMMMMMMMMMMMMM|.- . dMM}MMMM#' `9MMMH?"`MMMMR'T' _ : |MMMbM#'' |MM" ``MMMH. <_ . dMMMM#& *&. .?`*" .'&: . MMMMMH- `' -v/H .dD "' ' : MMMM* `*M: 4MM*::-!v,_ : MMMM `*?::" "'``"?9Mb::. : &MMM, `"'"'|"._ "?`| - : `MMM}.H ,#dM[_H ..: 9MMi`M: . .ooHMMMMMMM, .. 9Mb `- 1MMMMMMMMMM| : ?M |MM#*#MMMM* . -. ` |#"' ,' . -" v` -. .- - . . ` '-*#d#HHMMMMHH#"-'  _,<_:&S6dHHHb&bb\_ .odHMMMMMMMMMMMMMMMMMMM}-_ .oHMMMMMMMMMMMMMMMMMMMMMMMM#d:. ?9MMMMMMMMMMMMMMMMMMMMMMMMMMMH-$ . ,::dHMMMMMMMMMMMMMMMMMMMMMMMMH:\.?? -. dMdboHMMHMMMMMMMMMMMMMMMMMMMMMMH, ' . HMMMM7MMMb$R***MMMMMMMMMMMMMMMMMH\ - . dMMMMM/MMMMM* `$MMMM*'"*MMMM?&' . : |MMMMMMb1H*' HMP' '9MMM| &. . . dMMMMMMM##~` `#\ |.`*" .-9. : 9MMMMMMMM* ` |v7? .,H `' ` : SMMMMMMH' '9M_-MMH::-\v_ : :HMMMMM `\_:"'|'`':9Mv\. -|MMMMM, ""`'`':.`?\ \ `:MMMMM}.d} .?bM6,| | :?MMM6 M| . .,oHMMMMM| / .?MMM- `' &MMMMMMMM|. -`HM- HMH#*MMM?: '. ' `#*:` - -'/ ` . . ' ` . . ` '--##HH#HMMMHH#""`  _o,d_?dZdoHHHb#b\_ .vdMMMMMMMMMMMMMMMMMMMMH\. .,HHMMMMMMMMMMMMMMMMMMMMMMMMH&,. /?RMMMMMMMMMMMMMMMMMMMMMMMMMMMMH|.. ,\?>`T#RMMMMMMMMMMMMMMMMMMMMMMMM6`\|/ dMMbd#ooHMMMHMMMMMMMMMMMMMMMMMMMMMH,`' ' HMMMMMMMTMMMMb$ZP**HMMMMMMMMMMMMMMMM|. : dMMMMMMMM}$MMMMMH' `HMMMH?"`MMMM?T' . : |MMMMMMMMMMoMH*'' `MM? ``MMM| +\ . 1MMMMMMMMMMMb#/ ?#? |`#" -T: : *'HMMMMMMMMMM*' " ~?& .?} ' ' . - 4MMMMMMMMP" `M? HMTc:\\.: : `MMMMMMM[ "#:::`>`"?M{ . |MMMMMMH. ``'``'_`:- - |MMMMMMM|.dD ,#Mb\' : *MMMMM: iM| . _oHMMMM: . ?MMMM' "' ,MMMMMMP : `HMH JM#*MMT -. ' ` #' . / -. - .' -. . ` '--=&&MH##HMHH#"""  .-:?,Z?:&$dHH##b\_ ,:bqRMMMMMMMMMMMMMMMMMHo. .?HHHMMMMMMMMMMMMMMMMMMMMMMMHo. -o/*M9MMMMMMMMMMMMMMMMMMMMMMMMMMMv .:H\b\'|?#HHMMMMMMMMMMMMMMMMMMMMMM6?Z\ .?MMMHbdbbodMMMMHMMMMMMMMMMMMMMMMMMMM\': :MMMMMMMMMMM7MMMMb?6P**#MMMMMMMMMMMMMMM_ : \MMMMMMMMMMMMb^MMMMMM? `*MMMM*"`MMMR<' . - .1MMMMMMMMMMMMMb]M#"" 9MR' `?MMb \. : -MMMMMMMMMMMMMMMH##|` *&. |`*' .\ . -?""*MMMMMMMMMMMMM' ' |?b ,}" : : MMMMMMMMMMH' `M_|M}r\? . `MMMMMMMMM' `$_:`'"H - TMMMMMMMM, '"``:: : {MMMMMMMM| oH| .#M- : `9MMMMMM' .MP . ,oMMT . HMMMMP' `' ,MMMP - `MMH' HH9* '. ` ` .' - . ' ` . - .- ` . .- ' -==pHMMH##HH#"""  _..-:b&::&?&&##bo_ ...?-#&9MMMMMMMMMMMMMMMHo_ .. .1&#MMHMMMMMMMMMMMMMMMMMMMHo. . .o/##R9MMMMMMMMMMMMMMMMMMMMMMMM?. .- |MSd?|'`$?#HMMMMMMMMMMMMMMMMMMMMMH\ - dMMMMHbd##oodMMMM#MMMMMMMMMMMMMMMMMH: - JMMMMMMMMMMMMM7HMMMH$SR***MMMMMMMMMMMMb> : {MMMMMMMMMMMMMMM`9MMMMMH' ``HMMM?"*MM[| : - |MMMMMMMMMMMMMMMMM PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' try: # This allows coverage to measure code run in this process import coverage coverage.process_startup() except ImportError: pass import pexpect import sys def main(): p = pexpect.spawn(sys.executable + ' echo_w_prompt.py') p.interact() if __name__ == '__main__': main() pexpect-3.1/tests/test_expect.py0000755000175400017540000004364212223116137021210 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import with_statement # bring 'with' stmt to py25 import pexpect import unittest import subprocess import time import PexpectTestCase import sys #import pdb # Many of these test cases blindly assume that sequential directory # listings of the /bin directory will yield the same results. # This may not be true, but seems adequate for testing now. # I should fix this at some point. # query: For some reason an extra newline occures under OS X evey # once in a while. Excessive uses of .replace resolve these FILTER=''.join([(len(repr(chr(x)))==3) and chr(x) or '.' for x in range(256)]) def hex_dump(src, length=16): result=[] for i in xrange(0, len(src), length): s = src[i:i+length] hexa = ' '.join(["%02X"%ord(x) for x in s]) printable = s.translate(FILTER) result.append("%04X %-*s %s\n" % (i, length*3, hexa, printable)) return ''.join(result) def hex_diff(left, right): diff = ['< %s\n> %s' % (_left, _right,) for _left, _right in zip( hex_dump(left).splitlines(), hex_dump(right).splitlines()) if _left != _right] return '\n' + '\n'.join(diff,) class assert_raises_msg(object): def __init__(self, errtype, msgpart): self.errtype = errtype self.msgpart = msgpart def __enter__(self): pass def __exit__(self, etype, value, traceback): if value is None: raise AssertionError('Expected %s, but no exception was raised' \ % self.errtype) if not isinstance(value, self.errtype): raise AssertionError('Expected %s, but %s was raised' \ % (self.errtype, etype)) errstr = str(value) if self.msgpart not in errstr: raise AssertionError('%r was not in %r' % (self.msgpart, errstr)) return True class ExpectTestCase (PexpectTestCase.PexpectTestCase): def test_expect_basic (self): p = pexpect.spawn('cat') p.sendline (b'Hello') p.sendline (b'there') p.sendline (b'Mr. Python') p.expect (b'Hello') p.expect (b'there') p.expect (b'Mr. Python') p.sendeof () p.expect (pexpect.EOF) def test_expect_exact_basic (self): p = pexpect.spawn('cat') p.sendline (b'Hello') p.sendline (b'there') p.sendline (b'Mr. Python') p.expect_exact (b'Hello') p.expect_exact (b'there') p.expect_exact (b'Mr. Python') p.sendeof () p.expect_exact (pexpect.EOF) def test_expect_ignore_case(self): '''This test that the ignorecase flag will match patterns even if case is different using the regex (?i) directive. ''' p = pexpect.spawn('cat') p.sendline (b'HELLO') p.sendline (b'there') p.expect (b'(?i)hello') p.expect (b'(?i)THERE') p.sendeof () p.expect (pexpect.EOF) def test_expect_ignore_case_flag(self): '''This test that the ignorecase flag will match patterns even if case is different using the ignorecase flag. ''' p = pexpect.spawn('cat') p.ignorecase = True p.sendline (b'HELLO') p.sendline (b'there') p.expect (b'hello') p.expect (b'THERE') p.sendeof () p.expect (pexpect.EOF) def test_expect_order (self): '''This tests that patterns are matched in the same order as given in the pattern_list. (Or does it? Doesn't it also pass if expect() always chooses (one of the) the leftmost matches in the input? -- grahn) ... agreed! -jquast, the buffer ptr isn't forwarded on match, see first two test cases ''' p = pexpect.spawn('cat') self._expect_order(p) def test_expect_order_exact (self): '''Like test_expect_order(), but using expect_exact(). ''' p = pexpect.spawn('cat') p.expect = p.expect_exact self._expect_order(p) def _expect_order (self, p): # Disable echo so that the output we see is in an entirely predictable # order p.setecho(False) p.waitnoecho() p.sendline (b'1234') p.sendline (b'abcd') p.sendline (b'wxyz') p.sendline (b'7890') p.sendeof () index = p.expect ([ b'1234', b'abcd', b'wxyz', pexpect.EOF, b'7890' ]) assert index == 0, (index, p.before, p.after) index = p.expect ([ b'54321', pexpect.TIMEOUT, b'1234', b'abcd', b'wxyz', pexpect.EOF], timeout=5) assert index == 3, (index, p.before, p.after) index = p.expect ([ b'54321', pexpect.TIMEOUT, b'1234', b'abcd', b'wxyz', pexpect.EOF], timeout=5) assert index == 4, (index, p.before, p.after) index = p.expect ([ pexpect.EOF, b'abcd', b'wxyz', b'7890' ]) assert index == 3, (index, p.before, p.after) index = p.expect ([ b'abcd', b'wxyz', b'7890', pexpect.EOF]) assert index == 3, (index, p.before, p.after) def test_waitnoecho (self): ''' This tests that we can wait on a child process to set echo mode. For example, this tests that we could wait for SSH to set ECHO False when asking of a password. This makes use of an external script echo_wait.py. ''' p1 = pexpect.spawn('%s echo_wait.py' % self.PYTHONBIN) start = time.time() p1.waitnoecho(timeout=10) end_time = time.time() - start assert end_time < 10 and end_time > 2, "waitnoecho did not set ECHO off in the expected window of time." # test that we actually timeout and return False if ECHO is never set off. p1 = pexpect.spawn('cat') start = time.time() retval = p1.waitnoecho(timeout=4) end_time = time.time() - start assert end_time > 3, "waitnoecho should have waited longer than 2 seconds. retval should be False, retval=%d"%retval assert retval==False, "retval should be False, retval=%d"%retval # This one is mainly here to test default timeout for code coverage. p1 = pexpect.spawn('%s echo_wait.py' % self.PYTHONBIN) start = time.time() p1.waitnoecho() end_time = time.time() - start assert end_time < 10, "waitnoecho did not set ECHO off in the expected window of time." def test_expect_echo (self): '''This tests that echo can be turned on and off. ''' p = pexpect.spawn('cat', timeout=10) self._expect_echo(p) def test_expect_echo_exact (self): '''Like test_expect_echo(), but using expect_exact(). ''' p = pexpect.spawn('cat', timeout=10) p.expect = p.expect_exact self._expect_echo(p) def _expect_echo (self, p): p.sendline (b'1234') # Should see this twice (once from tty echo and again from cat). index = p.expect ([ b'1234', b'abcd', b'wxyz', pexpect.EOF, pexpect.TIMEOUT]) assert index == 0, "index="+str(index)+"\n"+p.before index = p.expect ([ b'1234', b'abcd', b'wxyz', pexpect.EOF]) assert index == 0, "index="+str(index) p.setecho(0) # Turn off tty echo p.sendline (b'abcd') # Now, should only see this once. p.sendline (b'wxyz') # Should also be only once. index = p.expect ([ pexpect.EOF, pexpect.TIMEOUT, b'abcd', b'wxyz', b'1234']) assert index == 2, "index="+str(index) index = p.expect ([ pexpect.EOF, b'abcd', b'wxyz', b'7890']) assert index == 2, "index="+str(index) p.setecho(1) # Turn on tty echo p.sendline (b'7890') # Should see this twice. index = p.expect ([pexpect.EOF,b'abcd',b'wxyz',b'7890']) assert index == 3, "index="+str(index) index = p.expect ([pexpect.EOF,b'abcd',b'wxyz',b'7890']) assert index == 3, "index="+str(index) p.sendeof() def test_expect_index (self): '''This tests that mixed list of regex strings, TIMEOUT, and EOF all return the correct index when matched. ''' #pdb.set_trace() p = pexpect.spawn('cat') self._expect_index(p) def test_expect_index_exact (self): '''Like test_expect_index(), but using expect_exact(). ''' p = pexpect.spawn('cat') p.expect = p.expect_exact self._expect_index(p) def _expect_index (self, p): p.setecho(0) p.sendline (b'1234') index = p.expect ([b'abcd',b'wxyz',b'1234',pexpect.EOF]) assert index == 2, "index="+str(index) p.sendline (b'abcd') index = p.expect ([pexpect.TIMEOUT,b'abcd',b'wxyz',b'1234',pexpect.EOF]) assert index == 1, "index="+str(index) p.sendline (b'wxyz') index = p.expect ([b'54321',pexpect.TIMEOUT,b'abcd',b'wxyz',b'1234',pexpect.EOF], timeout=5) assert index == 3, "index="+str(index) # Expect 'wxyz' p.sendline (b'$*!@?') index = p.expect ([b'54321',pexpect.TIMEOUT,b'abcd',b'wxyz',b'1234',pexpect.EOF], timeout=5) assert index == 1, "index="+str(index) # Expect TIMEOUT p.sendeof () index = p.expect ([b'54321',pexpect.TIMEOUT,b'abcd',b'wxyz',b'1234',pexpect.EOF], timeout=5) assert index == 5, "index="+str(index) # Expect EOF def test_expect (self): the_old_way = subprocess.Popen(args=['ls', '-l', '/bin'], stdout=subprocess.PIPE).communicate()[0].rstrip() p = pexpect.spawn('ls -l /bin') the_new_way = b'' while 1: i = p.expect ([b'\n', pexpect.EOF]) the_new_way = the_new_way + p.before if i == 1: break the_new_way = the_new_way.rstrip() the_new_way = the_new_way.replace(b'\r\n', b'\n' ).replace(b'\r', b'\n').replace(b'\n\n', b'\n').rstrip() the_old_way = the_old_way.replace(b'\r\n', b'\n' ).replace(b'\r', b'\n').replace(b'\n\n', b'\n').rstrip() assert the_old_way == the_new_way, hex_diff(the_old_way, the_new_way) def test_expect_exact (self): the_old_way = subprocess.Popen(args=['ls', '-l', '/bin'], stdout=subprocess.PIPE).communicate()[0].rstrip() p = pexpect.spawn('ls -l /bin') the_new_way = b'' while 1: i = p.expect_exact ([b'\n', pexpect.EOF]) the_new_way = the_new_way + p.before if i == 1: break the_new_way = the_new_way.replace(b'\r\n', b'\n' ).replace(b'\r', b'\n').replace(b'\n\n', b'\n').rstrip() the_old_way = the_old_way.replace(b'\r\n', b'\n' ).replace(b'\r', b'\n').replace(b'\n\n', b'\n').rstrip() assert the_old_way == the_new_way, hex_diff(the_old_way, the_new_way) p = pexpect.spawn('echo hello.?world') i = p.expect_exact(b'.?') self.assertEqual(p.before, b'hello') self.assertEqual(p.after, b'.?') def test_expect_eof (self): the_old_way = subprocess.Popen(args=['/bin/ls', '-l', '/bin'], stdout=subprocess.PIPE).communicate()[0].rstrip() p = pexpect.spawn('/bin/ls -l /bin') p.expect(pexpect.EOF) # This basically tells it to read everything. Same as pexpect.run() function. the_new_way = p.before the_new_way = the_new_way.replace(b'\r\n', b'\n' ).replace(b'\r', b'\n').replace(b'\n\n', b'\n').rstrip() the_old_way = the_old_way.replace(b'\r\n', b'\n' ).replace(b'\r', b'\n').replace(b'\n\n', b'\n').rstrip() assert the_old_way == the_new_way, hex_diff(the_old_way, the_new_way) def test_expect_timeout (self): p = pexpect.spawn('cat', timeout=5) p.expect(pexpect.TIMEOUT) # This tells it to wait for timeout. self.assertEqual(p.after, pexpect.TIMEOUT) def test_unexpected_eof (self): p = pexpect.spawn('ls -l /bin') try: p.expect('_Z_XY_XZ') # Probably never see this in ls output. except pexpect.EOF: pass else: self.fail ('Expected an EOF exception.') def _before_after(self, p): p.timeout = 5 p.expect(b'5') self.assertEqual(p.after, b'5') assert p.before.startswith(b'[0, 1, 2'), p.before p.expect(b'50') self.assertEqual(p.after, b'50') assert p.before.startswith(b', 6, 7, 8'), p.before[:20] assert p.before.endswith(b'48, 49, '), p.before[-20:] p.expect(pexpect.EOF) self.assertEqual(p.after, pexpect.EOF) assert p.before.startswith(b', 51, 52'), p.before[:20] assert p.before.endswith(b', 99]\r\n'), p.before[-20:] def test_before_after(self): '''This tests expect() for some simple before/after things. ''' p = pexpect.spawn('%s list100.py' % self.PYTHONBIN) self._before_after(p) def test_before_after_exact(self): '''This tests some simple before/after things, for expect_exact(). (Grahn broke it at one point.) ''' p = pexpect.spawn('%s list100.py' % self.PYTHONBIN) # mangle the spawn so we test expect_exact() instead p.expect = p.expect_exact self._before_after(p) def _ordering(self, p): p.timeout = 5 p.expect(b'>>> ') p.sendline('list(range(4*3))') self.assertEqual(p.expect([b'5,', b'5,']), 0) p.expect(b'>>> ') p.sendline(b'list(range(4*3))') self.assertEqual(p.expect([b'7,', b'5,']), 1) p.expect(b'>>> ') p.sendline(b'list(range(4*3))') self.assertEqual(p.expect([b'5,', b'7,']), 0) p.expect(b'>>> ') p.sendline(b'list(range(4*5))') self.assertEqual(p.expect([b'2,', b'12,']), 0) p.expect(b'>>> ') p.sendline(b'list(range(4*5))') self.assertEqual(p.expect([b'12,', b'2,']), 1) def test_ordering(self): '''This tests expect() for which pattern is returned when many may eventually match. I (Grahn) am a bit confused about what should happen, but this test passes with pexpect 2.1. ''' p = pexpect.spawn(self.PYTHONBIN) self._ordering(p) def test_ordering_exact(self): '''This tests expect_exact() for which pattern is returned when many may eventually match. I (Grahn) am a bit confused about what should happen, but this test passes for the expect() method with pexpect 2.1. ''' p = pexpect.spawn(self.PYTHONBIN) # mangle the spawn so we test expect_exact() instead p.expect = p.expect_exact self._ordering(p) def _greed(self, expect): # End at the same point: the one with the earliest start should win self.assertEqual(expect([b'3, 4', b'2, 3, 4']), 1) # Start at the same point: first pattern passed wins self.assertEqual(expect([b'5,', b'5, 6']), 0) # Same pattern passed twice: first instance wins self.assertEqual(expect([b'7, 8', b'7, 8, 9', b'7, 8']), 0) def _greed_read1(self, expect): # Here, one has an earlier start and a later end. When processing # one character at a time, the one that finishes first should win, # because we don't know about the other match when it wins. # If maxread > 1, this behaviour is currently undefined, although in # most cases the one that starts first will win. self.assertEqual(expect([b'1, 2, 3', b'2,']), 1) def test_greed(self): p = pexpect.spawn(self.PYTHONBIN + ' list100.py') self._greed(p.expect) p = pexpect.spawn(self.PYTHONBIN + ' list100.py', maxread=1) self._greed_read1(p.expect) def test_greed_exact(self): p = pexpect.spawn(self.PYTHONBIN + ' list100.py') self._greed(p.expect_exact) p = pexpect.spawn(self.PYTHONBIN + ' list100.py', maxread=1) self._greed_read1(p.expect_exact) def test_bad_arg(self): p = pexpect.spawn('cat') with assert_raises_msg(TypeError, 'must be one of'): p.expect(1) with assert_raises_msg(TypeError, 'must be one of'): p.expect([1, b'2']) with assert_raises_msg(TypeError, 'must be one of'): p.expect_exact(1) with assert_raises_msg(TypeError, 'must be one of'): p.expect_exact([1, b'2']) def test_timeout_none(self): p = pexpect.spawn('echo abcdef', timeout=None) p.expect('abc') p.expect_exact('def') p.expect(pexpect.EOF) if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(ExpectTestCase,'test') #fout = open('delete_me_1','wb') #fout.write(the_old_way) #fout.close #fout = open('delete_me_2', 'wb') #fout.write(the_new_way) #fout.close pexpect-3.1/tests/getch.py0000755000175400017540000000316512221132750017744 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import sys, tty, termios if hasattr(sys.stdin, 'buffer'): # Python 3: we want to read raw bytes stdin = sys.stdin.buffer else: stdin = sys.stdin def main(): print('READY') while True: try: val = ord(stdin.read(1)) except KeyboardInterrupt: val = 3 sys.stdout.write('%d\r\n' % (val,)) if val == 0: # StopIteration equivalent is ctrl+' ' (\x00, NUL) break if __name__ == '__main__': fd = sys.stdin.fileno() old_settings = termios.tcgetattr(fd) try: tty.setraw(sys.stdin.fileno()) main() finally: termios.tcsetattr(fd, termios.TCSADRAIN, old_settings) pexpect-3.1/tests/qa.py0000755000175400017540000000206712220666300017255 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import commands import signal signal.signal(signal.SIGCHLD, signal.SIG_IGN) print(commands.getoutput('/bin/ls -l')) pexpect-3.1/tests/__init__.py0000755000175400017540000000177312216111566020422 0ustar takluyvertakluyver00000000000000 ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' # __init__.py # The mere presence of this file makes the dir a package. pass pexpect-3.1/tests/test_ctrl_chars.py0000755000175400017540000001055212221130157022032 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function import pexpect import unittest import PexpectTestCase import time import sys if sys.version_info[0] >= 3: def byte(i): return bytes([i]) else: byte = chr class TestCtrlChars(PexpectTestCase.PexpectTestCase): def test_control_chars(self): '''This tests that we can send all 256 8-bit characters to a child process.''' child = pexpect.spawn('python getch.py') child.expect('READY', timeout=5) try: for i in range(1,256): child.send(byte(i)) child.expect ('%d\r\n' % (i,)) # This needs to be last, as getch.py exits on \x00 child.send(byte(0)) child.expect('0\r\n') child.expect(pexpect.EOF) except Exception: err = sys.exc_info()[1] msg = "Did not echo character value: " + str(i) + "\n" msg = msg + str(err) self.fail(msg) def test_sendintr (self): try: child = pexpect.spawn('python getch.py') child.expect('READY', timeout=5) child.sendintr() child.expect ('3\r\n') except Exception: err = sys.exc_info()[1] self.fail("Did not echo character value: 3, %s\n%s\n%s" % ( str(err), child.before, child.after,)) def test_bad_sendcontrol_chars (self): '''This tests that sendcontrol will return 0 for an unknown char. ''' child = pexpect.spawn('python getch.py') retval = child.sendcontrol('1') assert retval == 0, "sendcontrol() should have returned 0 because there is no such thing as ctrl-1." def test_sendcontrol(self): '''This tests that we can send all special control codes by name. ''' child = pexpect.spawn('python getch.py') # On slow machines, like Travis, the process is not ready in time to # catch the first character unless we wait for it. child.expect('READY', timeout=5) child.delaybeforesend = 0.05 for ctrl in 'abcdefghijklmnopqrstuvwxyz': assert child.sendcontrol(ctrl) == 1 val = ord(ctrl) - ord('a') + 1 try: child.expect_exact(str(val)+'\r\n', timeout=2) except: print(ctrl) raise # escape character assert child.sendcontrol('[') == 1 child.expect ('27\r\n') assert child.sendcontrol('\\') == 1 child.expect ('28\r\n') # telnet escape character assert child.sendcontrol(']') == 1 child.expect ('29\r\n') assert child.sendcontrol('^') == 1 child.expect ('30\r\n') # irc protocol uses this to underline ... assert child.sendcontrol('_') == 1 child.expect ('31\r\n') # the real "backspace is delete" assert child.sendcontrol('?') == 1 child.expect ('127\r\n') # NUL, same as ctrl + ' ' assert child.sendcontrol('@') == 1 child.expect ('0\r\n') # 0 is sentinel value to getch.py, assert exit: # causes child to exit, but, if immediately tested, # isalive() still returns True unless an artifical timer # is used. time.sleep(0.5) assert child.isalive() == False, child.isalive() assert child.exitstatus == 0 if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(TestCtrlChars,'test') pexpect-3.1/tests/pexpectTest.py0000755000175400017540000000433112220666300021160 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import os, time, pexpect, sys def getProcessResults(cmd, timeLimit=20): ''' executes 'cmd' as a child process and returns the child's output, the duration of execution, and the process exit status. Aborts if child process does not generate output for 'timeLimit' seconds. ''' output = "" startTime = time.time() child = pexpect.spawn(cmd, timeout=10) child.logfile = sys.stdout while 1: try: # read_nonblocking will add to 'outout' one byte at a time # newlines can show up as '\r\n' so we kill any '\r's which # will mess up the formatting for the viewer output += child.read_nonblocking(timeout=timeLimit).replace("\r","") except pexpect.EOF as e: print(str(e)) # process terminated normally break except pexpect.TIMEOUT as e: print(str(e)) output += "\nProcess aborted by FlashTest after %s seconds.\n" % timeLimit print(child.isalive()) child.kill(9) break endTime = time.time() child.close(force=True) duration = endTime - startTime exitStatus = child.exitstatus return (output, duration, exitStatus) cmd = "./ticker.py" result, duration, exitStatus = getProcessResults(cmd) print("result: %s" % result) print("duration: %s" % duration) print("exit-status: %s" % exitStatus) pexpect-3.1/tests/test_missing_command.py0000755000175400017540000000254612216111566023070 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import PexpectTestCase class MissingCommandTestCase (PexpectTestCase.PexpectTestCase): def testMissingCommand(self): try: i = pexpect.spawn ('ZXQYQZX') except Exception: pass else: self.fail('Expected an Exception.') if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(MissingCommandTestCase,'test') pexpect-3.1/tests/test_log.py0000755000175400017540000000717212220666300020476 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import os import tempfile import PexpectTestCase # the program cat(1) may display ^D\x08\x08 when \x04 (EOF, Ctrl-D) is sent _CAT_EOF = b'^D\x08\x08' class TestCaseLog(PexpectTestCase.PexpectTestCase): def test_log (self): log_message = 'This is a test.' filename = tempfile.mktemp() mylog = open(filename, 'wb') p = pexpect.spawn('echo', [log_message]) p.logfile = mylog p.expect(pexpect.EOF) p.logfile = None mylog.close() with open(filename, 'rb') as f: lf = f.read() os.unlink(filename) self.assertEqual(lf.rstrip(), log_message.encode('ascii')) def test_log_logfile_read (self): log_message = 'This is a test.' filename = tempfile.mktemp() mylog = open(filename, 'wb') p = pexpect.spawn('cat') p.logfile_read = mylog p.sendline(log_message) p.sendeof() p.expect(pexpect.EOF) p.logfile = None mylog.close() with open(filename, 'rb') as f: lf = f.read() os.unlink (filename) lf = lf.replace(_CAT_EOF, b'') self.assertEqual(lf, b'This is a test.\r\nThis is a test.\r\n') def test_log_logfile_send (self): log_message = b'This is a test.' filename = tempfile.mktemp() mylog = open (filename, 'wb') p = pexpect.spawn('cat') p.logfile_send = mylog p.sendline(log_message) p.sendeof() p.expect (pexpect.EOF) p.logfile = None mylog.close() with open(filename, 'rb') as f: lf = f.read() os.unlink(filename) lf = lf.replace(b'\x04', b'') self.assertEqual(lf.rstrip(), log_message) def test_log_send_and_received (self): '''The logfile should have the test message three time -- once for the data we sent. Once for the data that cat echos back as characters are typed. And once for the data that cat prints after we send a linefeed (sent by sendline). ''' log_message = 'This is a test.' filename = tempfile.mktemp() mylog = open(filename, 'wb') p = pexpect.spawn('cat') p.logfile = mylog p.sendline(log_message) p.sendeof() p.expect (pexpect.EOF) p.logfile = None mylog.close() with open(filename, 'rb') as f: lf = f.read() os.unlink(filename) lf = lf.replace(b'\x04', b'').replace(_CAT_EOF, b'') self.assertEqual(lf, b'This is a test.\nThis is a test.\r\nThis is a test.\r\n') if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(TestCaseLog,'test') pexpect-3.1/tests/test_timeout_pattern.py0000755000175400017540000000726712233531217023147 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import with_statement # bring 'with' stmt to py25 import pexpect import unittest import PexpectTestCase import sys class Exp_TimeoutTestCase(PexpectTestCase.PexpectTestCase): def test_matches_exp_timeout (self): '''This tests that we can raise and catch TIMEOUT. ''' try: raise pexpect.TIMEOUT("TIMEOUT match test") except pexpect.TIMEOUT: pass #print "Correctly caught TIMEOUT when raising TIMEOUT." else: self.fail('TIMEOUT not caught by an except TIMEOUT clause.') def test_pattern_printout (self): '''Verify that a TIMEOUT returns the proper patterns it is trying to match against. Make sure it is returning the pattern from the correct call.''' try: p = pexpect.spawn('cat') p.sendline('Hello') p.expect('Hello') p.expect('Goodbye',timeout=5) except pexpect.TIMEOUT: assert p.match_index == None else: self.fail("Did not generate a TIMEOUT exception.") def test_exp_timeout_notThrown (self): '''Verify that a TIMEOUT is not thrown when we match what we expect.''' try: p = pexpect.spawn('cat') p.sendline('Hello') p.expect('Hello') except pexpect.TIMEOUT: self.fail("TIMEOUT caught when it shouldn't be raised because we match the proper pattern.") def test_stacktraceMunging (self): '''Verify that the stack trace returned with a TIMEOUT instance does not contain references to pexpect.''' try: p = pexpect.spawn('cat') p.sendline('Hello') p.expect('Goodbye',timeout=5) except pexpect.TIMEOUT: err = sys.exc_info()[1] if err.get_trace().count("pexpect/__init__.py") != 0: self.fail("The TIMEOUT get_trace() referenced pexpect.py. " "It should only reference the caller.\n" + err.get_trace()) def test_correctStackTrace (self): '''Verify that the stack trace returned with a TIMEOUT instance correctly handles function calls.''' def nestedFunction (spawnInstance): spawnInstance.expect("junk", timeout=3) try: p = pexpect.spawn('cat') p.sendline('Hello') nestedFunction(p) except pexpect.TIMEOUT: err = sys.exc_info()[1] if err.get_trace().count("nestedFunction") == 0: self.fail("The TIMEOUT get_trace() did not show the call " "to the nestedFunction function.\n" + str(err) + "\n" + err.get_trace()) if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(Exp_TimeoutTestCase,'test') pexpect-3.1/tests/platform_tests/0000755000175400017540000000000012270016336021343 5ustar takluyvertakluyver00000000000000pexpect-3.1/tests/platform_tests/test_read.py0000755000175400017540000000143712216111566023700 0ustar takluyvertakluyver00000000000000import os, sys filename = os.tmpnam() print 'filename:', filename fd_out = os.open(filename, os.O_CREAT | os.O_WRONLY) print 'fd_out:', fd_out os.write (fd_out, 'This is a test.\n') os.close(fd_out) print print 'testing read on good fd...' fd_in = os.open (filename, os.O_RDONLY) print 'fd_in:', fd_in while 1: data_in = os.read(fd_in, 1) print 'data_in:', data_in if data_in == '': print 'data_in was empty' break #sys.exit(1) os.close(fd_in) print print print 'testing read on closed fd...' fd_in = os.open ('test_read.py', os.O_RDONLY) print 'fd_in:', fd_in while 1: data_in = os.read(fd_in, 1) print 'data_in:', data_in if data_in == '': print 'data_in was empty' break os.close(fd_in) d = os.read(fd_in, 1) # fd_in should be closed now... if s == '': print 'd is empty. good.' pexpect-3.1/tests/platform_tests/pexqa.py0000644000175400017540000000130412216155533023034 0ustar takluyvertakluyver00000000000000import os, sys import select import signal import traceback import time import re import struct from types import * import posix import pty import tty import termios import fcntl class s: def __init__(self, command, args=None, timeout=30): self.pid = self.child_fd = None try: #self.pid, self.child_fd = posix.forkpty() self.pid, self.child_fd = pty.fork() except OSError as e: raise Exception('pty fork() failed: ' + str(e)) if self.pid == 0: # Child os.execvp(command, args) # Parent print '1' x = s('ls', ['ls']) time.sleep(5) print '2' result = os.read (x.child_fd, 5555) print '3' print result print '4' pexpect-3.1/tests/platform_tests/test_control_terminal.py0000755000175400017540000000107212216111566026333 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import termios, fcntl, struct, os, sys def getwinsize(): s = struct.pack("HHHH", 0, 0, 0, 0) x = fcntl.ioctl(sys.stdout.fileno(), termios.TIOCGWINSZ, s) rows, cols = struct.unpack("HHHH", x)[:2] return rows, cols def setwinsize(r,c): # Assume ws_xpixel and ws_ypixel are zero. s = struct.pack("HHHH", r,c,0,0) x = fcntl.ioctl(sys.stdout.fileno(), termios.TIOCSWINSZ, s) print 'stdin tty:', os.ttyname(0) print 'stdout tty:', os.ttyname(1) print 'controlling terminal:', os.ctermid() print 'winsize %d,%d' % getwinsize() print 'ENDTEST' pexpect-3.1/tests/platform_tests/test_middle_buffer.py0000755000175400017540000000115712216111566025553 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python2 import expyct import time e = expyct.expyct ('/bin/sh -i') e.timeout=60 e.expect(['#', '\$']) e.send ('ls -la /\n') i = e.expect (['foo','(d[aeiou]v)']) print '\nRead before match>%s<' % e.before print 'Matched:>%s<' % e.matched print 'index:', i i = e.expect(['#', '\$']) print '\nRead before match>%s<' % e.before print 'Matched:>%s<' % e.matched print 'index:', i e.send('exit\n') print 'Sent exit' time.sleep(2) print 'isAlive:', e.isAlive() # This should test timeout... i = e.expect ('#####') print '\nRead before match>%s<' % e.before print 'Matched:>%s<' % e.matched print 'index:', i pexpect-3.1/tests/platform_tests/test2.py0000755000175400017540000000211412216155533022762 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import signal, os, time, errno def signal_handler (signum, frame): print 'Signal handler called with signal:', signum print 'signal.SIGCHLD=', signal.SIGKILL # Create a child process for us to kill. pid = os.fork() if pid == 0: time.sleep(10000) #signal.signal (signal.SIGCHLD, signal.SIG_IGN) signal.signal (signal.SIGCHLD, signal_handler) print 'Sending SIGKILL to child pid:', pid os.kill (pid, signal.SIGKILL) # SIGCHLD should interrupt sleep. # Note that this is a race. # It is possible that the signal handler will get called # before we try to sleep, but this has not happened yet. # But in that case we can only tell by order of printed output. interrupted = 0 try: time.sleep(10) except: print 'sleep was interrupted by signal.' interrupted = 1 if not interrupted: print 'ERROR. Signal did not interrupt sleep.' else: print 'Signal interrupted sleep. This is good.' # Let's see if the process is alive. try: os.kill(pid, 0) print 'Child is alive. This is ambiguous because it may be a Zombie.' except OSError as e: print 'Child appears to be dead.' pexpect-3.1/tests/platform_tests/CSIGNALTEST/0000755000175400017540000000000012270016336023123 5ustar takluyvertakluyver00000000000000pexpect-3.1/tests/platform_tests/CSIGNALTEST/test.c0000644000175400017540000000450612216111566024254 0ustar takluyvertakluyver00000000000000/* I built this with "gcc -lutil test.c -otest" */ #include /* include this before any other sys headers */ #include /* header for waitpid() and various macros */ #include /* header for signal functions */ #include /* header for fprintf() */ #include /* header for fork() */ #ifdef LINUX #include #else #include /* header for forkpty, compile with -lutil */ #endif void sig_chld(int); /* prototype for our SIGCHLD handler */ int main() { struct sigaction act; int pid; int fdm; char slave_name [20]; /* Assign sig_chld as our SIGCHLD handler. We don't want to block any other signals in this example We're only interested in children that have terminated, not ones which have been stopped (eg user pressing control-Z at terminal). Finally, make these values effective. If we were writing a real application, we would save the old value instead of passing NULL. */ act.sa_handler = sig_chld; sigemptyset(&act.sa_mask); act.sa_flags = SA_NOCLDSTOP; if (sigaction(SIGCHLD, &act, NULL) < 0) { fprintf(stderr, "sigaction failed\n"); return 1; } /* Do the Fork thing. */ pid = forkpty (&fdm, slave_name, NULL, NULL); /* pid = fork(); */ switch (pid) { case -1: fprintf(stderr, "fork failed\n"); return 1; break; case 0: /* Child process. */ printf ("This child output will cause trouble.\n"); _exit(7); break; default: /* Parent process. */ sleep(1); printf ("Child pid: %d\n", pid); sleep(10); /* let child finish -- crappy way to avoid race. */ break; } return 0; } void sig_chld(int signo) { int status, wpid, child_val; printf ("In sig_chld signal handler.\n"); /* Wait for any child without blocking */ wpid = waitpid (-1, & status, WNOHANG); printf ("\tWaitpid found status for pid: %d\n", wpid); if (wpid < 0) { fprintf(stderr, "\twaitpid failed\n"); return; } printf("\tWaitpid status: %d\n", status); if (WIFEXITED(status)) /* did child exit normally? */ { child_val = WEXITSTATUS(status); printf("\tchild exited normally with status %d\n", child_val); } printf ("End of sig_chld.\n"); } pexpect-3.1/tests/platform_tests/test.py0000755000175400017540000000406612216155533022710 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import signal, os, time, errno, pty def signal_handler (signum, frame): print 'Signal handler called with signal:', signum print 'signal.SIGCHLD=', signal.SIGKILL # First thing we do is set up a handler for SIGCHLD. signal.signal (signal.SIGCHLD, signal.SIG_IGN) print 'PART 1 -- Test signal handling with empty pipe.' # Create a child process for us to kill. try: pid, fd = pty.fork() except Exception as e: print str(e) if pid == 0: # os.write (sys.stdout.fileno(), 'This is a test.\n This is a test.') time.sleep(10000) print 'Sending SIGKILL to child pid:', pid os.kill (pid, signal.SIGKILL) # SIGCHLD should interrupt sleep. # Note that this is a race. # It is possible that the signal handler will get called # before we try to sleep, but this has not happened yet. # But in that case we can only tell by order of printed output. print 'Entering sleep...' try: time.sleep(10) except: print 'sleep was interrupted by signal.' # Just for fun let's see if the process is alive. try: os.kill(pid, 0) print 'Child is alive. This is ambiguous because it may be a Zombie.' except OSError as e: print 'Child appears to be dead.' print 'PART 2 -- Test signal handling with full pipe.' # Create a child process for us to kill. try: pid, fd = pty.fork() except Exception as e: print str(e) if pid == 0: os.write (sys.stdout.fileno(), 'This is a test.\n This is a test.') time.sleep(10000) print 'Sending SIGKILL to child pid:', pid os.kill (pid, signal.SIGKILL) # SIGCHLD should interrupt sleep. # Note that this is a race. # It is possible that the signal handler will get called # before we try to sleep, but this has not happened yet. # But in that case we can only tell by order of printed output. print 'Entering sleep...' try: time.sleep(10) except: print 'sleep was interrupted by signal.' # Just for fun let's see if the process is alive. try: os.kill(pid, 0) print 'Child is alive. This is ambiguous because it may be a Zombie.' except OSError as e: print 'Child appears to be dead.' pexpect-3.1/tests/platform_tests/test_signals.py0000755000175400017540000000316412216155533024426 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import signal, os, time, errno, pty, sys GLOBAL_SIGCHLD_RECEIVED = 0 def signal_handler (signum, frame): print '' global GLOBAL_SIGCHLD_RECEIVED status = os.waitpid (-1, os.WNOHANG) print 'WIFEXITED(status):', os.WIFEXITED(status) print 'WEXITSTATUS(status):', os.WEXITSTATUS(status) GLOBAL_SIGCHLD_RECEIVED = 1 def main (): # sig_test ('SIG_IGN', 'ptyfork', 'yes') sig_test ('handler', 'ptyfork', 'yes') # sig_test ('SIG_IGN', 'ptyfork', 'no') # sig_test ('handler', 'ptyfork', 'no') # sig_test ('SIG_IGN', 'osfork', 'yes') # sig_test ('handler', 'osfork', 'yes') # sig_test ('SIG_IGN', 'osfork', 'no') # sig_test ('handler', 'osfork', 'no') def sig_test (sig_handler_type, fork_type, child_output): print 'Testing with:' print '\tsig_handler_type:', sig_handler_type print '\tfork_type:', fork_type print '\tchild_output:', child_output if sig_handler_type == 'SIG_IGN': signal.signal (signal.SIGCHLD, signal.SIG_IGN) else: signal.signal (signal.SIGCHLD, signal_handler) pid = -1 fd = -1 if fork_type == 'ptyfork': pid, fd = pty.fork() else: pid = os.fork() if pid == 0: if child_output == 'yes': os.write (sys.stdout.fileno(), 'This is a test.\nThis is a test.') time.sleep(10000) #print 'Sending SIGKILL to child pid:', pid time.sleep(2) os.kill (pid, signal.SIGKILL) #print 'Entering to sleep...' try: time.sleep(2) except: pass try: os.kill(pid, 0) print '\tChild is alive. This is ambiguous because it may be a Zombie.' except OSError as e: print '\tChild appears to be dead.' # print str(e) print if __name__ == '__main__': main () pexpect-3.1/tests/platform_tests/test_killed_pid.py0000755000175400017540000000057112216111566025063 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import os, time, signal import expyct e = expyct.expyct ('/bin/sh', '-i') print 'pid,fd:', e.pid, e.fd print 'isAlive:', e.isAlive() # Treat it brusquely. print 'sending SIGKILL...' os.kill (e.pid, signal.SIGKILL) time.sleep (1) print os.read(e.fd, 1000) print 'isAlive:', e.isAlive() e.expect('\#') e.send ('ls -la /\n') r,m,i = e.expect ('\#') print r pexpect-3.1/tests/platform_tests/test_handler.py0000755000175400017540000000307112216155533024400 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import signal, os, time, errno, pty, sys, fcntl, tty GLOBAL_SIGCHLD_RECEIVED = 0 def nonblock (fd): # if O_NDELAY is set read() returns 0 (ambiguous with EOF). # if O_NONBLOCK is set read() returns -1 and sets errno to EAGAIN original_flags = fcntl.fcntl (fd, fcntl.F_GETFL, 0) flags = original_flags | os.O_NONBLOCK fcntl.fcntl(fd, fcntl.F_SETFL, flags) return original_flags def signal_handler (signum, frame): print '' global GLOBAL_SIGCHLD_RECEIVED status = os.waitpid (-1, os.WNOHANG) if status[0] == 0: print 'No process for waitpid:', status else: print 'Status:', status print 'WIFEXITED(status):', os.WIFEXITED(status[1]) print 'WEXITSTATUS(status):', os.WEXITSTATUS(status[1]) GLOBAL_SIGCHLD_RECEIVED = 1 def main (): signal.signal (signal.SIGCHLD, signal_handler) pid, fd = pty.fork() if pid == 0: os.write (sys.stdout.fileno(), 'This is a test.\nThis is a test.') time.sleep(10000) nonblock (fd) tty.setraw(fd) #STDIN_FILENO) print 'Sending SIGKILL to child pid:', pid time.sleep(2) os.kill (pid, signal.SIGKILL) print 'Entering to sleep...' try: time.sleep(2) except: print 'Sleep interrupted' try: os.kill(pid, 0) print '\tChild is alive. This is ambiguous because it may be a Zombie.' except OSError as e: print '\tChild appears to be dead.' # print str(e) print print 'Reading from master fd:', os.read (fd, 1000) if __name__ == '__main__': main () pexpect-3.1/tests/platform_tests/test_badfork.py0000755000175400017540000000050412216111566024367 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python import pexpect import pyunit def main (): pid, fd = fooork ('aThelaDSjd','-i') print 'pid', pid print 'fd', fd Xexpect(fd, 'bash.*#',10) os.write(fd, 'scp -P 6666 *.py noah@gw.tiered.com:pexpect/\n') Xexpect(fd, 'bash.*#',10) os.write(fd, 'exit\n') print _my_read (fd, 1000, 5) sys.exit (1) pexpect-3.1/tests/platform_tests/README0000644000175400017540000000023112216111566022220 0ustar takluyvertakluyver00000000000000These are tests that are not yet pyunit tests or are not intended to be pyunit tests. Anything not part of the Python unittest framework should go here. pexpect-3.1/tests/test_interact.py0000755000175400017540000000454512221114277021531 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function from __future__ import unicode_literals import pexpect import unittest import PexpectTestCase class InteractTestCase (PexpectTestCase.PexpectTestCase): def test_interact (self): p = pexpect.spawn(str('%s interact.py' % (self.PYTHONBIN,))) p.expect('') p.sendline (b'Hello') p.sendline (b'there') p.sendline (b'Mr. Python') p.expect (b'Hello') p.expect (b'there') p.expect (b'Mr. Python') assert p.isalive() p.sendeof () p.expect (pexpect.EOF) assert not p.isalive() assert p.exitstatus == 0, (p.exitstatus, p.before) def test_interact_unicode (self): p = pexpect.spawnu(str('%s interact_unicode.py' % (self.PYTHONBIN,))) try: p.expect('') p.sendline ('Hello') p.sendline ('theré') p.sendline ('Mr. Pyþon') p.expect ('Hello') p.expect ('theré') p.expect ('Mr. Pyþon') assert p.isalive() p.sendeof () p.expect (pexpect.EOF) assert not p.isalive() assert p.exitstatus == 0, (p.exitstatus, p.before) except: print(p.before) raise if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(InteractTestCase, 'test') pexpect-3.1/tests/README0000644000175400017540000000144212216111566017157 0ustar takluyvertakluyver00000000000000 The best way to run these tests is from the directory above this one. Source the test.env environment file. This will make sure that you are using the correct pexpect.py file otherwise Python might try to import a different version if it is already installed in this environment. Then run the testall.py script in the tools/ directory. This script will automatically build a test suite from all the test scripts in the tests/ directory. This allows you to add new test scripts simply by dropping them in the tests/ directory. You don't have to register the test or do anything else to integrate it into the test suite. For example, this is the normal set of commands you would use to run all tests in the tests/ directory: $ cd /home/user/pexpect_dev/ $ . test.env $ ./tools/testall.py pexpect-3.1/tests/test_dotall.py0000755000175400017540000000325112220666137021176 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' import pexpect import unittest import re import PexpectTestCase testdata = 'BEGIN\nHello world\nEND' class TestCaseDotall(PexpectTestCase.PexpectTestCase): def test_dotall (self): p = pexpect.spawn('echo "%s"' % testdata) i = p.expect ([b'BEGIN(.*)END', pexpect.EOF]) assert i==0, 'DOTALL does not seem to be working.' def test_precompiled (self): p = pexpect.spawn('echo "%s"' % testdata) pat = re.compile(b'BEGIN(.*)END') # This overrides the default DOTALL. i = p.expect ([pat, pexpect.EOF]) assert i==1, 'Precompiled pattern to override DOTALL does not seem to be working.' if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(TestCaseDotall,'test') pexpect-3.1/tests/alarm_die.py0000644000175400017540000000011412232544730020562 0ustar takluyvertakluyver00000000000000import signal, time signal.alarm(1) # Schedule SIGALRM in 1s time.sleep(6)pexpect-3.1/tests/test_ansi.py0000755000175400017540000001732312220666300020646 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python ''' PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from pexpect import ANSI import unittest import PexpectTestCase write_target = 'I\'ve got a ferret sticking up my nose. \n' +\ '(He\'s got a ferret sticking up his nose.) \n' +\ 'How it got there I can\'t tell \n' +\ 'But now it\'s there it hurts like hell \n' +\ 'And what is more it radically affects my sense of smell. \n' +\ '(His sense of smell.) ' write_text = 'I\'ve got a ferret sticking up my nose.\n' + \ '(He\'s got a ferret sticking up his nose.)\n' + \ 'How it got there I can\'t tell\n' + \ 'But now it\'s there it hurts like hell\n' + \ 'And what is more it radically affects my sense of smell.\n' + \ '(His sense of smell.)\n' + \ 'I can see a bare-bottomed mandril.\n' + \ '(Slyly eyeing his other nostril.)\n' + \ 'If it jumps inside there too I really don\'t know what to do\n' + \ 'I\'ll be the proud posessor of a kind of nasal zoo.\n' + \ '(A nasal zoo.)\n' + \ 'I\'ve got a ferret sticking up my nose.\n' + \ '(And what is worst of all it constantly explodes.)\n' + \ '"Ferrets don\'t explode," you say\n' + \ 'But it happened nine times yesterday\n' + \ 'And I should know for each time I was standing in the way.\n' + \ 'I\'ve got a ferret sticking up my nose.\n' + \ '(He\'s got a ferret sticking up his nose.)\n' + \ 'How it got there I can\'t tell\n' + \ 'But now it\'s there it hurts like hell\n' + \ 'And what is more it radically affects my sense of smell.\n' + \ '(His sense of smell.)' tetris_target=' XX XXXX XX \n' +\ ' XXXXXX XXXXXXXX XX \n' +\ ' XXXXXX XXXXXXXX XX \n' +\ ' XX XX XX XXXX XX \n' +\ ' XXXXXX XXXX XXXX XX \n' +\ ' XXXXXXXXXX XXXX XX \n' +\ ' XX XXXXXX XX XX \n' +\ ' XXXXXX XX XX \n' +\ ' XXXX XXXXXX XX XX \n' +\ ' XXXXXX XXXX XX XX \n' +\ ' XX XX XXXX XX XX \n' +\ ' XX XX XX XX XX \n' +\ ' XX XX XXXX XXXX XX \n' +\ ' XXXXXXXX XXXX XXXX XX \n' +\ ' XXXXXXXXXXXXXX XXXXXXXX \n' +\ ' XX XXXXXXXX XX XX \n' +\ ' XXXXXXXXXXXXXX XX XX \n' +\ ' XX XXXX XXXXXX XX \n' +\ ' XXXXXX XXXXXXXX \n' +\ ' XXXXXXXXXX XX XX \n' +\ ' XXXXXXXXXXXXXXXXXXXXXXXX \n' +\ ' \n' +\ ' J->LEFT K->ROTATE L->RIGHT SPACE->DROP P->PAUSE Q->QUIT \n' +\ ' ' torture_target='+--------------------------------------------------------------------------------+\n' +\ '|a`opqrs` This is the `srqpo`a |\n' +\ '|VT100 series Torture Test Demonstration. |\n' +\ '|VT100 series Torture Test Demonstration. |\n' +\ '|This is a normal line __________________________________________________y_ |\n' +\ '|This is a bold line (normal unless the Advanced Video Option is installed) |\n' +\ '|This line is underlined _ " " " " " " _y_ |\n' +\ '|This is a blinking line _ " " " " " " _y_ |\n' +\ '|This is inverse video _ (underlined if no AVO and cursor is underline) _y_ |\n' +\ '|Normal gjpqy Underline Blink Underline+Blink gjpqy |\n' +\ '|Bold gjpqy Underline Blink Underline+Blink gjpqy |\n' +\ '|Inverse Underline Blink Underline+Blink |\n' +\ '|Bold+Inverse Underline Blink Underline+Blink |\n' +\ '|This is double width |\n' +\ '|This is double height |\n' +\ '|This is double height |\n' +\ '|_ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ioy |\n' +\ '|_ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ioy |\n' +\ '|_ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ioy |\n' +\ '|`abcdefghijklmnopqrstuvwxyz{|}~ lqwqk |\n' +\ '|`abcdefghijklmnopqrstuvwxyz{|}~ tqnqu |\n' +\ '|`abcdefghijklmnopqrstuvwxyz{|}~ tqnqu |\n' +\ '|`abcdefghijklmnopqrstuvwxyz{|}~ mqvqj |\n' +\ '| This test created by Joe Smith, 8-May-85 |\n' +\ '| |\n' +\ '+--------------------------------------------------------------------------------+\n' class ansiTestCase (PexpectTestCase.PexpectTestCase): def test_write (self): s = ANSI.ANSI (6,65) s.fill('.') s.cursor_home() for c in write_text: s.write (c) assert str(s) == write_target def test_torturet (self): s = ANSI.ANSI (24,80) with open('torturet.vt') as f: sample_text = f.read() for c in sample_text: s.process (c) assert s.pretty() == torture_target, 'processed: \n' + s.pretty() + '\nexpected:\n' + torture_target def test_tetris (self): s = ANSI.ANSI (24,80) with open('tetris.data') as f: tetris_text = f.read() for c in tetris_text: s.process (c) assert str(s) == tetris_target if __name__ == '__main__': unittest.main() suite = unittest.makeSuite(ansiTestCase,'test') pexpect-3.1/tests/log0000644000175400017540000000034212267624064017011 0ustar takluyvertakluyver00000000000000\,ESC ;,NUMBER_X P,ESC \,ESC Nonprint: 7 Nonprint: 7 Nonprint: 7 P,ESC \,ESC P,ESC \,ESC P,ESC \,ESC r,SEMICOLON \,ESC ;,NUMBER_X P,ESC \,ESC Nonprint: 7 Nonprint: 7 Nonprint: 7 P,ESC \,ESC P,ESC \,ESC P,ESC \,ESC r,SEMICOLON pexpect-3.1/tests/tetris.data0000644000175400017540000002064012216111566020445 0ustar takluyvertakluyver00000000000000  J->LEFT K->ROTATE L->RIGHT SPACE->DROP P->PAUSE Q->QUIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXX XXXXXXXXXX XXXXXXXXXX XXXXXXXXXXXX XX XXXXXXXXXXXX XXXX XX XXXXXXXXXXXXXXXX XXXXXXXXXX XXXXXXXXXXXXXXXXXXXX XXXXXXXX XX XXXX XXXXXXXX XX XXXX XX XXXX XX XXXXXXXXXXXXXXXX XXXXXXXX XXXXXXXX  XXXXXXXXXXXXXXXXXXXX XXXXXXXX XX XXXX XX XXXX XXXXXXXXXX   XXXXXX XXXXXX XX  XXXXXXXX  XXXXXXXXXXXXXXXX XXXXXXXXXX XX XX  XXXXXXXXXX XX XXXX XX XXXX  XXXXXXXXXX  XXXXXXXXXXXXXXXXXXXX XX XXXX XXXXXXXX XX XXXX XX XXXX XX XXXX XXXXXXXXXXXX  XXXXXXXXXXXXXXXXXXXXXX XX XXXXXXXXXXXX XXXX XXXXXXXXXX XXXXXXXXXX XXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXX XXXXXXXXXX XX XXXX XX XXXX XX XXXX XXXXXX  XXXXXXXXXXXXXXXXXXXXXX XX XX XXXXXXXXXX XX XXXX XX XXXXXXXX  XXXXXXXXXXXXXXXXXXXX XXXX XXXXXXXXXXXX  XXXXXX XXXX XXXXXX  XXXX  XXXXXX XXXX    XXXXXXXXXXXXXXXXXXXXXX XX XXXX XX XX XX XXXXXXXX XX XX XXXX XX   XXXXXXXX  XXXXXXXXXXXXXXXXXXXX XXXX  XXXXXX XX XX XXXXXXXX XXXXXX  XX XXXXXX  XXXXXX XXXX    XXXXXXXXXXXXXXXXXXXX   XXXXXXXX XX XXXXXX XX XXXXXXXXXX XX XXXXXX   XXXXXX XX XX XX XXXXXX   XXXXXXXXXXXXXXXXXXXX  XX XXXXXX XX XXXXXXXX XX  XXXXXX   XXXXXXXXXXXXXXXXXXXX XX XXXX XXXXXXXXXX   XXXXXX XX XX XXXX XXXXXX XX XX XXXX  XXXXXXXXXXXX   XXXX   XXXXXXXXXXXXXXXXXX XXXXXX XX XX XXXXXXXX XX XXXX XX XX XX XXXXXX XX XX XX  XXXXXX   XXXXXXXXXXXXXXXXXX XXXXXXXXXXXX XX XXXXXX XX XXXXXX XXXXXX  XXXXXXXXXXXXXXXX XXXXXXXX  XX XXXXXX XXXXXX   XXXXXXXXXXXXXXXXXXXX  XXXXXXXXXXXXXXXXXXXX XXXXXX XX XX XXXXXXXX XX XXXX XX XX  XXXXXXXXXXXXXXXXXXXX XX XXXX  XX XX XX XXXXXXXX XX XXXXXXXX XX XXXX XX  XXXXXXXXXXXXXXXX XXXX XXXXXXXX XX XX XXXX XX XXXX XX XX XX XXXX  XXXXXXXX XX XX XX   XXXXXXXXXXXXXXXXXXXX XX XXXX  XX XX XX XXXXXXXXXXXXXXXX XXXX  XXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXX XX XXXXXX XX XX XXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXX pexpect-3.1/PKG-INFO0000644000175400017540000000251512270016336016233 0ustar takluyvertakluyver00000000000000Metadata-Version: 1.1 Name: pexpect Version: 3.1 Summary: Pexpect allows easy control of interactive console applications. Home-page: http://pexpect.readthedocs.org/ Author: Noah Spurrier; Thomas Kluyver; Jeff Quast Author-email: noah@noah.org; thomas@kluyver.me.uk; contact@jeffquast.com License: ISC license Description: UNKNOWN Platform: UNIX Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Intended Audience :: Developers Classifier: Intended Audience :: System Administrators Classifier: License :: OSI Approved :: ISC License (ISCL) Classifier: Operating System :: POSIX Classifier: Operating System :: MacOS :: MacOS X Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Topic :: Software Development Classifier: Topic :: Software Development :: Libraries :: Python Modules Classifier: Topic :: Software Development :: Quality Assurance Classifier: Topic :: Software Development :: Testing Classifier: Topic :: System Classifier: Topic :: System :: Archiving :: Packaging Classifier: Topic :: System :: Installation/Setup Classifier: Topic :: System :: Shells Classifier: Topic :: System :: Software Distribution Classifier: Topic :: Terminals pexpect-3.1/fdpexpect.py0000644000175400017540000000031112216710010017450 0ustar takluyvertakluyver00000000000000import warnings warnings.warn("This module has been moved to pexpect.fdpexpect, please update imports.", ImportWarning) del warnings from pexpect.fdpexpect import * # analysis:ignorepexpect-3.1/test.env0000644000175400017540000000244512235765427016646 0ustar takluyvertakluyver00000000000000# Source this file to work on the project. # You should source this from the project root directory # in order to make tests work properly. export PATH=$PATH:tools/ export PROJECT_PEXPECT_HOME=`pwd` export PYTHONPATH=$PROJECT_PEXPECT_HOME:$PYTHONPATH export PYTHONIOENCODING=utf-8 alias testall="trace.py --missing --count --summary tools/testall.py" # # PEXPECT LICENSE # # This license is approved by the OSI and FSF as GPL-compatible. # http://opensource.org/licenses/isc-license.txt # # Copyright (c) 2012, Noah Spurrier # PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY # PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE # COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # pexpect-3.1/LICENSE0000644000175400017540000000164312216111566016145 0ustar takluyvertakluyver00000000000000PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. pexpect-3.1/doc/0000755000175400017540000000000012270016336015700 5ustar takluyvertakluyver00000000000000pexpect-3.1/doc/conf.py0000644000175400017540000001770512270006372017210 0ustar takluyvertakluyver00000000000000# -*- coding: utf-8 -*- # # Pexpect documentation build configuration file, created by # sphinx-quickstart on Tue Sep 17 11:05:11 2013. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('sphinxext')) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', 'github', # for easy GitHub links ] github_project_url = "https://github.com/pexpect/pexpect" # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Pexpect' copyright = u'2013, Noah Spurrier and contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '3.1' # The full version, including alpha/beta/rc tags. release = '3.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'Pexpectdoc' # -- Options for LaTeX output -------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'Pexpect.tex', u'Pexpect Documentation', u'Noah Spurrier and contributors', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'pexpect', u'Pexpect Documentation', [u'Noah Spurrier and contributors'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'Pexpect', u'Pexpect Documentation', u'Noah Spurrier and contributors', 'Pexpect', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/3/': None} pexpect-3.1/doc/history.rst0000644000175400017540000002014112270007255020131 0ustar takluyvertakluyver00000000000000History ======= Releases -------- Version 3.1 ``````````` * Fix an issue that prevented importing pexpect on Python 3 when ``sys.stdout`` was reassigned (:ghissue:`30`). * Improve prompt synchronisation in :mod:`~pexpect.pxssh` (:ghpull:`28`). * Fix pickling exception instances (:ghpull:`34`). * Fix handling exceptions from :func:`select.select` on Python 3 (:ghpull:`33`). The examples have also been cleaned up somewhat - this will continue in future releases. Version 3.0 ``````````` The new major version number doesn't indicate any deliberate API incompatibility. We have endeavoured to avoid breaking existing APIs. However, pexpect is under new maintenance after a long dormancy, so some caution is warranted. * A new :ref:`unicode API ` was introduced. * Python 3 is now supported, using a single codebase. * Pexpect now requires at least Python 2.6 or 3.2. * The modules other than pexpect, such as :mod:`pexpect.fdpexpect` and :mod:`pexpect.pxssh`, were moved into the pexpect package. For now, wrapper modules are installed to the old locations for backwards compatibility (e.g. ``import pxssh`` will still work), but these will be removed at some point in the future. * Ignoring ``SIGHUP`` is now optional - thanks to Kimmo Parviainen-Jalanko for the patch. We also now have `docs on ReadTheDocs `_, and `continuous integration on Travis CI `_. Version 2.4 ``````````` * Fix a bug regarding making the pty the controlling terminal when the process spawning it is not, actually, a terminal (such as from cron) Version 2.3 ``````````` * Fixed OSError exception when a pexpect object is cleaned up. Previously, you might have seen this exception:: Exception exceptions.OSError: (10, 'No child processes') in > ignored You should not see that anymore. Thanks to Michael Surette. * Added support for buffering reads. This greatly improves speed when trying to match long output from a child process. When you create an instance of the spawn object you can then set a buffer size. For now you MUST do the following to turn on buffering -- it may be on by default in future version:: child = pexpect.spawn ('my_command') child.maxread=1000 # Sets buffer to 1000 characters. * I made a subtle change to the way TIMEOUT and EOF exceptions behave. Previously you could either expect these states in which case pexpect will not raise an exception, or you could just let pexpect raise an exception when these states were encountered. If you expected the states then the ``before`` property was set to everything before the state was encountered, but if you let pexpect raise the exception then ``before`` was not set. Now, the ``before`` property will get set either way you choose to handle these states. * The spawn object now provides iterators for a *file-like interface*. This makes Pexpect a more complete file-like object. You can now write code like this:: child = pexpect.spawn ('ls -l') for line in child: print line * write and writelines() no longer return a value. Use send() if you need that functionality. I did this to make the Spawn object more closely match a file-like object. * Added the attribute ``exitstatus``. This will give the exit code returned by the child process. This will be set to ``None`` while the child is still alive. When ``isalive()`` returns 0 then ``exitstatus`` will be set. * Made a few more tweaks to ``isalive()`` so that it will operate more consistently on different platforms. Solaris is the most difficult to support. * You can now put ``TIMEOUT`` in a list of expected patterns. This is just like putting ``EOF`` in the pattern list. Expecting for a ``TIMEOUT`` may not be used as often as ``EOF``, but this makes Pexpect more consitent. * Thanks to a suggestion and sample code from Chad J. Schroeder I added the ability for Pexpect to operate on a file descriptor that is already open. This means that Pexpect can be used to control streams such as those from serial port devices. Now, you just pass the integer file descriptor as the "command" when contsructing a spawn open. For example on a Linux box with a modem on ttyS1:: fd = os.open("/dev/ttyS1", os.O_RDWR|os.O_NONBLOCK|os.O_NOCTTY) m = pexpect.spawn(fd) # Note integer fd is used instead of usual string. m.send("+++") # Escape sequence m.send("ATZ0\r") # Reset modem to profile 0 rval = m.expect(["OK", "ERROR"]) * ``read()`` was renamed to ``read_nonblocking()``. Added new ``read()`` method that matches file-like object interface. In general, you should not notice the difference except that ``read()`` no longer allows you to directly set the timeout value. I hope this will not effect any existing code. Switching to ``read_nonblocking()`` should fix existing code. * Changed the name of ``set_echo()`` to ``setecho()``. * Changed the name of ``send_eof()`` to ``sendeof()``. * Modified ``kill()`` so that it checks to make sure the pid ``isalive()``. * modified ``spawn()`` (really called from ``__spawn()``) so that it does not raise an expection if ``setwinsize()`` fails. Some platforms such as Cygwin do not like setwinsize. This was a constant problem and since it is not a critical feature I decided to just silence the error. Normally I don't like to do that, but in this case I'm making an exception. * Added a method ``close()`` that does what you think. It closes the file descriptor of the child application. It makes no attempt to actually kill the child or wait for its status. * Add variables ``__version__`` and ``__revision__`` (from cvs) to the pexpect modules. This is mainly helpful to me so that I can make sure that I'm testing with the right version instead of one already installed. * ``log_open()`` and ``log_close(`` have been removed. Now use ``setlog()``. The ``setlog()`` method takes a file object. This is far more flexible than the previous log method. Each time data is written to the file object it will be flushed. To turn logging off simply call ``setlog()`` with None. * renamed the ``isAlive()`` method to ``isalive()`` to match the more typical naming style in Python. Also the technique used to detect child process status has been drastically modified. Previously I did some funky stuff with signals which caused indigestion in other Python modules on some platforms. It was a big headache. It still is, but I think it works better now. * attribute ``matched`` renamed to ``after`` * new attribute ``match`` * The ``expect_eof()`` method is gone. You can now simply use the ``expect()`` method to look for EOF. * **Pexpect works on OS X**, but the nature of the quirks cause many of the tests to fail. See bugs. (Incomplete Child Output). The problem is more than minor, but Pexpect is still more than useful for most tasks. * **Solaris**: For some reason, the *second* time a pty file descriptor is created and deleted it never gets returned for use. It does not effect the first time or the third time or any time after that. It's only the second time. This is weird... This could be a file descriptor leak, or it could be some peculiarity of how Solaris recycles them. I thought it was a UNIX requirement for the OS to give you the lowest available filedescriptor number. In any case, this should not be a problem unless you create hundreds of pexpect instances... It may also be a pty module bug. Moves and forks --------------- * Pexpect development used to be hosted on Sourceforge. * In 2011, Thomas Kluyver forked pexpect as 'pexpect-u', to support Python 3. He later decided he had taken the wrong approach with this. * In 2012, Noah Spurrier, the original author of Pexpect, moved the project to Github, but was still too busy to develop it much. * In 2013, Thomas Kluyver and Jeff Quast forked Pexpect again, intending to call the new fork Pexpected. Noah Spurrier agreed to let them use the name Pexpect, so Pexpect versions 3 and above are based on this fork, which now lives `here on Github `_. pexpect-3.1/doc/Makefile0000644000175400017540000001270012216114727017343 0ustar takluyvertakluyver00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Pexpect.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Pexpect.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/Pexpect" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Pexpect" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." pexpect-3.1/doc/overview.rst0000644000175400017540000002440312233531217020302 0ustar takluyvertakluyver00000000000000API Overview ============ Pexpect can be used for automating interactive applications such as ssh, ftp, mencoder, passwd, etc. The Pexpect interface was designed to be easy to use. Here is an example of Pexpect in action:: # This connects to the openbsd ftp site and # downloads the recursive directory listing. import pexpect child = pexpect.spawn('ftp ftp.openbsd.org') child.expect('Name .*: ') child.sendline('anonymous') child.expect('Password:') child.sendline('noah@example.com') child.expect('ftp> ') child.sendline('lcd /tmp') child.expect('ftp> ') child.sendline('cd pub') child.expect('ftp> ') child.sendline('get README') child.expect('ftp> ') child.sendline('bye') Obviously you could write an ftp client using Python's own :mod:`ftplib` module, but this is just a demonstration. You can use this technique with any application. This is especially handy if you are writing automated test tools. There are two important methods in Pexpect -- :meth:`~pexpect.spawn.expect` and :meth:`~pexpect.spawn.send` (or :meth:`~pexpect.spawn.sendline` which is like :meth:`~pexpect.spawn.send` with a linefeed). The :meth:`~pexpect.spawn.expect` method waits for the child application to return a given string. The string you specify is a regular expression, so you can match complicated patterns. The :meth:`~pexpect.spawn.send` method writes a string to the child application. From the child's point of view it looks just like someone typed the text from a terminal. After each call to :meth:`~pexpect.spawn.expect` the ``before`` and ``after`` properties will be set to the text printed by child application. The ``before`` property will contain all text up to the expected string pattern. The ``after`` string will contain the text that was matched by the expected pattern. The match property is set to the `re match object `_. An example of Pexpect in action may make things more clear. This example uses ftp to login to the OpenBSD site; list files in a directory; and then pass interactive control of the ftp session to the human user:: import pexpect child = pexpect.spawn ('ftp ftp.openbsd.org') child.expect ('Name .*: ') child.sendline ('anonymous') child.expect ('Password:') child.sendline ('noah@example.com') child.expect ('ftp> ') child.sendline ('ls /pub/OpenBSD/') child.expect ('ftp> ') print child.before # Print the result of the ls command. child.interact() # Give control of the child to the user. Special EOF and TIMEOUT patterns -------------------------------- There are two special patterns to match the End Of File (:class:`~pexpect.EOF`) or a Timeout condition (:class:`~pexpect.TIMEOUT`). You you can pass these patterns to :meth:`~pexpect.spawn.expect`. These patterns are not regular expressions. Use them like predefined constants. If the child has died and you have read all the child's output then ordinarily :meth:`~pexpect.spawn.expect` will raise an :class:`~pexpect.EOF` exception. You can read everything up to the EOF without generating an exception by using the EOF pattern expect. In this case everything the child has output will be available in the ``before`` property. The pattern given to :meth:`~pexpect.spawn.expect` may be a regular expression or it may also be a list of regular expressions. This allows you to match multiple optional responses. The :meth:`~pexpect.spawn.expect` method returns the index of the pattern that was matched. For example, say you wanted to login to a server. After entering a password you could get various responses from the server -- your password could be rejected; or you could be allowed in and asked for your terminal type; or you could be let right in and given a command prompt. The following code fragment gives an example of this:: child.expect('password:') child.sendline(my_secret_password) # We expect any of these three patterns... i = child.expect (['Permission denied', 'Terminal type', '[#\$] ']) if i==0: print('Permission denied on host. Can't login') child.kill(0) elif i==2: print('Login OK... need to send terminal type.') child.sendline('vt100') child.expect('[#\$] ') elif i==3: print('Login OK.') print('Shell command prompt', child.after) If nothing matches an expected pattern then :meth:`~pexpect.spawn.expect` will eventually raise a :class:`~pexpect.TIMEOUT` exception. The default time is 30 seconds, but you can change this by passing a timeout argument to :meth:`~pexpect.spawn.expect`:: # Wait no more than 2 minutes (120 seconds) for password prompt. child.expect('password:', timeout=120) Find the end of line -- CR/LF conventions ----------------------------------------- Pexpect matches regular expressions a little differently than what you might be used to. The :regexp:`$` pattern for end of line match is useless. The :regexp:`$` matches the end of string, but Pexpect reads from the child one character at a time, so each character looks like the end of a line. Pexpect can't do a look-ahead into the child's output stream. In general you would have this situation when using regular expressions with any stream. .. note:: Pexpect does have an internal buffer, so reads are faster than one character at a time, but from the user's perspective the regex patterns test happens one character at a time. The best way to match the end of a line is to look for the newline: ``"\r\n"`` (CR/LF). Yes, that does appear to be DOS-style. It may surprise some UNIX people to learn that terminal TTY device drivers (dumb, vt100, ANSI, xterm, etc.) all use the CR/LF combination to signify the end of line. Pexpect uses a Pseudo-TTY device to talk to the child application, so when the child app prints ``"\n"`` you actually see ``"\r\n"``. UNIX uses just linefeeds to end lines of text, but not when it comes to TTY devices! TTY devices are more like the Windows world. Each line of text ends with a CR/LF combination. When you intercept data from a UNIX command from a TTY device you will find that the TTY device outputs a CR/LF combination. A UNIX command may only write a linefeed (``\n``), but the TTY device driver converts it to CR/LF. This means that your terminal will see lines end with CR/LF (hex ``0D 0A``). Since Pexpect emulates a terminal, to match ends of lines you have to expect the CR/LF combination:: child.expect('\r\n') If you just need to skip past a new line then ``expect('\n')`` by itself will work, but if you are expecting a specific pattern before the end of line then you need to explicitly look for the ``\r``. For example the following expects a word at the end of a line:: child.expect('\w+\r\n') But the following would both fail:: child.expect('\w+\n') And as explained before, trying to use :regexp:`$` to match the end of line would not work either:: child.expect ('\w+$') So if you need to explicitly look for the END OF LINE, you want to look for the CR/LF combination -- not just the LF and not the $ pattern. This problem is not limited to Pexpect. This problem happens any time you try to perform a regular expression match on a stream. Regular expressions need to look ahead. With a stream it is hard to look ahead because the process generating the stream may not be finished. There is no way to know if the process has paused momentarily or is finished and waiting for you. Pexpect must implicitly always do a NON greedy match (minimal) at the end of a input. Pexpect compiles all regular expressions with the :data:`re.DOTALL` flag. With the :data:`~re.DOTALL` flag, a ``"."`` will match a newline. Beware of + and * at the end of patterns ---------------------------------------- Remember that any time you try to match a pattern that needs look-ahead that you will always get a minimal match (non greedy). For example, the following will always return just one character:: child.expect ('.+') This example will match successfully, but will always return no characters:: child.expect ('.*') Generally any star * expression will match as little as possible. One thing you can do is to try to force a non-ambiguous character at the end of your :regexp:`\\d+` pattern. Expect that character to delimit the string. For example, you might try making the end of your pattern be :regexp:`\\D+` instead of :regexp:`\\D*`. Number digits alone would not satisfy the :regexp:`(\\d+)\\D+` pattern. You would need some numbers and at least one non-number at the end. Debugging --------- If you get the string value of a :class:`pexpect.spawn` object you will get lots of useful debugging information. For debugging it's very useful to use the following pattern:: try: i = child.expect ([pattern1, pattern2, pattern3, etc]) except: print("Exception was thrown") print("debug information:") print(str(child)) It is also useful to log the child's input and out to a file or the screen. The following will turn on logging and send output to stdout (the screen):: child = pexpect.spawn(foo) child.logfile = sys.stdout Exceptions ---------- :class:`~pexpect.EOF` Note that two flavors of EOF Exception may be thrown. They are virtually identical except for the message string. For practical purposes you should have no need to distinguish between them, but they do give a little extra information about what type of platform you are running. The two messages are: - "End Of File (EOF) in read(). Exception style platform." - "End Of File (EOF) in read(). Empty string style platform." Some UNIX platforms will throw an exception when you try to read from a file descriptor in the EOF state. Other UNIX platforms instead quietly return an empty string to indicate that the EOF state has been reached. If you wish to read up to the end of the child's output without generating an :class:`~pexpect.EOF` exception then use the ``expect(pexpect.EOF)`` method. :class:`~pexpect.TIMEOUT` The :meth:`~pexpect.spawn.expect` and :meth:`~pexpect.spawn.read` methods will also timeout if the child does not generate any output for a given amount of time. If this happens they will raise a :class:`~pexpect.TIMEOUT` exception. You can have these method ignore a timeout and block indefinitely by passing ``None`` for the timeout parameter:: child.expect(pexpect.EOF, timeout=None) pexpect-3.1/doc/api/0000755000175400017540000000000012270016336016451 5ustar takluyvertakluyver00000000000000pexpect-3.1/doc/api/pexpect.rst0000644000175400017540000000512312223054066020654 0ustar takluyvertakluyver00000000000000Core pexpect components ======================= .. automodule:: pexpect spawn class ----------- .. autoclass:: spawn .. automethod:: __init__ .. automethod:: expect .. automethod:: expect_exact .. automethod:: expect_list .. automethod:: compile_pattern_list .. automethod:: send .. automethod:: sendline .. automethod:: write .. automethod:: writelines .. automethod:: sendcontrol .. automethod:: sendeof .. automethod:: sendintr .. automethod:: read .. automethod:: readline .. automethod:: read_nonblocking .. automethod:: eof .. automethod:: interact .. attribute:: logfile logfile_read logfile_send Set these to a Python file object (or :data:`sys.stdout`) to log all communication, data read from the child process, or data sent to the child process. .. note:: With a :class:`spawn` instance, the log files should be open for writing binary data. With a :class:`spawnu` instance, they should be open for writing unicode text. Controlling the child process ````````````````````````````` .. class:: spawn .. automethod:: kill .. automethod:: terminate .. automethod:: isalive .. automethod:: wait .. automethod:: close .. automethod:: getwinsize .. automethod:: setwinsize .. automethod:: getecho .. automethod:: setecho .. automethod:: waitnoecho .. attribute:: pid The process ID of the child process. .. attribute:: child_fd The file descriptor used to communicate with the child process. .. _unicode: Handling unicode ```````````````` For backwards compatibility, :class:`spawn` can handle some Unicode: its send methods will encode arbitrary unicode as UTF-8 before sending it to the child process, and its expect methods can accept ascii-only unicode strings. However, for a proper unicode API to a subprocess, use this subclass: .. autoclass:: spawnu :show-inheritance: There is also a :func:`runu` function, the unicode counterpart to :func:`run`. .. note:: Unicode handling with pexpect works the same way on Python 2 and 3, despite the difference in names. I.e.: - :class:`spawn` works with ``str`` on Python 2, and :class:`bytes` on Python 3, - :class:`spawnu` works with ``unicode`` on Python 2, and :class:`str` on Python 3. run function ------------ .. autofunction:: run .. autofunction:: runu Exceptions ---------- .. autoclass:: EOF .. autoclass:: TIMEOUT .. autoclass:: ExceptionPexpect Utility functions ----------------- .. autofunction:: which .. autofunction:: split_command_line pexpect-3.1/doc/api/ANSI.rst0000644000175400017540000000042012220666300017726 0ustar takluyvertakluyver00000000000000ANSI - ANSI (VT100) terminal emulator ===================================== .. automodule:: pexpect.ANSI .. autoclass:: term :show-inheritance: .. autoclass:: ANSI :show-inheritance: .. automethod:: write_ch .. automethod:: write .. automethod:: processpexpect-3.1/doc/api/fdpexpect.rst0000644000175400017540000000131312220666300021160 0ustar takluyvertakluyver00000000000000fdpexpect - use pexpect with a file descriptor ============================================== .. automodule:: pexpect.fdpexpect fdspawn class ------------- .. autoclass:: fdspawn :show-inheritance: .. automethod:: __init__ .. automethod:: isalive .. automethod:: close .. note:: :class:`fdspawn` inherits all of the methods of :class:`~pexpect.spawn`, but not all of them can be used, especially if the file descriptor is not a terminal. Some methods may do nothing (e.g. :meth:`~fdspawn.kill`), while others will raise an exception (e.g. :meth:`~fdspawn.terminate`). This behaviour might be made more consistent in the future, so try to avoid relying on it.pexpect-3.1/doc/api/pxssh.rst0000644000175400017540000000124112220666300020343 0ustar takluyvertakluyver00000000000000pxssh - control an SSH session ============================== .. automodule:: pexpect.pxssh .. autoclass:: ExceptionPxssh pxssh class ----------- .. autoclass:: pxssh .. automethod:: __init__ .. attribute:: auto_prompt_reset Set this to False to prevent :meth:`login` from setting a unique prompt which can easily be located. .. attribute:: PROMPT The regex pattern to search for to find the prompt. If :attr:`auto_prompt_reset` is False, you must set this attribute manually. .. automethod:: login .. automethod:: logout .. automethod:: prompt .. automethod:: sync_original_prompt .. automethod:: set_unique_promptpexpect-3.1/doc/api/index.rst0000644000175400017540000000016512220666300020311 0ustar takluyvertakluyver00000000000000API documentation ================= .. toctree:: :maxdepth: 2 pexpect fdpexpect pxssh screen ANSIpexpect-3.1/doc/api/screen.rst0000644000175400017540000000030112220666300020451 0ustar takluyvertakluyver00000000000000screen - manage a virtual 'screen' ================================== .. automodule:: pexpect.screen .. autoclass:: screen :members: .. automethod:: __init__ .. automethod:: __str__pexpect-3.1/doc/clean.css0000644000175400017540000000360212216111566017476 0ustar takluyvertakluyver00000000000000 body { margin:0px; padding:0px; font-family:verdana, arial, helvetica, sans-serif; color:#333; background-color:white; } pre { background: #eeeeee; border: 1px solid #888888; color: black; padding: 1em; white-space: pre; } h1 { margin:5px 0px 5px 0px; padding:0px; font-size:20px; line-height:28px; font-weight:900; color:#44f; } h2 { margin:5px 0px 5px 0px; padding:0px; font-size:17px; line-height:28px; font-weight:900; color:#226; } h3 { margin:5px 0px 5px 0px; padding:0px; font-size:15px; line-height:28px; font-weight:900; } p { margin:0px 0px 16px 0px; font:11px/20px verdana, arial, helvetica, sans-serif; padding:0px; } table { font-size: 10pt; color: #000000; } td{border:1px solid #999;} table.pymenu {color: #000000; background-color: #99ccff} th.pymenu {color: #ffffff; background-color: #003366} .code { font-family: "Lucida Console", monospace; font-weight: bold; color: #007700; background-color: #eeeeee } #Content>p {margin:0px;} #Content>p+p {text-indent:30px;} a { text-decoration:none; font-weight:600; font-family:verdana, arial, helvetica, sans-serif; color: #900; } //a:link {color:#09c;} //a x:visited {color:#07a;} a:hover {background-color:#ee0;} #Header { margin:10px 0px 10px 0px; padding:10px 0px 10px 20px; /* For IE5/Win's benefit height = [correct height] + [top padding] + [top and bottom border widths] */ height:33px; /* 14px + 17px + 2px = 33px */ border-style:solid; border-color:black; border-width:1px 0px; /* top and bottom borders: 1px; left and right borders: 0px */ line-height:33px; background-color:#eee; height:66px; /* the correct height */ } #Content { margin:0px 210px 50px 10px; padding:10px; } #Menu { position:absolute; top:100px; right:20px; width:172px; padding:10px; background-color:#eee; border:1px solid #999; // dashed #999; line-height:17px; width:150px; font-size:11px; } pexpect-3.1/doc/FAQ.rst0000644000175400017540000001701112233531217017040 0ustar takluyvertakluyver00000000000000FAQ === **Q: Why don't shell pipe and redirect (| and >) work when I spawn a command?** A: Remember that Pexpect does NOT interpret shell meta characters such as redirect, pipe, or wild cards (``>``, ``|``, or ``*``). That's done by a shell not the command you are spawning. 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 > log_list.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 > log_list.txt' child = pexpect.spawn('/bin/bash', ['-c', shell_cmd]) child.expect(pexpect.EOF) **Q: Isn't there already a Python Expect?** A: Yes, there are several of them. They usually require you to compile C. I wanted something that was pure Python and preferably a single module that was simple to install. I also wanted something that was easy to use. This pure Python expect only became possible with the introduction of the pty module in the standard Python library. Previously, C extensions were required. **Q: The `before` and `after` properties sound weird.** A: This is how the -B and -A options in grep works, so that made it easier for me to remember. Whatever makes my life easier is what's best. Originally I was going to model Pexpect after Expect, but then I found that I didn't actually like the way Expect did some things. It was more confusing. The `after` property can be a little confusing at first, because it will actually include the matched string. The `after` means after the point of match, not after the matched string. **Q: Why not just use Expect?** A: I love it. It's great. I has bailed me out of some real jams, but I wanted something that would do 90% of what I need from Expect; be 10% of the size; and allow me to write my code in Python instead of TCL. Pexpect is not nearly as big as Expect, but Pexpect does everything I have ever used Expect for. .. _whynotpipe: **Q: Why not just use a pipe (popen())?** A: A pipe works fine for getting the output to non-interactive programs. If you just want to get the output from ls, uname, or ping then this works. Pipes do not work very well for interactive programs and pipes will almost certainly fail for most applications that ask for passwords such as telnet, ftp, or ssh. There are two reasons for this. * First an application may bypass stdout and print directly to its controlling TTY. Something like SSH will do this when it asks you for a password. This is why you cannot redirect the password prompt because it does not go through stdout or stderr. * The second reason is because most applications are built using the C Standard IO Library (anything that uses ``#include ``). One of the features of the stdio library is that it buffers all input and output. Normally output is line buffered when a program is printing to a TTY (your terminal screen). Everytime the program prints a line-feed the currently buffered data will get printed to your screen. The problem comes when you connect a pipe. The stdio library is smart and can tell that it is printing to a pipe instead of a TTY. In that case it switches from line buffer mode to block buffered. In this mode the currently buffered data is flushed when the buffer is full. This causes most interactive programs to deadlock. Block buffering is more efficient when writing to disks and pipes. Take the situation where a program prints a message ``"Enter your user name:\n"`` and then waits for you type type something. In block buffered mode, the stdio library will not put the message into the pipe even though a linefeed is printed. The result is that you never receive the message, yet the child application will sit and wait for you to type a response. Don't confuse the stdio lib's buffer with the pipe's buffer. The pipe buffer is another area that can cause problems. You could flush the input side of a pipe, whereas you have no control over the stdio library buffer. More information: the Standard IO library has three states for a ``FILE *``. These are: _IOFBF for block buffered; _IOLBF for line buffered; and _IONBF for unbuffered. The STDIO lib will use block buffering when talking to a block file descriptor such as a pipe. This is usually not helpful for interactive programs. Short of recompiling your program to include fflush() everywhere or recompiling a custom stdio library there is not much a controlling application can do about this if talking over a pipe. The program may have put data in its output that remains unflushed because the output buffer is not full; then the program will go and deadlock while waiting for input -- because you never send it any because you are still waiting for its output (still stuck in the STDIO's output buffer). The answer is to use a pseudo-tty. A TTY device will force line buffering (as opposed to block buffering). Line buffering means that you will get each line when the child program sends a line feed. This corresponds to the way most interactive programs operate -- send a line of output then wait for a line of input. I put "answer" in quotes because it's ugly solution and because there is no POSIX standard for pseudo-TTY devices (even though they have a TTY standard...). What would make more sense to me would be to have some way to set a mode on a file descriptor so that it will tell the STDIO to be line-buffered. I have investigated, and I don't think there is a way to set the buffered state of a child process. The STDIO Library does not maintain any external state in the kernel or whatnot, so I don't think there is any way for you to alter it. I'm not quite sure how this line-buffered/block-buffered state change happens internally in the STDIO library. I think the STDIO lib looks at the file descriptor and decides to change behavior based on whether it's a TTY or a block file (see isatty()). I hope that this qualifies as helpful. Don't use a pipe to control another application... Pexpect may seem similar to :func:`os.popen` or ``commands`` module. The main difference is that Pexpect (like Expect) uses a pseudo-TTY to talk to the child application. Most applications do not work well through the system() call or through pipes. And probably all applications that ask a user to type in a password will fail. These applications bypass the stdin and read directly from the TTY device. Many applications do not explicitly flush their output buffers. This causes deadlocks if you try to control an interactive application using a pipe. What happens is that most UNIX applications use the stdio (``#include ``) for input and output. The stdio library behaves differently depending on where the output is going. There is no way to control this behavior from the client end. **Q: Can I do screen scraping with this thing?** A: That depends. If your application just does line-oriented output then this is easy. If it does screen-oriented output then it may work, but it could be hard. For example, trying to scrape data from the 'top' command would be hard. The top command repaints the text window. I am working on an ANSI / VT100 terminal emulator that will have methods to get characters from an arbitrary X,Y coordinate of the virtual screen. It works and you can play with it (see :mod:`pexpect.ANSI`), but I have no working examples at this time. pexpect-3.1/doc/examples.rst0000644000175400017540000000663512252463473020272 0ustar takluyvertakluyver00000000000000Examples ======== Under the distribution tarball directory you should find an "examples" directory. This is the best way to learn to use Pexpect. See the descriptions of Pexpect Examples. `topip.py `_ This runs `netstat` on a local or remote server. It calculates some simple statistical information on the number of external inet connections. This can be used to detect if one IP address is taking up an excessive number of connections. It can also send an email alert if a given IP address exceeds a threshold between runs of the script. This script can be used as a drop-in Munin plugin or it can be used stand-alone from cron. I used this on a busy web server that would sometimes get hit with denial of service attacks. This made it easy to see if a script was opening many multiple connections. A typical browser would open fewer than 10 connections at once. A script might open over 100 simultaneous connections. `hive.py `_ This script creates SSH connections to a list of hosts that you provide. Then you are given a command line prompt. Each shell command that you enter is sent to all the hosts. The response from each host is collected and printed. For example, you could connect to a dozen different machines and reboot them all at once. `script.py `_ This implements a command similar to the classic BSD "script" command. This will start a subshell and log all input and output to a file. This demonstrates the :meth:`~pexpect.spawn.interact` method of Pexpect. `ftp.py `_ This demonstrates an FTP "bookmark". This connects to an ftp site; does a few ftp tasks; and then gives the user interactive control over the session. In this case the "bookmark" is to a directory on the OpenBSD ftp server. It puts you in the i386 packages directory. You can easily modify this for other sites. This demonstrates the :meth:`~pexpect.spawn.interact` method of Pexpect. `monitor.py `_ This runs a sequence of commands on a remote host using SSH. It runs a simple system checks such as uptime and free to monitor the state of the remote host. `passmass.py `_ This will login to each given server and change the password of the given user. This demonstrates scripting logins and passwords. `python.py `_ This starts the python interpreter and prints the greeting message backwards. It then gives the user iteractive control of Python. It's pretty useless! `ssh_tunnel.py `_ This starts an SSH tunnel to a remote machine. It monitors the connection and restarts the tunnel if it goes down. `uptime.py `_ This will run the uptime command and parse the output into variables. This demonstrates using a single regular expression to match the output of a command and capturing different variable in match groups. The grouping regular expression handles a wide variety of different uptime formats. pexpect-3.1/doc/make.bat0000644000175400017540000001175212216114727017316 0ustar takluyvertakluyver00000000000000@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Pexpect.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Pexpect.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) :end pexpect-3.1/doc/commonissues.rst0000644000175400017540000001051512233531217021157 0ustar takluyvertakluyver00000000000000Common problems =============== Threads ------- On Linux (RH 8) you cannot spawn a child from a different thread and pass the handle back to a worker thread. The child is successfully spawned but you can't interact with it. The only way to make it work is to spawn and interact with the child all in the same thread. [Adam Kerrison] Timing issue with send() and sendline() --------------------------------------- This problem has been addressed and should not affect most users. It is sometimes possible to read an echo of the string sent with :meth:`~pexpect.spawn.send` and :meth:`~pexpect.spawn.sendline`. If you call :meth:`~pexpect.spawn.send` and then immediately call :meth:`~pexpect.spawn.readline`, you may get part of your output echoed back. You may read back what you just wrote even if the child application does not explicitly echo it. Timing is critical. This could be a security issue when talking to an application that asks for a password; otherwise, this does not seem like a big deal. But why do TTYs do this? People usually report this when they are trying to control SSH or some other login. For example, if your code looks something like this:: child.expect ('[pP]assword:') child.sendline (my_password) 1. SSH prints "password:" prompt to the user. 2. SSH turns off echo on the TTY device. 3. SSH waits for user to enter a password. When scripting with Pexpect what can happen is that Pexpect will respond to the "password:" prompt before SSH has had time to turn off TTY echo. In other words, Pexpect sends the password between steps 1. and 2., so the password gets echoed back to the TTY. I would call this an SSH bug. Pexpect now automatically adds a short delay before sending data to a child process. This more closely mimics what happens in the usual human-to-app interaction. The delay can be tuned with the ``delaybeforesend`` attribute of the spawn class. In general, this fixes the problem for everyone and so this should not be an issue for most users. For some applications you might with to turn it off:: child = pexpect.spawn ("ssh user@example.com") child.delaybeforesend = 0 Timing issue with isalive() --------------------------- Reading the state of :meth:`~pexpect.spawn.isalive` immediately after a child exits may sometimes return 1. This is a race condition. The child has closed its file descriptor, but has not yet fully exited before Pexpect's :meth:`~pexpect.spawn.isalive` executes. Addings a slight delay before the :meth:`~pexpect.spawn.isalive` call will help. For example:: child = pexpect.spawn('ls') child.expect(pexpect.EOF) time.sleep(0.1) print child.isalive() Truncated output just before child exits ---------------------------------------- So far I have seen this only on older versions of Apple's MacOS X. If the child application quits it may not flush its output buffer. This means that your Pexpect application will receive an EOF even though it should have received a little more data before the child died. This is not generally a problem when talking to interactive child applications. One example where it is a problem is when trying to read output from a program like *ls*. You may receive most of the directory listing, but the last few lines will get lost before you receive an EOF. The reason for this is that *ls* runs; completes its task; and then exits. The buffer is not flushed before exit so the last few lines are lost. The following example demonstrates the problem:: child = pexpect.spawn('ls -l') child.expect(pexpect.EOF) print child.before Controlling SSH on Solaris -------------------------- Pexpect does not yet work perfectly on Solaris. One common problem is that SSH sometimes will not allow TTY password authentication. For example, you may expect SSH to ask you for a password using code like this:: child = pexpect.spawn('ssh user@example.com') child.expect('assword') child.sendline('mypassword') You may see the following error come back from a spawned child SSH:: Permission denied (publickey,keyboard-interactive). This means that SSH thinks it can't access the TTY to ask you for your password. The only solution I have found is to use public key authentication with SSH. This bypasses the need for a password. I'm not happy with this solution. The problem is due to poor support for Solaris Pseudo TTYs in the Python Standard Library. pexpect-3.1/doc/index.rst0000644000175400017540000000277512233531217017553 0ustar takluyvertakluyver00000000000000Pexpect version |version| ========================= .. image:: https://travis-ci.org/pexpect/pexpect.png?branch=master :target: https://travis-ci.org/pexpect/pexpect :align: right :alt: Build status Pexpect makes Python a better tool for controlling other applications. Pexpect is a pure Python module for spawning child applications; controlling them; and responding to expected patterns in their output. Pexpect works like Don Libes' Expect. Pexpect allows your script to spawn a child application and control it as if a human were typing commands. Pexpect can be used for automating interactive applications such as ssh, ftp, passwd, telnet, etc. It can be used to a automate setup scripts for duplicating software package installations on different servers. It can be used for automated software testing. Pexpect is in the spirit of Don Libes' Expect, but Pexpect is pure Python. Unlike other Expect-like modules for Python, Pexpect does not require TCL or Expect nor does it require C extensions to be compiled. It should work on any platform that supports the standard Python pty module. The Pexpect interface was designed to be easy to use. Contents: .. toctree:: :maxdepth: 2 install overview api/index examples FAQ commonissues history Pexpect is developed `on Github `_. Please report `issues `_ there as well. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` pexpect-3.1/doc/sphinxext/0000755000175400017540000000000012270016336017732 5ustar takluyvertakluyver00000000000000pexpect-3.1/doc/sphinxext/github.py0000644000175400017540000001240312270005533021563 0ustar takluyvertakluyver00000000000000"""Define text roles for GitHub * ghissue - Issue * ghpull - Pull Request * ghuser - User Adapted from bitbucket example here: https://bitbucket.org/birkenfeld/sphinx-contrib/src/tip/bitbucket/sphinxcontrib/bitbucket.py Authors ------- * Doug Hellmann * Min RK """ # # Original Copyright (c) 2010 Doug Hellmann. All rights reserved. # from docutils import nodes, utils from docutils.parsers.rst.roles import set_classes def make_link_node(rawtext, app, type, slug, options): """Create a link to a github resource. :param rawtext: Text being replaced with link node. :param app: Sphinx application context :param type: Link type (issues, changeset, etc.) :param slug: ID of the thing to link to :param options: Options dictionary passed to role func. """ try: base = app.config.github_project_url if not base: raise AttributeError if not base.endswith('/'): base += '/' except AttributeError as err: raise ValueError('github_project_url configuration value is not set (%s)' % str(err)) ref = base + type + '/' + slug + '/' set_classes(options) prefix = "#" if type == 'pull': prefix = "PR " + prefix node = nodes.reference(rawtext, prefix + utils.unescape(slug), refuri=ref, **options) return node def ghissue_role(name, rawtext, text, lineno, inliner, options={}, content=[]): """Link to a GitHub issue. Returns 2 part tuple containing list of nodes to insert into the document and a list of system messages. Both are allowed to be empty. :param name: The role name used in the document. :param rawtext: The entire markup snippet, with role. :param text: The text marked with the role. :param lineno: The line number where rawtext appears in the input. :param inliner: The inliner instance that called us. :param options: Directive options for customization. :param content: The directive content for customization. """ try: issue_num = int(text) if issue_num <= 0: raise ValueError except ValueError: msg = inliner.reporter.error( 'GitHub issue number must be a number greater than or equal to 1; ' '"%s" is invalid.' % text, line=lineno) prb = inliner.problematic(rawtext, rawtext, msg) return [prb], [msg] app = inliner.document.settings.env.app #app.info('issue %r' % text) if 'pull' in name.lower(): category = 'pull' elif 'issue' in name.lower(): category = 'issues' else: msg = inliner.reporter.error( 'GitHub roles include "ghpull" and "ghissue", ' '"%s" is invalid.' % name, line=lineno) prb = inliner.problematic(rawtext, rawtext, msg) return [prb], [msg] node = make_link_node(rawtext, app, category, str(issue_num), options) return [node], [] def ghuser_role(name, rawtext, text, lineno, inliner, options={}, content=[]): """Link to a GitHub user. Returns 2 part tuple containing list of nodes to insert into the document and a list of system messages. Both are allowed to be empty. :param name: The role name used in the document. :param rawtext: The entire markup snippet, with role. :param text: The text marked with the role. :param lineno: The line number where rawtext appears in the input. :param inliner: The inliner instance that called us. :param options: Directive options for customization. :param content: The directive content for customization. """ app = inliner.document.settings.env.app #app.info('user link %r' % text) ref = 'https://www.github.com/' + text node = nodes.reference(rawtext, text, refuri=ref, **options) return [node], [] def ghcommit_role(name, rawtext, text, lineno, inliner, options={}, content=[]): """Link to a GitHub commit. Returns 2 part tuple containing list of nodes to insert into the document and a list of system messages. Both are allowed to be empty. :param name: The role name used in the document. :param rawtext: The entire markup snippet, with role. :param text: The text marked with the role. :param lineno: The line number where rawtext appears in the input. :param inliner: The inliner instance that called us. :param options: Directive options for customization. :param content: The directive content for customization. """ app = inliner.document.settings.env.app #app.info('user link %r' % text) try: base = app.config.github_project_url if not base: raise AttributeError if not base.endswith('/'): base += '/' except AttributeError as err: raise ValueError('github_project_url configuration value is not set (%s)' % str(err)) ref = base + text node = nodes.reference(rawtext, text[:6], refuri=ref, **options) return [node], [] def setup(app): """Install the plugin. :param app: Sphinx application context. """ app.info('Initializing GitHub plugin') app.add_role('ghissue', ghissue_role) app.add_role('ghpull', ghissue_role) app.add_role('ghuser', ghuser_role) app.add_role('ghcommit', ghcommit_role) app.add_config_value('github_project_url', None, 'env') return pexpect-3.1/doc/install.rst0000644000175400017540000000073612221120240020070 0ustar takluyvertakluyver00000000000000Installation ============ Pexpect is on PyPI, and can be installed with standard tools:: pip install pexpect Or:: easy_install pexpect Requirements ------------ This version of Pexpect requires Python 2.6 or 3.2 or above. For older versions of Python, continue using Pexpect 2.4. Pexpect only works on POSIX systems, where the :mod:`pty` module is present in the standard library. It may be possible to run it on Windows using `Cygwin `_. pexpect-3.1/INSTALL0000644000175400017540000000451512216111566016172 0ustar takluyvertakluyver00000000000000Installation ------------ This is a standard Python Distutil distribution. To install simply run: python setup.py install This makes Pexpect available to any script on the machine. You need root access to install it this way. If you do not have root access or if you do not wish to install Pexpect so that is available to any script then you can just copy the pexpect.py file to same directory as your script. Trouble on Debian and Ubuntu ---------------------------- For some stupid reason Debian Linux does not include the distutils module in the standard 'python' package. Instead, the distutils module is packaged separately in the 'python-dev' package. So to add distutils back into Python, simply use aptitude or apt-get to install 'python-dev'. As root, run this command: apt-get install python-dev Why they do this is mysterious because: - It breaks the Python model of "batteries included". 'distutils' isn't an extra or optional module -- it's parts of the Standard Python Library. - The Debian 'python-dev' package is a microscopic 50K installed. So what are they saving? - Distutils is not only interesting to developers. Many non-development oriented Python packages use 'distutils' to install applications. - As far as I can tell, the package maintainers must go through more trouble to remove 'distutils' from the standard Python distribution than it would take just to leave it in. PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. pexpect-3.1/FSM.py0000644000175400017540000000027512216707354016145 0ustar takluyvertakluyver00000000000000import warnings warnings.warn("This module has been moved to pexpect.FSM, please update imports.", ImportWarning) del warnings from pexpect.FSM import * # analysis:ignorepexpect-3.1/screen.py0000644000175400017540000000030312216707071016763 0ustar takluyvertakluyver00000000000000import warnings warnings.warn("This module has been moved to pexpect.screen, please update imports.", ImportWarning) del warnings from pexpect.screen import * # analysis:ignorepexpect-3.1/pxssh.py0000644000175400017540000000030112216710317016644 0ustar takluyvertakluyver00000000000000import warnings warnings.warn("This module has been moved to pexpect.pxssh, please update imports.", ImportWarning) del warnings from pexpect.pxssh import * # analysis:ignorepexpect-3.1/tools/0000755000175400017540000000000012270016336016273 5ustar takluyvertakluyver00000000000000pexpect-3.1/tools/testall.py0000755000175400017540000000624012220711455020321 0ustar takluyvertakluyver00000000000000#!/usr/bin/env python '''This script runs all tests in a directory. It does not need to know about the tests ahead of time. It recursively descends from the current directory and automatically builds up a list of tests to run. Only directories named 'tests' are processed. The path to each 'tests' directory is added to the PYTHONPATH. Only python scripts that start with 'test_' are added to the list of scripts in the test suite. Noah Spurrier PEXPECT LICENSE This license is approved by the OSI and FSF as GPL-compatible. http://opensource.org/licenses/isc-license.txt Copyright (c) 2012, Noah Spurrier PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ''' from __future__ import print_function import unittest import os, os.path import sys import platform import pexpect print("Testing pexpect %s using python %s:" % ( pexpect.__version__, platform.python_version())) # Don't bother checking performance on Travis, we know it's slow. TEST_PERFORMANCE = 'TRAVIS' not in os.environ def add_tests_to_list (import_list, dirname, names): # Only check directories named 'tests'. if os.path.basename(dirname) != 'tests': return # Add any files that start with 'test_' and end with '.py'. for f in names: filename, ext = os.path.splitext(f) if ext != '.py': continue if (not TEST_PERFORMANCE) and (filename == 'test_performance'): continue if filename.find('test_') == 0: import_list.append (os.path.join(dirname, filename)) def find_modules_and_add_paths (root_path): import_list = [] module_list = [] for (dirpath, dirnames, filenames) in os.walk(root_path): add_tests_to_list(import_list, dirpath, filenames) for module_file in import_list: path, module = os.path.split(module_file) module_list.append (module) print('Adding:', os.path.relpath(module_file)) if not path in sys.path: sys.path.append (path) if not os.path.dirname(path) in sys.path: sys.path.append (os.path.dirname(path)) module_list.sort() return module_list def suite(): modules_to_test = find_modules_and_add_paths (os.getcwd()) alltests = unittest.TestSuite() for module in map(__import__, modules_to_test): alltests.addTest(unittest.findTestCases(module)) return alltests if __name__ == '__main__': unittest.main(defaultTest='suite') # s = all() # runner = unittest.TextTestRunner() # runner.run (s)