WIP: macOS implementation of keyboard, mouse, AxElementInfo and Application

.travis.yml

@@ -1,72 +1,135 @@
 sudo: required
 dist: trusty
 language: cpp
-notifications:
-  email: false
 
+# env:
+# Run against all supported versions of Python (this environment variable is
+# used further down the fetch an appropriate Python interpreter).
+matrix:
+  include:
+    - os: osx
+      osx_image: xcode8
+      env: PYVER=2.7
+      language: generic
+    - os: osx
+      osx_image: xcode8
+      env: PYVER=3.5
+      language: generic
+    - os: osx
+      osx_image: xcode8
+      env: PYVER=3.6
+      language: generic
+    - os: linux
+      language: python
+      python: 2.7
+    # - os: linux
+    #   language: python
+    #   python: 3.3
+    - os: linux
+      language: python
+      python: 3.4
+    - os: linux
+      language: python
+      python: 3.5
+    - os: linux
+      language: python
+      python: 3.6
 
-language: python
-
-python:
-  #- "2.6"
-  - "2.7_with_system_site_packages"
-  - "3.3"
-  - "3.4_with_system_site_packages"
-  - "3.5"
-  - "3.6"
-os:
-  - linux
 before_install:
-  - sudo add-apt-repository -y ppa:beineri/opt-qt58-trusty
+  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo add-apt-repository -y ppa:beineri/opt-qt58-trusty; fi
 
 install:
-  - pip install python-xlib codecov coverage
+  # Install 'pyenv': a utility for downloading and switching between multiple
+  # Python interpreters on the same system.
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then git clone https://github.com/yyuu/pyenv.git ~/.pyenv; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then PYENV_ROOT="$HOME/.pyenv"; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then PATH="$PYENV_ROOT/bin:$PATH"; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then eval "$(pyenv init -)"; fi
+  # Install the latest release of the specified Python version using pyenv.
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then PYVER="$(pyenv install --list | grep -E "^\\s*$PYVER" | sort -n -t. -k3 | tail -n1)"; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then pyenv install $PYVER; fi
+  # Make the newly installed version the default "python" command.
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then pyenv global $PYVER; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then python --version; fi
+   # Install PIP
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then curl -O https://bootstrap.pypa.io/get-pip.py; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then python get-pip.py --user; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then python -m pip install pip==9.0.3; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then python -m pip install six; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then pip install codecov coverage pyobjc; fi
+
+
+  # Linux dev dependencies:
+
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then pip install python-xlib codecov coverage; fi
   # All this dependencies only to build tests application. No real dependency of this packages
-  - sudo apt-get update
-  - sudo apt-get -y install at-spi2-core
-  - sudo apt-get install -qq qt58base;
-  - sudo apt-get -y install qt58declarative qt58tools
-  - sudo apt-get install xsel
-  - sudo apt-get install libgtk-3-dev libgtk2.0-dev
-  - sudo apt-get install -y python3-gi
-  - source /opt/qt58/bin/qt58-env.sh;
-  
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then sudo apt-get update; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then sudo apt-get -y install at-spi2-core; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then sudo apt-get install -qq qt58base; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then sudo apt-get -y install qt58declarative qt58tools; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then sudo apt-get install xsel; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then sudo apt-get install libgtk-3-dev libgtk2.0-dev; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then sudo apt-get install -y python3-gi; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then source /opt/qt58/bin/qt58-env.sh; fi
+
 before_script:
-  - "export DISPLAY=:99.0"
-  - "sh -e /etc/init.d/xvfb start"
-  - sleep 3 # give xvfb some time to start
-  - xauth generate :99.0 . trusted
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then export DISPLAY=:99.0; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then sh -e /etc/init.d/xvfb start; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then sleep 3; fi
+  # give xvfb some time to start;
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then xauth generate :99.0 . trusted; fi
   # Clone test apps
