FIX: Adjustments for macOS compatibility with pynput.

Author: hhslepicka

botcity/core/bot.py

@@ -5,28 +5,28 @@
 import random
 import subprocess
 import time
-from typing import Union
 import webbrowser
+from typing import Union
 
-import pyautogui
 import pyperclip
 from botcity.base import BaseBot, State
 from botcity.base.utils import is_retina, only_if_element
-from PIL import Image
-
-from pynput.keyboard import Key, Controller as KbController
+from PIL import Image, ImageGrab
+from pynput.keyboard import Controller as KbController
+from pynput.keyboard import Key
 from pynput.mouse import Controller as MouseController
-from .input_utils import keys_map, mouse_map, _mouse_click
 
 from . import config, cv2find
+from .input_utils import _mouse_click, keys_map, mouse_map
 
 try:
     from pywinauto.application import Application, WindowSpecification
-    from .application.functions import connect, find_window, find_element
+
+    from .application.functions import connect, find_element, find_window
 except ImportError:
     pass
 
-from .application.utils import Backend, if_windows_os, if_app_connected
+from .application.utils import Backend, if_app_connected, if_windows_os
 
 try:
     from botcity.maestro import BotMaestroSDK
@@ -202,7 +202,7 @@ def _to_dict(lbs, elems):
             if elapsed_time > waiting_time:
                 return _to_dict(labels, results)
 
-            haystack = pyautogui.screenshot()
+            haystack = self.screenshot()
             helper = functools.partial(self._find_multiple_helper, haystack, region, matching, grayscale)
 
             with multiprocessing.Pool(processes=n_cpus) as pool:
@@ -225,7 +225,7 @@ def _fix_retina_element(self, ele):
             return ele
 
     def _fix_display_size(self):
-        width, height = pyautogui.size()
+        width, height = ImageGrab.grab().size
 
         if not is_retina():
             return width, height
@@ -473,7 +473,9 @@ def screenshot(self, filepath=None, region=None):
         Returns:
             Image: The screenshot Image object
         """
-        img = pyautogui.screenshot(filepath, region)
+        img = ImageGrab.grab(bbox=region)
+        if filepath:
+            img.save(filepath)
         return img
 
     def get_screenshot(self, filepath=None, region=None):
@@ -507,7 +509,7 @@ def screen_cut(self, x, y, width=None, height=None):
         y = y or 0
         width = width or screen_w
         height = height or screen_h
-        img = pyautogui.screenshot(region=(x, y, width, height))
+        img = self.screenshot(region=(x, y, width, height))
         return img
 
     def save_screenshot(self, path):
@@ -518,7 +520,7 @@ def save_screenshot(self, path):
             path (str): The filepath in which to save the screenshot
 
         """
