# socket_pexpect - use pexpect with a socket

This is like `pexpect`, but it will work with any socket that you pass it. You are responsible for opening and closing the socket.

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 <noah@noah.org> 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.

## SocketSpawn class

class pexpect.socket_pexpect.SocketSpawn(socket: socket, args=None, timeout=30, maxread=2000, searchwindowsize=None, logfile=None, encoding=None, codec_errors='strict', use_poll=False)

  Bases: `SpawnBase`

  This is like `pexpect.fdpexpect` but uses the cross-platform python socket api, rather than the unix-specific file descriptor api. Thus, it works with remote connections on both unix and windows.

  __init__(socket: socket, args=None, timeout=30, maxread=2000, searchwindowsize=None, logfile=None, encoding=None, codec_errors='strict', use_poll=False)

    This takes an open socket.

  isalive()

    Alive if the fileno is valid

  close()

    Close the socket.

    Calling this method a second time does nothing, but if the file descriptor was closed elsewhere, `OSError` will be raised.

  expect()
  expect_exact()
  expect_list()

    As `pexpect.spawn`.