Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

wexpect

Build status codecov

Wexpect is a Windows variant of pexpect.

Pexpect is a Python module for spawning child applications and controlling them automatically.

You need wexpect if...

  • you want to control any windows console application from python script.
  • you want to write test-automation script for a windows console application.
  • you want to automate your job by controlling multiple application parallel, synchoronusly.

Install

pip install wexpect

OR

Because wexpect a tiny project dropping the wexpect.py file into your working directory is usually good enough instead of installing. However in this case you need to install manually the pypiwin32 dependence.

Usage

To interract with a child process use spawn method:

import wexpect 
child = wexpect.spawn('cmd.exe')
child.expect('>')
child.sendline('ls')
child.expect('>')
print(child.before)
child.sendline('exit')

For more information see examples folder.


What is it?

Wexpect is a Python module for spawning child applications and controlling them automatically. Wexpect 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. Wexpect is in the spirit of Don Libes' Expect, but Wexpect is pure Python. Other Expect-like modules for Python require TCL and Expect or require C extensions to be compiled. Wexpect does not use C, Expect, or TCL extensions.

Original Pexpect should work on any platform that supports the standard Python pty module. While Wexpect works on Windows platforms. The Wexpect interface focuses on ease of use so that simple tasks are easy.

History

Wexpect is a one-file code developed at University of Washington. There are several copy and reference to this code with very few (almost none) documentation nor integration.

This repo tries to fix these limitations, with a few example code and pypi integration.


Dev

Thanks for any contributing!

Test

To run test, enter into the folder of the wexpect's repo then:

python -m unittest

Deploy

The deployment itself is automated and done by appveyor. See after_test section in appveyor.yml for more details.

The wexpect uses pbr for managing releasing procedures. The versioning is handled by the pbr. The "master-version" is the git tag. Pbr derives the package version from the git tags.

Basic behaviour

Let's go through the example code:

import wexpect 
child = wexpect.spawn('cmd.exe')
child.expect('>')
child.sendline('ls')
child.expect('>')
print(child.before)
child.sendline('exit')

spawn()

child = wexpect.spawn('cmd.exe')

Call trace:

  • ::spawn
  • spawn_windows::init()
  • spawn_windows::_spawn()
  • Wtty::spawn()
  • Wtty::startChild()
  • win32process.CreateProcess()

expect()

child.expect('>')

Call trace:

  • spawn_windows::expect()
  • spawn_windows::expect_list()
  • spawn_windows::expect_loop()
  • spawn_windows::read_nonblocking()
  • Wtty::read_nonblocking()
  • Wtty::readConsoleToCursor()
  • Wtty::readConsole()
  • __consout.ReadConsoleOutputCharacter()

sendline()

child.sendline('ls')

  • spawn_windows::sendline()
  • spawn_windows::send()
  • Wtty::write()

Release files for wexpect 3.1.1.dev36

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wexpect 3.1.1.dev36
File Size Uploaded Provenance Actions
wexpect-3.1.1.dev36.tar.gz 69.9 kB Without provenance Details for wexpect-3.1.1.dev36.tar.gz

Release files / wexpect-3.1.1.dev36.tar.gz

Download URL wexpect-3.1.1.dev36.tar.gz
Size 69.9 kB
Tags Source
SHA-256 checksum
How to use checksums
c09ee2c9dfcddbd52e5f29f57ec5ef4282a270014985372f69c0a36c00c10f52
BLAKE2b-256 checksum
How to use checksums
3e33de070286bfe47b490597963355e4276991d1bc3afe4ea379bd7cf716214d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/2.7.17

Security for wexpect 3.1.1.dev36

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page