-        pyautogui.screenshot(path)
+        self.screenshot(path)
 
     def get_element_coords(self, label, x=None, y=None, width=None, height=None, matching=0.9, best=True):
         """

botcity/core/input_utils.py

@@ -1,8 +1,9 @@
+import platform
 import time
+
 from pynput.keyboard import Key
 from pynput.mouse import Button, Controller
 
-
 keys_map = {
     "num0": '0',
     "num1": '1',
@@ -42,16 +43,23 @@
     "volumeup": Key.media_volume_up,
     "prevtrack": Key.media_previous,
     "nexttrack": Key.media_next,
-    "numlock": Key.num_lock,
-    "printscreen": Key.print_screen,
-    "prntscrn": Key.print_screen,
-    "prtsc":  Key.print_screen,
-    "prtscr": Key.print_screen,
-    "print": Key.print_screen,
-    "scrolllock": Key.scroll_lock,
     "return": Key.enter
 }
 
+if platform.system() != "Darwin":
+    keys_map.update(
+        {
+            "numlock": Key.num_lock,
+            "prtsc":  Key.print_screen,
+            "prtscr": Key.print_screen,
+            "printscreen": Key.print_screen,
+            "prntscrn": Key.print_screen,
+            "print": Key.print_screen,
+            "scrolllock": Key.scroll_lock,
+        }
+    )
+
+
 
 mouse_map = {
     "left": Button.left,
@@ -64,13 +72,17 @@ def _mouse_click(mouse_controller: Controller, x: int, y: int, clicks=1, interva
     """
     Moves the mouse and clicks at the coordinate defined by x and y.
     """
-    mouse_button = mouse_map.get(button, None)
-    if not mouse_button:
-        raise ValueError(f'''Invalid mouse button name.
-        The mouse button has to be one of these values: {list(mouse_map.keys())}''')
+    if platform.system() == "Darwin":
+        from . import os_compat
+        os_compat.osx_click(x=x, y=y, clicks=clicks, interval=interval_between_clicks, button=button)
+    else:
+        mouse_button = mouse_map.get(button, None)
+        if not mouse_button:
+            raise ValueError(f'''Invalid mouse button name.
+            The mouse button has to be one of these values: {list(mouse_map.keys())}''')
 
-    mouse_controller.position = (x, y)
-    time.sleep(0.1)
-    for i in range(clicks):
-        mouse_controller.click(button=mouse_button, count=1)
-        time.sleep(interval_between_clicks / 1000.0)
+        mouse_controller.position = (x, y)
+        time.sleep(0.1)
+        for i in range(clicks):
+            mouse_controller.click(button=mouse_button, count=1)
+            time.sleep(interval_between_clicks / 1000.0)

botcity/core/os_compat.py

@@ -1,26 +1,27 @@
 # Module for OS Compatibility issues and PyAutoGui
 import platform
 
-import pyautogui
+OSX_LEFT = "left"
+OSX_MIDDLE = "middle"
+OSX_RIGHT = "right"
 
-if platform.system() == "Darwin":
-    import pyautogui._pyautogui_osx as osx
 
+if platform.system() == "Darwin":
     def _multiClick(x, y, button, num, interval=0.0):
         import Quartz
         btn = None
         down = None
         up = None
 
-        if button == osx.LEFT:
+        if button == OSX_LEFT:
             btn = Quartz.kCGMouseButtonLeft
             down = Quartz.kCGEventLeftMouseDown
             up = Quartz.kCGEventLeftMouseUp
-        elif button == osx.MIDDLE:
+        elif button == OSX_MIDDLE:
             btn = Quartz.kCGMouseButtonCenter
             down = Quartz.kCGEventOtherMouseDown
             up = Quartz.kCGEventOtherMouseUp
-        elif button == osx.RIGHT:
+        elif button == OSX_RIGHT:
             btn = Quartz.kCGMouseButtonRight
             down = Quartz.kCGEventRightMouseDown
             up = Quartz.kCGEventRightMouseUp
@@ -34,14 +35,12 @@ def _multiClick(x, y, button, num, interval=0.0):
         Quartz.CGEventPost(Quartz.kCGHIDEventTap, mouseEvent)
 
 
-def click(x=None, y=None, clicks=1, interval=0.0, button="left", **kwargs):
+def osx_click(x=None, y=None, clicks=1, interval=0.0, button="left", **kwargs):
     """
     This method is here due to issues with pyautogui implementation of multiple clicks on macOS.
     For that, the code above from _multiClick was pulled from pyautogui and locally patched.
     A PR will be submitted to the pyautogui project to fix the issue upstream and once a new
     release with the patch is available we will remove our local patch here.
     """
-    if platform.system() == "Darwin":
-        _multiClick(x=x, y=y, button=button, num=clicks, interval=interval)
-    else:
-        pyautogui.click(x=x, y=y, clicks=clicks, interval=interval, button=button, **kwargs)
+    _multiClick(x=x, y=y, button=button, num=clicks, interval=interval)
+

requirements.txt

@@ -1,6 +1,4 @@
 botcity-framework-base>=0.4.0,<1.0
-pyautogui==0.9.53
-pyscreeze==0.1.27
 pyperclip
 opencv-python
 python-xlib