-  - git init apps
-  - cd apps
-  - git remote add -f origin https://github.com/pywinauto/PywinautoTestapps/
-  - git config core.sparseCheckout true
-  - echo "MouseTester/source" >> .git/info/sparse-checkout
-  - echo "SendKeysTester/source" >> .git/info/sparse-checkout
-  - git pull origin master
-  # Build test apps
-  - cd MouseTester/source
-  - qmake
-  - make
-  - chmod a+x mousebuttons
-  - cp mousebuttons ../
-  - cd $TRAVIS_BUILD_DIR
-  - cd apps/SendKeysTester/source
-  - qmake
-  - make
-  - chmod a+x send_keys_test_app
-  - cp send_keys_test_app ../
-  - cd $TRAVIS_BUILD_DIR
-  - chmod a+x $TRAVIS_BUILD_DIR/apps/Gtk_samples/gtk_example.py
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then git init apps; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then cd apps; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then git remote add -f origin https://github.com/pywinauto/PywinautoTestapps/; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then git config core.sparseCheckout true; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then echo "MouseTester/source" >> .git/info/sparse-checkout; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then echo "SendKeysTester/source" >> .git/info/sparse-checkout; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then git pull origin master; fi
+
+  # Build test apps on Linux
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then cd MouseTester/source; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then qmake; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then make; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then chmod a+x mousebuttons; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then cp mousebuttons ../; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then cd $TRAVIS_BUILD_DIR; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then cd apps/SendKeysTester/source; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then qmake; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then make; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then chmod a+x send_keys_test_app; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then cp send_keys_test_app ../; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then cd $TRAVIS_BUILD_DIR; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then chmod a+x $TRAVIS_BUILD_DIR/apps/Gtk_samples/gtk_example.py; fi
+
+  # Install test apps on macOS
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then cd $TRAVIS_BUILD_DIR; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then cd apps/MouseTester/macos; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then sudo hdiutil attach mousebuttons.dmg; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then sudo cp -R /Volumes/mousebuttons/mousebuttons.app /Applications; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then sudo hdiutil detach /Volumes/mousebuttons/; fi
+
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then cd $TRAVIS_BUILD_DIR; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then cd apps/SendKeysTester/macos; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then sudo hdiutil attach send_keys_test_app.dmg; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then sudo cp -R /Volumes/send_keys_test_app/send_keys_test_app.app /Applications; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then sudo hdiutil detach /Volumes/send_keys_test_app/; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then cd $TRAVIS_BUILD_DIR; fi
 
 script:
-  - coverage run -a --include=pywinauto/mouse.py pywinauto/unittests/test_mouse.py
-  - coverage run -a --include=pywinauto/linux/keyboard.py pywinauto/unittests/test_keyboard.py
-  - coverage run -a --include=pywinauto/linux/clipboard.py pywinauto/unittests/test_clipboard_linux.py
-  - coverage run -a --include=pywinauto/linux/application.py pywinauto/unittests/test_application_linux.py
-  - coverage run -a --source=pywinauto/linux,pywinauto/controls pywinauto/unittests/test_atspi_element_info.py
-  - coverage run -a --source=pywinauto/linux,pywinauto/controls pywinauto/unittests/test_atspi_wrapper.py
-  - coverage run -a --source=pywinauto/linux,pywinauto/controls pywinauto/unittests/test_atspi_controls.py
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then coverage run -a --include=pywinauto/mouse.py pywinauto/unittests/test_mouse.py; fi
+  - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then coverage run -a --include=pywinauto/macos/keyboard_helper.py pywinauto/unittests/test_keyboard.py; fi
+  # Application and element info unit test are turned off due to we are not able to provide the accessibility permissions for testing on remote environment
+  # - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then coverage run -a --source=pywinauto/macos pywinauto/unittests/test_application_macos.py; fi
+  # - if [[ $TRAVIS_OS_NAME == 'osx' ]]; then coverage run -a --source=pywinauto/macos pywinauto/unittests/test_ax_element_info_macos.py; fi
+
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then coverage run -a --include=pywinauto/mouse.py pywinauto/unittests/test_mouse.py; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then coverage run -a --include=pywinauto/linux/keyboard.py pywinauto/unittests/test_keyboard.py; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then coverage run -a --include=pywinauto/linux/clipboard.py pywinauto/unittests/test_clipboard_linux.py; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then coverage run -a --include=pywinauto/linux/application.py pywinauto/unittests/test_application_linux.py; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then coverage run -a --source=pywinauto/linux,pywinauto/controls pywinauto/unittests/test_atspi_element_info.py; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then coverage run -a --source=pywinauto/linux,pywinauto/controls pywinauto/unittests/test_atspi_wrapper.py; fi
+  - if [[ $TRAVIS_OS_NAME == 'linux' ]]; then coverage run -a --source=pywinauto/linux,pywinauto/controls pywinauto/unittests/test_atspi_controls.py; fi
 
 after_success:
   - codecov

dev-requirements.txt

@@ -1,4 +1,23 @@
-pywin32
+# Windows specific packages
+#
+pywin32                                   ;sys_platform == 'win32'
+
+# macOS specific packages
+#
+pyobjc-core==5.3                          ; sys_platform == 'darwin'
+pyobjc-framework-AppleScriptObjC==5.3     ; sys_platform == 'darwin'
+pyobjc-framework-ApplicationServices==5.3 ; sys_platform == 'darwin'
+pyobjc-framework-Cocoa==5.3               ; sys_platform == 'darwin'
+pyobjc-framework-CoreText==5.3            ; sys_platform == 'darwin'
+pyobjc-framework-FSEvents==5.3            ; sys_platform == 'darwin'
+pyobjc-framework-Quartz==5.3              ; sys_platform == 'darwin'
+
+# Linux specific packages
+#
+python-xlib                               ; sys_platform == 'linux'
+
+# Cross Platform packages
+#
 six
 pillow>=6.2.0
 coverage
