diff options
author | Thomas Kluyver <thomas@kluyver.me.uk> | 2017-08-22 14:46:21 +0100 |
---|---|---|
committer | Thomas Kluyver <thomas@kluyver.me.uk> | 2017-08-22 14:46:21 +0100 |
commit | 009ea10ecdc0c4fa5c2b05fe19722079db55b09d (patch) | |
tree | bca714a80b5d3e6c051c9f2c3ab7293a5a4fab2e /doc | |
parent | 94f91bd8c56f5e277a9859129ee9260658fd170a (diff) | |
download | pexpect-git-009ea10ecdc0c4fa5c2b05fe19722079db55b09d.tar.gz |
Add some more explanation about pexpect on Windows
Diffstat (limited to 'doc')
-rw-r--r-- | doc/overview.rst | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/overview.rst b/doc/overview.rst index d394ef1..eca8565 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -249,9 +249,19 @@ Pexpect on Windows Pexpect can be used on Windows to wait for a pattern to be produced by a child process, using :class:`pexpect.popen_spawn.PopenSpawn`, or a file descriptor, -using :class:`pexpect.fdpexpect.fdspawn`. This should be considered experimental -for now. +using :class:`pexpect.fdpexpect.fdspawn`. :class:`pexpect.spawn` and :func:`pexpect.run` are *not* available on Windows, as they rely on Unix pseudoterminals (ptys). Cross platform code must not use these. + +``PopenSpawn`` is not a direct replacement for ``spawn``. Many programs only +offer interactive behaviour if they detect that they are running in a terminal. +When run by ``PopenSpawn``, they may behave differently. + +.. seealso:: + + `winpexpect <https://pypi.python.org/pypi/winpexpect>`__ and + `wexpect <https://gist.github.com/anthonyeden/8488763>`__ + Two unmaintained pexpect-like modules for Windows, which work with a + hidden console. |