Gui automation

Simple python library useful for automating tasks using images. It can run on Windows background applications.

It uses OpenCV and PyAutoGui. Made with Python 3.7.

Simple example:

import cv2
from gui_automation import GuiAuto

image_path = "win10key.png"
ga = GuiAuto()
if ga.detect(cv2.imread(image_path), 0.8):
    ga.click()

It searches windows 10 key image in the screen with 80% or more similarity. If it is found it gets clicked (it opens windows 10 start menu).

The core class is GuiAuto:

Wraps detection and controlling of the GUI. By default it will use normal image detection and foreground app automation.

Parameters

  detector: detector instance. Default is TMDetector()
  handler:  handler instance. Default is ForegroundHandler()

Methods

  detect(tpl, img=None): 
      returns Spot instance if it finds the tpl in the image. Internally, it keeps the last spot found.
  move(coords=None): 
      same as detect but it moves the cursor to the center of the found image withing the screen.
  click(coords=None): 
      Clicks the left buttons the quantity specified in @param click(default 1) in the center of the found image.
  hold(coords=None): 
      Same as click but instead of clicking X times, it holds the click @param time seconds.
  drag(start_coords, end_coords): 
      Drags from one point to another using start and end coordinates.
  drag_within(start_x_fraction, start_y_fraction, end_x_fraction, end_y_fraction): 
      Drags from one point to another inside the bounding box of the image found.

  For move, click, and hold methods if no coords are given it performs the action on the last spot found.

drag_within method

  Drags the mouse from one point to another using the tpl image width and height.
  All params are fractions in the following string format: 'number/number'.
  Eg: ga.drag_within('3/4', '0/1', '7/8', '4/5')

     3/4 of the width and 0/1 of the height for START
    __o___o_  7/8 of the width for END
   |  S     |   S = start
   |   \\   |   E = end
   |    \\  |   \\ = the mouse drag path
   |      E o 4/5 of the height for END
   |________|

Detector:

Searches an image inside another image using template match from OpenCV. Classes with default parameters:

    TMDetector(method=SQDIFF, thresh=False):
    Applies the normal detection.

    MultiscaledTMDetector(method=SQDIFF, thresh=False, reduce_sc=0.2, magnify_sc=2.0, cant_sc=40):
    Applies detection multiples times while resizing the image. Parameters specify how image is resized.

Parameters

  method: template method to use. Could be SQDIFF, CCOEFF or CCORR.
  thresh: boolean that specifies if binary threshold filter must be used for detection.
  reduce_sc: how much the image is reduced.
  magnify_sc how much the image is enlarged.
  cant_sc= how many resizing will be applied.

Handler:

Interacts with the app or environment to be automated. Performs clicks, drags among others; and also obtains the screen of the app/environment on an image format.

ForegroundHandler():
Normal handler that takes screenshot and simulates mouse action normally.

BackgroundHandlerWin32(app_name, *args):
Handler that works in not vieawable/background applications. It requires an application/window name, and it's possible to pass as arguments a names hierarchy of the UI elements of the application.
Works only for Windows.

Spot:

Wraps all position/coordinates calculations for the found image.

Methods:

  upper_left_position()
  upper_right_position()
  bottom_left_position()
  bottom_right_position()
  center_position()
  custom_position(x_multiplier, x_modifier, y_multiplier, y_modifier)

custom_position method:

  This method helps calculate any coordinate within the image detected.
  Here is some expanation of its parameters:
  x_multiplier: how many parts of the divided width to take.
  x_modifier: in how many parts the width is going to be divided.
  y_multiplier: same as x_multiplier but with height.
  y_modifier: same as x_modifier but with height.
  
  Eg: x, y = custom_position(3, 8, 1, 2)
     3/8 of the width
    __o_____
   |        |
   |        |
   |  x     o 1/2 of the height
   |        |
   |________|

Image loader:

Little module to help load images from a directory. Loads all images of a folder given in param path, and assign them to a dictionary in this way: name=>image name would be the filename without the extension. image would be the numpy array with the image data loaded with OpenCV. Path: relative or absolute path where the images are. Must finish with '/'. It returns a dictionary with the names of the images as keys, and the images themselves as values. Returns False if any error.

from gui_automation import GuiAuto, load_images
from time import sleep

buttons = load_images("images/buttons/")

ga = GuiAuto()
while not ga.detect(buttons['start'], 0.8).detect():
    ga.click()
sleep(2)
if ga.detect(buttons['accept'], 0.8):
    print("Found accept button")

In this case we load all images in "images/buttons/" folder and the wait until start button is found. After that, it waits 2 seconds and then it tries to find accept button.

Another example:

image_path = "win10keyresized.PNG"
ga = GuiAuto(detector=MultiscaledTMDetector())
spot = ga.detect(cv2.imread(image_path), 0.8)
if spot:
    ga.click(coords=spot.bottom_right(), clicks=3 )

In this case we have a similar win10key image to our original located on our rendered screen. So using MultiscaledTMDetector fixes our problem resizing the screen multiple times. If it is detected, it clicks the bottom right of the image found three times.

pyhunterpig/gui_automation