diff options
Diffstat (limited to 'pexpect/pty_spawn.py')
| -rw-r--r-- | pexpect/pty_spawn.py | 71 |
1 files changed, 32 insertions, 39 deletions
diff --git a/pexpect/pty_spawn.py b/pexpect/pty_spawn.py index 0ba1e0c..73dec56 100644 --- a/pexpect/pty_spawn.py +++ b/pexpect/pty_spawn.py @@ -14,7 +14,7 @@ import ptyprocess from ptyprocess.ptyprocess import use_native_pty_fork from .exceptions import ExceptionPexpect, EOF, TIMEOUT -from .spawnbase import SpawnBase, SpawnBaseUnicode +from .spawnbase import SpawnBase from .utils import which, split_command_line @contextmanager @@ -30,14 +30,14 @@ PY3 = (sys.version_info[0] >= 3) class spawn(SpawnBase): '''This is the main class interface for Pexpect. Use this class to start and control child applications. ''' - ptyprocess_class = ptyprocess.PtyProcess # This is purely informational now - changing it has no effect use_native_pty_fork = use_native_pty_fork def __init__(self, command, args=[], timeout=30, maxread=2000, searchwindowsize=None, logfile=None, cwd=None, env=None, - ignore_sighup=True, echo=True, preexec_fn=None): + ignore_sighup=True, echo=True, preexec_fn=None, + encoding=None, codec_errors='strict'): '''This is the constructor. The command parameter may be a string that includes a command and any arguments to the command. For example:: @@ -117,7 +117,7 @@ class spawn(SpawnBase): child = pexpect.spawn('some_command') child.logfile_read = sys.stdout - Remember to use spawnu instead of spawn for the above code if you are + You will need to pass an encoding to spawn in the above code if you are using Python 3. To separately log output sent to the child use logfile_send:: @@ -172,7 +172,7 @@ class spawn(SpawnBase): signal handlers. ''' super(spawn, self).__init__(timeout=timeout, maxread=maxread, searchwindowsize=searchwindowsize, - logfile=logfile) + logfile=logfile, encoding=encoding, codec_errors=codec_errors) self.STDIN_FILENO = pty.STDIN_FILENO self.STDOUT_FILENO = pty.STDOUT_FILENO self.STDERR_FILENO = pty.STDERR_FILENO @@ -277,7 +277,7 @@ class spawn(SpawnBase): preexec_fn() kwargs['preexec_fn'] = preexec_wrapper - self.ptyproc = self.ptyprocess_class.spawn(self.args, env=self.env, + self.ptyproc = ptyprocess.PtyProcess.spawn(self.args, env=self.env, cwd=self.cwd, **kwargs) self.pid = self.ptyproc.pid @@ -503,10 +503,8 @@ class spawn(SpawnBase): 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) + b = self._encoder.encode(s, final=False) + return os.write(self.child_fd, b) def sendline(self, s=''): '''Wraps send(), sending string ``s`` to child process, with @@ -519,9 +517,11 @@ class spawn(SpawnBase): n = n + self.send(self.linesep) return n - def _log_control(self, byte): + def _log_control(self, s): """Write control characters to the appropriate log files""" - self._log(byte, 'send') + if self.encoding is not None: + s = s.decode(self.encoding, 'replace') + self._log(s, 'send') def sendcontrol(self, char): '''Helper method that wraps send() with mnemonic access for sending control @@ -614,10 +614,17 @@ class spawn(SpawnBase): 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. ''' + technically still alive until its output is read by the parent. + + This method is non-blocking if :meth:`wait` has already been called + previously or :meth:`isalive` method returns False. It simply returns + the previously determined exit status. + ''' ptyproc = self.ptyproc with _wrap_ptyprocess_err(): + # exception may occur if "Is some other process attempting + # "job control with our child pid?" exitstatus = ptyproc.wait() self.status = ptyproc.status self.exitstatus = ptyproc.exitstatus @@ -677,11 +684,10 @@ class spawn(SpawnBase): 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. + escape_character this method will return None. The escape_character + will not be transmitted. The default for escape_character is + entered as ``Ctrl - ]``, the very same as BSD telnet. To prevent + escaping, escape_character may be set to None. You may pass in optional input and output filter functions. These functions should take a string and return a string. The output_filter @@ -713,7 +719,7 @@ class spawn(SpawnBase): self.buffer = self.string_type() mode = tty.tcgetattr(self.STDIN_FILENO) tty.setraw(self.STDIN_FILENO) - if PY3: + if escape_character is not None and PY3: escape_character = escape_character.encode('latin-1') try: self.__interact_copy(escape_character, input_filter, output_filter) @@ -763,7 +769,9 @@ class spawn(SpawnBase): data = self.__interact_read(self.STDIN_FILENO) if input_filter: data = input_filter(data) - i = data.rfind(escape_character) + i = -1 + if escape_character is not None: + i = data.rfind(escape_character) if i != -1: data = data[:i] self.__interact_writen(self.child_fd, data) @@ -798,22 +806,7 @@ class spawn(SpawnBase): # this actually is an exception. raise - -class spawnu(SpawnBaseUnicode, 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`. - """ - ptyprocess_class = ptyprocess.PtyProcessUnicode - - def _send(self, s): - return os.write(self.child_fd, s.encode(self.encoding, self.errors)) - - def _log_control(self, byte): - s = byte.decode(self.encoding, 'replace') - self._log(s, 'send') +def spawnu(*args, **kwargs): + """Deprecated: pass encoding to spawn() instead.""" + kwargs.setdefault('encoding', 'utf-8') + return spawn(*args, **kwargs) |