pywinauto/pywinauto


Windows GUI Automation with Python (based on text properties)

http://pywinauto.github.io/

License: BSD-3-Clause

Language: Python

Keywords: automation, gui, hooks, linux, python, python-library, pywinauto, qa, testing, testing-tools, ui-automated-tests, ui-automation, uiautomation, user-interface, win32api, windows, windows-api


Donate Join the chat at https://gitter.im/pywinauto/pywinauto Documentation Status Windows Tests Linux Tests codecov.io Code Health Codacy Badge

pywinauto

pywinauto is a set of python modules to automate the Microsoft Windows GUI. At its simplest it allows you to send mouse and keyboard actions to windows dialogs and controls, but it has support for more complex actions like getting text data.

Supported technologies under the hood: Win32 API (backend="win32"; used by default), MS UI Automation (backend="uia"). User input emulation modules mouse and keyboard work on both Windows and Linux.

Enjoying this?

Just star the repo or make a donation.

paypal

Your help is valuable since this is a hobby project for all of us: we do new features development during out-of-office hours.

  • In general the library tends to be cross-platform in the near future (Linux in 2018, macOS in 2019).
  • Reliable text based "record-replay" generator is also a high priority feature under development.
  • More feature requests and discusions are welcome in the issues.

Setup

  • run pip install -U pywinauto (dependencies will be installed automatically)

Documentation / Help

Simple Example

It is simple and the resulting scripts are very readable. How simple?

from pywinauto.application import Application
app = Application().start("notepad.exe")

app.UntitledNotepad.menu_select("Help->About Notepad")
app.AboutNotepad.OK.click()
app.UntitledNotepad.Edit.type_keys("pywinauto Works!", with_spaces = True)

MS UI Automation Example

More detailed example for explorer.exe:

from pywinauto import Desktop, Application

Application().start('explorer.exe "C:\\Program Files"')

# connect to another process spawned by explorer.exe
# Note: make sure the script is running as Administrator!
app = Application(backend="uia").connect(path="explorer.exe", title="Program Files")

app.ProgramFiles.set_focus()
common_files = app.ProgramFiles.ItemsView.get_item('Common Files')
common_files.right_click_input()
app.ContextMenu.Properties.invoke()

# this dialog is open in another process (Desktop object doesn't rely on any process id)
Properties = Desktop(backend='uia').Common_Files_Properties
Properties.print_control_identifiers()
Properties.Cancel.click()
Properties.wait_not('visible') # make sure the dialog is closed

Dependencies (if install manually)

  • Windows:
  • Linux:
  • Optional packages:
    • Install Pillow (by pip install -U Pillow) to be able to call capture_as_image() method for making a control's snapshot.

Packages required for running unit tests

Run all the tests: python ./pywinauto/unittests/testall.py

Contribution

Pull requests are very welcome. Read Contribution Guide for more details about unit tests, coding conventions, etc.

Copyrights

Pywinauto for native Windows GUI was initially written by Mark Mc Mahon. Mark brought many great ideas into the life using power of Python. Further contributors are inspired of the nice API so that the development continues.

Starting from 0.6.0 pywinauto is distributed under the BSD 3-clause license. Pywinauto 0.5.4 and before was distributed under the LGPL v2.1 or later.

  • (c) The Open Source Community, 2015-2018 (0.6.0+ development)
  • (c) Intel Corporation, 2015 (0.5.x maintenance)
  • (c) Michael Herrmann, 2012-2013 (0.4.2)
  • (c) Mark Mc Mahon, 2006-2010 (0.4.0 and before)

Project Statistics

Sourcerank 8
Repository Size 21.6 MB
Stars 1,422
Forks 304
Watchers 124
Open issues 167
Dependencies 13
Contributors 45
Tags 29
Created
Last updated
Last pushed

Top Contributors See all

Vasily Ryabov Valentin Kroupkin Alexander Rumyantsev Ivan Magazinnik Denis Matiychuk Oleg Kainov Aleksandr Vilchinskii Max Dmitry Efremov Nikita Kudriavtsev Syainova-Diana ViktorRoy94 skachkova-natalia Boris Galochkin Artem Skrebkov EgorSharov YusipovIgor nikkrasn Vladislav Sovrasov BlinkovaEkaterina

Recent Tags See all

0.6.4 January 21, 2018
0.6.3 July 03, 2017
0.6.2 February 28, 2017
0.6.1 February 08, 2017
0.6.0 October 31, 2016
0.5.4 October 30, 2015
0.5.3 September 25, 2015
0.5.2 September 08, 2015
0.5.1 July 13, 2015
0.5.0 June 29, 2015
0.4.2 September 16, 2013
0.4.1 March 01, 2013
0.4.0 April 03, 2010
0.3.8 March 15, 2009
0.3.7 April 10, 2007

Interesting Forks See all

tkhanova/pywinauto
Windows GUI Automation with Python (64-bit Py3 compatible)
Python - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2017-02-11 08:21:06 UTC

Login to resync this repository