{"id":11109,"date":"2020-12-07T14:43:45","date_gmt":"2020-12-07T14:43:45","guid":{"rendered":"https:\/\/www.askpython.com\/?p=11109"},"modified":"2020-12-09T19:07:14","modified_gmt":"2020-12-09T19:07:14","slug":"pyautogui-in-python","status":"publish","type":"post","link":"https:\/\/www.askpython.com\/python-modules\/pyautogui-in-python","title":{"rendered":"Automation with PyAutoGUI in Python"},"content":{"rendered":"\n

Let’s learn to automate tasks with PyAutoGUI in Python. Whenever we come across a task that requires repetition, we try to come up with methods specifically to avoid it. That’s human nature.<\/p>\n\n\n\n

Somewhere along the line of working hard on the same task, we’ve come across an idea that we can create something that functions automatically and only needs to meet a set number of conditions to work.<\/p>\n\n\n\n

Be it a lawnmower, which requires batteries, and a field of grass, or be it code that prints the same line again and again.<\/p>\n\n\n\n

Automating has become a huge part of our lives as humans, and working with automation allows for us to focus on other tasks while the process takes place.<\/p>\n\n\n\n

However, automation requires tools to work with, and that’s where pyautogui<\/code> module comes into the picture.<\/p>\n\n\n\n

The pyautogui<\/code> module allows for the running script to control your mouse and keyboard, providing input much like how a user on the system would, allowing for interactions between applications on the system.<\/p>\n\n\n\n

Install PyAutoGUI in Python<\/h2>\n\n\n\n

We can install PyAutoGUI in Python via the PIP package manager<\/a>. You can use the same lines for installing on any operating system that works with pip.<\/p>\n\n\n

\n# Windows does not have any dependencies for installation\npip install pyautogui\n\n# Mac has two dependencies for PyAutoGUI\npip3 install pyobjc-core\npip3 install pyobjc\npip3 install pyautogui\n\n# Linux distributions require a single dependency installed\npip3 install python3-xlib\npip3 install pyautogui\n<\/pre><\/div>\n\n\n
Once we have the dependencies (if any) and the module installed, we’re good to go!<\/p>\n\n\n\n
Working with Python PyAutoGUI<\/h2>\n\n\n\n
Before working with all the great functions provided by the PyAutoGUI in Python, we must first import the module<\/a> in the script.<\/p>\n\n\n
\n# Importing the PyAutoGUI module\nimport pyautogui as pag\n<\/pre><\/div>\n\n\n
We will be using an alias for the pyautogui<\/code> module throughout this article, which we have termed above as pag<\/em>.<\/p>\n\n\n\n
1. PyAutoGUI Basic Functions<\/h3>\n\n\n\n
Before working on any script, it’s better for us to know which components perform what kind of task.<\/p>\n\n\n\n
That being said, pyautogui<\/code> in Python provides a good variety of methods to work with input,<\/p>\n\n\n
\n# Gets the size of the primary monitor.\nscreenWidth, screenHeight = pag.size() \n\n# Gets the XY position of the mouse.\ncurrentMouseX, currentMouseY = pag.position() \n\n# Move the mouse to XY coordinates.\npag.moveTo(100, 150)\n\n# Allows the script to click with the mouse.\npag.click()\n\n# Move the mouse to XY coordinates and click it.\npag.click(100, 200)\n\n# Find where button.png appears on the screen and click it.\npag.click('button.png') \n\n# Double clicks the mouse.\npag.doubleClick()\n\n# The writing functionality provided by PyAutoGUI imitates keyboard input\npag.write('Hello world!')\n\n# Presses the Esc key.\npag.press('esc')\n\n# The keyDown button causes the script to hold down on a specific key.\npag.keyDown('shift')\n\n# You can pass a list of keys to press, which will be consecutively executed.\npag.press(['left', 'left', 'left', 'left'])\n\n# Lets go of a certain key.\npag.keyUp('shift')\n\n # The hotkey() function allows for a selection of keys for hotkey usage.\npag.hotkey('ctrl', 'c')\n\n# Make an alert box appear and pause the program until OK is clicked.\npag.alert('This is the message to display.')\n<\/pre><\/div>\n\n\n
It’s also an important thing to note that the module also provides keywords to work in the script, which can be accessed by pyautogui.KEY_NAMES<\/code>.<\/p>\n\n\n\n
2. Simple Automation using PyAutoGUI in Python<\/h3>\n\n\n\n
We can create a simple spam automation to continuously send messages on any platform using a bit of Python, and the pyautogui<\/code> module.<\/p>\n\n\n\n
Let’s first import<\/a> a few modules to work with the required functions.<\/p>\n\n\n
\n# Importing the pyautogui module\nimport pyautogui as pag\n\n# Importing time to delay the input speed\nimport time\n\n# Working with Tkinter allows us to use a GUI interface to select the file to read from\nfrom tkinter import Tk\nfrom tkinter.filedialog import askopenfilename\n<\/pre><\/div>\n\n\n
Now, here’s how you get to making a spam bot.<\/p>\n\n\n\n
2.1. Provide a method of input.<\/h4>\n\n\n\n
We can provide input by manually typing the message, but, that would defeat the purpose of even automating the message spamming.<\/p>\n\n\n\n
So, let’s work with files to parse a file and write the contents to the platform. We will be using the tkinter module<\/a> to select the file to read from.<\/p>\n\n\n
\n# The withdraw function hides the root window of Tkinter\nTk().withdraw()\n\n# The askopenfilename() takes the file path from user selection.\nfilename = askopenfilename()\n<\/pre><\/div>\n\n\n
Now, we have the path of the file through the askopenfilename()<\/code> function. This path is stored in the filename<\/code> variable.<\/p>\n\n\n\n
2.2. Create a delay adjusting the speed of the spam.<\/h4>\n\n\n\n
We’ll need to also create a delay between each message so that the platform is able to accept messages one by one rather than a single message overwriting itself due to platform input lag.<\/p>\n\n\n
\n# We take the input of the user and strip it such that we only receive a numeric input.\ntimeDelay = int(input("If you want a delay, enter the number of seconds for the delay : ").split()[0])\n\n# In case the input time is designed to break the delay function, we can reset the timeDelay back to 1.\nif timeDelay < 1:\n    timeDelay = 1\n\n# We need to place the cursor in the right place to begin writing to the platform.\ntime.sleep(5)\n<\/pre><\/div>\n\n\n
2.3. Spam using PyAutoGUI!<\/h4>\n\n\n\n
We can now use the pyautogui<\/code> module to read every word from the file, and write to the platform.<\/p>\n\n\n
\nf = open(filename, "r")\nfor word in f:\n    time.sleep(timeDelay)\n    pag.typewrite(word)\n    pag.press("enter")\n<\/pre><\/div>\n\n\n
3. Complete Implementation of PyAutogui in Python<\/h3>\n\n\n\n
We are now done with the code, your final code should look something like this,<\/p>\n\n\n
\nimport pyautogui as pag\nimport time\nfrom tkinter import Tk\nfrom tkinter.filedialog import askopenfilename\n\nTk().withdraw()\nfilename = askopenfilename()\nprint(filename)\n\ntimeDelay = int(input("If you want a delay, enter the number of seconds for the delay : ").split()[0])\n\nif timeDelay < 1:\n    timeDelay = 1\n\ntime.sleep(5)\n\nf = open(filename, "r")\nfor word in f:\n    time.sleep(timeDelay)\n    pag.typewrite(word)\n    pag.press("enter")\n<\/pre><\/div>\n\n\n
Conclusion<\/h2>\n\n\n\n
Now that you’re done with this article, you know what pyautogui<\/code> in Python offers, and what you can use it for.<\/p>\n\n\n\n
While we wouldn’t necessarily recommend spamming, tinkering about is completely acceptable \ud83d\ude09<\/p>\n\n\n\n
Check out our other articles, Working with the Pandas module<\/a>, Numpy Arrays<\/a>, and Creating a Hi-Lo game using Pygame<\/a>.<\/p>\n\n\n\n
References<\/h2>\n\n\n\n