Skip to content

Commit

Permalink
Update readme.txt.
Browse files Browse the repository at this point in the history
  • Loading branch information
vasily-v-ryabov committed Jun 29, 2015
1 parent 01a8ec1 commit dc08488
Showing 1 changed file with 43 additions and 116 deletions.
159 changes: 43 additions & 116 deletions Readme.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
pywinauto
(c) Mark Mc Mahon 2006
Released under the LGPL licence
pywinauto
(c) Mark Mc Mahon 2006-2015
Released under the LGPL v2.1 or later


What is it
Expand All @@ -12,19 +12,21 @@ dialogs and controls.

Installation
------------

Unzip the pywinauto zip file to a folder.
Install the following Python packages
ctypes http://starship.python.net/crew/theller/ctypes/
Sendkeys http://www.rutherfurd.net/python/sendkeys/index.html
(Required) pyWin32 http://sourceforge.net/projects/pywin32/files/pywin32/
(Optional) PIL http://www.pythonware.com/products/pil/index.htm
(Optional) elementtree http://effbot.org/downloads/
Unzip the pywinauto zip file to a folder.
Run "python setup.py install"

To check you have it installed correctly
run Python
>>> import application
>>> app = application.Application().start_("notepad")
>>> app.notepad.TypeKeys("%FX")
>>> from pywinauto.application import Application
>>> app = Application.start("notepad.exe")
>>> app.UntitledNotepad.TypeKeys("%FX")

Installation in silent mode (Python 2.7, 3.1-3.5)
------------
Just run "pip install pywinauto"


Where to start
Expand All @@ -51,6 +53,7 @@ myapp.PageSetup.OK # looks first for a dialog with a title like "PageSetup"
This attribute resolution is delayed (currently a hard coded amount of time) until
it succeeds. So for example if you Select a menu option and then look for the
resulting dialog e.g.

app.Notepad.MenuSelect("File->SaveAs")
app.SaveAs.ComboBox5.Select("UTF-8")
app.SaveAs.edit1.SetText("Example-utf8.txt")
Expand All @@ -64,111 +67,35 @@ this is repeated up to a maximum time (currently 1 second!)

This avoid the user having to use time.sleep or a "WaitForDialog" function.

If your application performs long time operation, new dialog can appear or
disappear later. You can wait for its new state like so ::

app.Open.Open.Click() # opening large file
app.Open.WaitNot('visible') # make sure "Open" dialog became invisible
# wait for up to 30 seconds until data.txt is loaded
app.Window(title='data.txt - Notepad').Wait('ready', timeout=30)


Some similar tools for comparison
---------------------------------
* Python tools
- Watsup
- winGuiAuto

* Other scripting language tools
- Perl Win32::GuiTest
- Ruby GuiTest
- others?

* Other free tools
- AutoIt
- See collection at:

* Commercial tools
- WinRunner
- SilkTest
- Visual Test
=======
pywinauto
(c) Mark Mc Mahon 2006
Released under the LGPL licence


What is it
----------
pywinauto is a set of python modules to automate the Microsoft Windows GUI.
At it's simplest it allows you to send mouse and keyboard actions to windows
dialogs and controls.


Installation
------------

Unzip the pywinauto zip file to a folder.
Install the following Python packages
ctypes http://starship.python.net/crew/theller/ctypes/
Sendkeys http://www.rutherfurd.net/python/sendkeys/index.html
(Optional) PIL http://www.pythonware.com/products/pil/index.htm
(Optional) elementtree http://effbot.org/downloads/

To check you have it installed correctly
run Python
>>> import application
>>> app = application.Application().start_("notepad")
>>> app.notepad.TypeKeys("%FX")


Where to start
--------------
Look at the examples provided in test_application.py
There are examples in there to work with Notepad and MSPaint.

Note: These examples currently only work on English.


How does it work
----------------
A lot is done through attribute access (__getattr__) for each class. For example
when you get the attribute of an Application or Dialog object it looks for a
dialog or control (respectively).

myapp.Notepad # looks for a Window/Dialog of your app that has a title 'similar'
# to "Notepad"

myapp.PageSetup.OK # looks first for a dialog with a title like "PageSetup"
# then it looks for a control on that dialog with a title
# like "OK"

This attribute resolution is delayed (currently a hard coded amount of time) until
it succeeds. So for example if you Select a menu option and then look for the
resulting dialog e.g.
app.Notepad.MenuSelect("File->SaveAs")
app.SaveAs.ComboBox5.Select("UTF-8")
app.SaveAs.edit1.SetText("Example-utf8.txt")
app.SaveAs.Save.Click()

At the 2nd line the SaveAs dialog might not be open by the time this line is
executed. So what happens is that we wait until we have a control to resolve
before resolving the dialog. At that point if we can't find a SaveAs dialog with
a ComboBox5 control then we wait a very short period of time and try again,
this is repeated up to a maximum time (currently 1 second!)

This avoid the user having to use time.sleep or a "WaitForDialog" function.


Some similar tools for comparison
---------------------------------
* Python tools
- Watsup
- winGuiAuto

* Other scripting language tools
- Perl Win32::GuiTest
- Ruby GuiTest
- others?

* Other free tools
- AutoIt
- See collection at:

* Commercial tools
- WinRunner
- SilkTest
- Visual Test
- Many Others
* Python tools

- PyAutoGui
- AXUI
- winGuiAuto

* Other scripting language tools

- Perl Win32::GuiTest
- Ruby Win32-Autogui

* Other free tools

- AutoIt
- See collection at: https://github.com/atinfo/awesome-test-automation

* Commercial tools

- WinRunner
- SilkTest
- Many Others

0 comments on commit dc08488

Please sign in to comment.