MSS: Speed-up grabbing o the 3 platforms

Author: BoboTiG

.github/ISSUE_TEMPLATE.md

@@ -7,7 +7,7 @@ General informations:
     * Monitor 1: _800x600_
     * Monitor 2: _1920x1080_
 * Python version: _3.6.4_
-* MSS version: __3.1.3__
+* MSS version: __3.2.0__
 
 
 For GNU/Linux users:

.gitignore

@@ -10,3 +10,4 @@ MANIFEST*
 *.png
 *.png.old
 *.pyc
+.pytest_cache

.travis.yml

@@ -1,10 +1,9 @@
 language: python
 python:
   - 2.7
-  - 3.4
   - 3.5
   - 3.6
-#  - nightly # currently points to 3.7-dev
+  - nightly # currently points to 3.7-dev
 
 addons:
   apt:
@@ -25,12 +24,9 @@ install:
 script:
   - py.test --showlocals --display=":42.0"
   - flake8 .
-  - pylint mss
+  - if [[ $TRAVIS_PYTHON_VERSION < '3.7' ]]; then pylint mss; fi
   - if [[ $TRAVIS_PYTHON_VERSION > '2.8' ]]; then cd docs && make clean html; fi
 
 after_script:
   - xpra stop :42
   - cat ~/.xpra/*.log
-
-matrix:
-    fast_finish: true

CHANGELOG

@@ -4,7 +4,9 @@ History:
 
 dev     2018/xx/xx
       - add PNG compression level control
-      - MSS: add Screenshot.bgra attribute
+      - MSS: add the Screenshot.bgra attribute
+      - MSS: speed-up grabbing on the 3 platforms
+      - tests: add leaks.py and benchmarks.py for manual testing
 
 3.1.2   2018/01/05
       - removed support for Python 3.3
@@ -26,7 +28,7 @@ dev     2018/xx/xx
       - Mac: properly support all display scaling and resolutions (fix #14, #19, #21, #23)
       - Mac: fix memory leaks (fix #24)
       - Linux: handle bad display value
-      - Windows: Take into account zoom factor for high-DPI displays (fix #20)
+      - Windows: take into account zoom factor for high-DPI displays (fix #20)
 
 3.0.1   2017/07/06
       - fix examples links

CHANGES.rst

@@ -1,10 +1,14 @@
-3.1.3 (2018-xx-xx)
+3.2.0 (2018-xx-xx)
 ==================
 
 base.py
 -------
 - Added ``MSSBase.compression_level`` to control the PNG compression level
 
+linux.py
+--------
+- Added ``MSS.drawable`` to speed-up grabbing.
+
 screenshot.py
 -------------
 - Added ``Screenshot.bgra`` to get BGRA bytes.

docs/source/api.rst

@@ -124,7 +124,7 @@ Methods
 
     .. versionadded:: 3.0.0
 
-    .. versionadded:: 3.1.3
+    .. versionadded:: 3.2.0
 
         Added the ``level`` keyword argument to control the PNG compression level.
 
@@ -169,7 +169,7 @@ Properties
 
         :rtype: bytes
 
-        .. versionadded:: 3.1.3
+        .. versionadded:: 3.2.0
 
     .. attribute:: height
 

docs/source/conf.py

@@ -31,7 +31,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '3.1.3'
+version = '3.2.0'
 
 # The full version, including alpha/beta/rc tags.
 release = 'latest'

docs/source/developers.rst

@@ -23,7 +23,7 @@ You will need `pytest <https://pypi.python.org/pypi/pytest>`_::
     $ pip install pytest
 
 
-How to test?
+How to Test?
 ------------
 
 Enable the developer mode::
@@ -39,7 +39,7 @@ Launch the test suit::
     As he module is Python 2 and 3 compliant, do no forgot to test for both. If you cannot, just say it when sending the patch, someone else will validate for you.
 
 
-Validating the code
+Validating the Code
 ===================
 
 It is important to keep a clean base code. Use tools like `flake8 <https://pypi.python.org/pypi/flake8>`_ and `Pylint <https://pypi.python.org/pypi/pylint>`_.
@@ -53,7 +53,7 @@ Install required packages::
     $ pip install flake8 pylint
 
 
-How to validate?
+How to Validate?
 ----------------
 
 ::
@@ -64,7 +64,7 @@ How to validate?
 If there is no output, you are good ;)
 
 
-Static type checking
+Static Type Checking
 ====================
 
 `mypy <http://mypy-lang.org/>`_ is a compile-time static type checker for Python, allowing optional, gradual typing of Python code.
@@ -79,7 +79,7 @@ Install required packages::
     $ pip install mypy-lang
 
 
-Running mypy
+Running Mypy
 ------------
 
 ::
@@ -98,7 +98,7 @@ You will need `Sphinx <http://sphinx-doc.org/>`_::
     $ pip install sphinx
 
 
-How to build?
+How to Build?
 -------------
 
 ::

docs/source/examples.rst

@@ -63,7 +63,7 @@ You can tweak the PNG compression level (see :py:func:`zlib.compress()` for deta
 
     sct.compression_level = 2
 
-.. versionadded:: 3.1.3
+.. versionadded:: 3.2.0
 
 Advanced
 ========

docs/source/installation.rst

@@ -4,15 +4,15 @@
 Installation
 ============
 
-Recommended way
+Recommended Way
 ===============
 
 Quite simple::
 
     $ pip install --upgrade mss
 
 
-From sources
+From Sources
 ============
 
 Alternatively, you can get a copy of the module from GitHub::

docs/source/support.rst

@@ -4,7 +4,7 @@ Support
 
 Feel free to try MSS on a system we had not tested, and let report us by creating an `issue <htps://github.com/BoboTiG/python-mss/issues>`_.
 
-GNU/Linux, macOS and Windows: **2.7**, 3.4, 3.5, **3.6** and 3.7-dev.
+GNU/Linux, macOS and Windows: **2.7**, 3.5, **3.6** and 3.7-dev.
 
 
 Future
@@ -23,8 +23,9 @@ Tested successfully on Pypy 5.1.0 on Windows, but speed is terrible.
 Abandoned
 =========
 
-- 2016-10-08 Support for Python 2.6 was dropped: too old and introduced optimizations broke it.
-- 2016-10-08 Support for Python 3.0, 3.1, and 3.2 was dropped: there is no more tests facilities.
-- 2017-12-05 Support for Python 3.3 was dropped: there is no more tests facilities for the documentation.
+- Python 2.6 (2016-10-08)
+- Python 3.0, 3.1, and 3.2 (2016-10-08)
+- Python 3.3 (2017-12-05)
+- Python 3.4 (2018-03-19)
 
 By the way, if you find the *force*, give it a try and tell us if you managed to make one of these versions working (a patch should be quite easy).

docs/source/usage.rst

@@ -49,7 +49,25 @@ A more specific example to only target GNU/Linux:
     :lines: 9-
 
 
-Command line
+Intensive Use
+=============
+
+If you plan to integrate MSS inside your own module or software, pay attention to using it wisely. This is a bad usage::
+
+    for _ in range(100):
+        with mss() as sct:
+            sct.shot()
+
+This is a better usage, memory efficient::
+
+    with mss() as sct:
+        for _ in range(100):
+            sct.shot()
+
+Also, it is a good thing to save the MSS instance inside an attribute of you class and calling it when needed.
+
+
+Command Line
 ============
 
 You can use ``mss`` via the CLI:

docs/source/where.rst

@@ -1,5 +1,5 @@
 ============
-Who uses it?
+Who Uses it?
 ============
 
 This is a non exhaustive list where MSS is integrated or has inspired.

mss/__init__.py

@@ -13,7 +13,7 @@
 from .exception import ScreenShotError
 from .factory import mss
 
-__version__ = '3.1.3'
+__version__ = '3.2.0'
 __author__ = "Mickaël 'Tiger-222' Schoentgen"
 __copyright__ = """
     Copyright (c) 2013-2018, Mickaël 'Tiger-222' Schoentgen

mss/darwin.py

@@ -187,29 +187,30 @@ def grab(self, monitor):
                 'height': monitor[3] - monitor[1],
             }
 
+        core = self.core
         rect = CGRect((monitor['left'], monitor['top']),
                       (monitor['width'], monitor['height']))
 
-        image_ref = self.core.CGWindowListCreateImage(rect, 1, 0, 0)
+        image_ref = core.CGWindowListCreateImage(rect, 1, 0, 0)
         if not image_ref:
             raise ScreenShotError(
                 'CoreGraphics.CGWindowListCreateImage() failed.', locals())
 
-        width = int(self.core.CGImageGetWidth(image_ref))
-        height = int(self.core.CGImageGetHeight(image_ref))
+        width = int(core.CGImageGetWidth(image_ref))
+        height = int(core.CGImageGetHeight(image_ref))
         prov = copy_data = None
         try:
-            prov = self.core.CGImageGetDataProvider(image_ref)
-            copy_data = self.core.CGDataProviderCopyData(prov)
-            data_ref = self.core.CFDataGetBytePtr(copy_data)
-            buf_len = self.core.CFDataGetLength(copy_data)
+            prov = core.CGImageGetDataProvider(image_ref)
+            copy_data = core.CGDataProviderCopyData(prov)
+            data_ref = core.CFDataGetBytePtr(copy_data)
+            buf_len = core.CFDataGetLength(copy_data)
             raw = ctypes.cast(
                 data_ref, ctypes.POINTER(ctypes.c_ubyte * buf_len))
             data = bytearray(raw.contents)
 
             # Remove padding per row
-            bytes_per_row = int(self.core.CGImageGetBytesPerRow(image_ref))
-            bytes_per_pixel = int(self.core.CGImageGetBitsPerPixel(image_ref))
+            bytes_per_row = int(core.CGImageGetBytesPerRow(image_ref))
+            bytes_per_pixel = int(core.CGImageGetBitsPerPixel(image_ref))
             bytes_per_pixel = (bytes_per_pixel + 7) // 8
 
             if bytes_per_pixel * width != bytes_per_row:
@@ -221,8 +222,8 @@ def grab(self, monitor):
                 data = cropped
         finally:
             if prov:
-                self.core.CGDataProviderRelease(prov)
+                core.CGDataProviderRelease(prov)
             if copy_data:
-                self.core.CFRelease(copy_data)
+                core.CFRelease(copy_data)
 
         return self.cls_image(data, monitor, size=Size(width, height))

mss/linux.py

@@ -165,6 +165,10 @@ def __init__(self, display=None):
         self.root = self.xlib.XDefaultRootWindow(
             self.display, self.xlib.XDefaultScreen(self.display))
 
+        # Fix for XRRGetScreenResources and XGetImage:
+        #     expected LP_Display instance instead of LP_XWindowAttributes
+        self.drawable = ctypes.cast(self.root, ctypes.POINTER(Display))
+
     def _set_argtypes(self):
         # type: () -> None
         """ Functions arguments. """
@@ -251,10 +255,8 @@ def monitors(self):
             })
 
             # Each monitors
-            # Fix for XRRGetScreenResources:
-            #     expected LP_Display instance instead of LP_XWindowAttributes
-            root = ctypes.cast(self.root, ctypes.POINTER(Display))
-            mon = self.xrandr.XRRGetScreenResources(self.display, root)
+            mon = self.xrandr.XRRGetScreenResources(self.display,
+                                                    self.drawable)
             for idx in range(mon.contents.ncrtc):
                 crtc = self.xrandr.XRRGetCrtcInfo(self.display, mon,
                                                   mon.contents.crtcs[idx])
@@ -286,11 +288,7 @@ def grab(self, monitor):
                 'height': monitor[3] - monitor[1],
             }
 
-        # Fix for XGetImage:
-        #     expected LP_Display instance instead of LP_XWindowAttributes
-        root = ctypes.cast(self.root, ctypes.POINTER(Display))
-
-        ximage = self.xlib.XGetImage(self.display, root,
+        ximage = self.xlib.XGetImage(self.display, self.drawable,
                                      monitor['left'], monitor['top'],
                                      monitor['width'], monitor['height'],
                                      PLAINMASK, ZPIXMAP)
@@ -308,6 +306,5 @@ def grab(self, monitor):
 
         # Free
         self.xlib.XDestroyImage(ximage)
-        ximage = None
 
         return self.cls_image(data, monitor)

mss/screenshot.py

@@ -116,8 +116,10 @@ def rgb(self):
 
         if not self.__rgb:
             rgb = bytearray(self.height * self.width * 3)
-            rgb[0::3], rgb[1::3], rgb[2::3] = \
-                self.raw[2::4], self.raw[1::4], self.raw[0::4]
+            raw = self.raw
+            rgb[0::3] = raw[2::4]
+            rgb[1::3] = raw[1::4]
+            rgb[2::3] = raw[0::4]
             self.__rgb = bytes(rgb)
 
         return self.__rgb