@@ -7,4 +26,5 @@ codecov
 rst2pdf
 Sphinx
 mock==2.0.0
-codacy-coverage
+codacy-coverage
+

docs/index.txt

@@ -147,7 +147,7 @@ There are loads of reasons :-)
     Most other tools are not object oriented you end  up writing stuff like::
 
         window = findwindow(title = "Untitled - Notepad", class = "Notepad")
-        SendKeys(window, "%OF")  # Format -> Font
+        send_keys(window, "%OF")  # Format -> Font
         fontdialog  = findwindow("title = "Font")
         buttonClick(fontdialog, "OK")
 

pywinauto/application.py

@@ -1,40 +1,45 @@
-# GUI Application automation and testing library
-# Copyright (C) 2006-2019 Mark Mc Mahon and Contributors
-# https://github.com/pywinauto/pywinauto/graphs/contributors
-# http://pywinauto.readthedocs.io/en/latest/credits.html
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# * Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
-#
-# * Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
-#
-# * Neither the name of pywinauto nor the names of its
-#   contributors may be used to endorse or promote products derived from
-#   this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-import sys
-
-from .base_application import WindowSpecification  # noqa: W0611
-
-if sys.platform == 'win32':
-    from .windows.application import Application  # noqa: W0611
-else:
-    from .linux.application import Application  # noqa: W0611
-
-__all__ = ["WindowSpecification", "Application"]
+# GUI Application automation and testing library
+# Copyright (C) 2006-2019 Mark Mc Mahon and Contributors
+# https://github.com/pywinauto/pywinauto/graphs/contributors
+# http://pywinauto.readthedocs.io/en/latest/credits.html
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of pywinauto nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+import sys
+
+from .base_application import WindowSpecification  # noqa: W0611
+
+if sys.platform == 'win32':
+    from .windows.application import Application  # noqa: W0611
+elif sys.platform == 'darwin':
+    from .macos.application import Application
+elif sys.platform.startswith('linux'):
+    from .linux.application import Application  # noqa: W0611
+else:
+    raise NotImplementedError('Platform "{}" is not supported! ' \
+        'Possible platforms: "win32", "linux*", "darwin".'.format(sys.platform))
+
+__all__ = ["WindowSpecification", "Application"]

pywinauto/base_application.py

@@ -711,6 +711,10 @@ class BaseApplication(object):
     .. automethod:: __getitem__
     """
 
+    def __iter__(self):
+        """Raise to avoid infinite loops"""
+        raise NotImplementedError("Object is not iterable, try to use method .windows()")
+
     def connect(self, **kwargs):
         """Connect to an already running process
 

pywinauto/controls/__init__.py

@@ -28,13 +28,15 @@
 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-import sys
 """Controls package"""
+
+import sys
+
 if sys.platform.startswith('linux'):
     from . import atspiwrapper  # register "atspi" back-end
     from . import atspi_controls
     from .atspiwrapper import InvalidWindowHandle
-else:
+elif sys.platform == 'win32':
     from ..sysinfo import UIA_support
     if UIA_support:
         from . import uiawrapper # register "uia" back-end (at the end of uiawrapper module)
@@ -47,6 +49,9 @@
     # contain
     from . import common_controls
     from . import win32_controls
-
+elif sys.platform == "darwin":
+    pass
+else:
+    raise NotImplementedError('Platform "{}" is not supported'.format(sys.platform))
 
 from ..base_wrapper import InvalidElement

pywinauto/keyboard.py

@@ -114,18 +114,19 @@
 
 from . import deprecated
 
-if sys.platform != 'win32':
-    from .linux.keyboard import KeySequenceError, KeyAction, PauseAction
-    from .linux.keyboard import handle_code, parse_keys, send_keys
-else:
+if sys.platform == 'win32':
     import time
     import ctypes
-
     import win32api
     import six
-
     from .windows import win32structures
     from .windows import win32functions
+elif sys.platform == "darwin":
+    from .macos.keyboard import KeySequenceError, KeyAction, PauseAction
+    from .macos.keyboard import handle_code, parse_keys, send_keys
+else:
+    from .linux.keyboard import KeySequenceError, KeyAction, PauseAction
+    from .linux.keyboard import handle_code, parse_keys, send_keys
 
     __all__ = ['KeySequenceError', 'send_keys']