MSS: polish the Python 2.7 removal

BoboTiG · BoboTiG · commit 14d2214936ae · 2019-02-19T10:57:24.000+01:00
Also fix types annotation of factory.mss().
diff --git a/README.rst b/README.rst
@@ -13,15 +13,14 @@ Python MSS
 
     from mss import mss
 
-
     # The simplest use, save a screen shot of the 1st monitor
     with mss() as sct:
         sct.shot()
 
 
 An ultra fast cross-platform multiple screenshots module in pure python using ctypes.
 
-- **Python 2 & 3** and PEP8 compliant, no dependency;
+- **Python 3.5+** and PEP8 compliant, no dependency;
 - very basic, it will grab one screen shot by monitor or a screen shot of all monitors and save it to a PNG file;
 - but you can use PIL and benefit from all its formats (or add yours directly);
 - integrate well with Numpy and OpenCV;
@@ -39,4 +38,4 @@ Installation
 
 You can install it with pip::
 
-    python -m pip install --upgrade mss
+    python -m pip install -U --user mss
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,5 +1,3 @@
-# coding: utf-8
-
 # -- General configuration ------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
diff --git a/docs/source/developers.rst b/docs/source/developers.rst
@@ -13,7 +13,7 @@ Setup
 
 Additionally, you can install `pre-commit <http://pre-commit.com/>`_ to ensure you are doing things well::
 
-    $ python -m pip install --upgrade --user pre-commit
+    $ python -m pip install -U --user pre-commit
     $ pre-commit install
 
 
@@ -25,7 +25,7 @@ Dependency
 
 You will need `tox <https://pypi.org/project/tox/>`_::
 
-    $ python -m pip install --upgrade --user tox
+    $ python -m pip install -U --user tox
 
 
 How to Test?
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -32,7 +32,7 @@ Callback
 Screen shot of the monitor 1 with a callback:
 
 .. literalinclude:: examples/callback.py
-    :lines: 9-
+    :lines: 8-
 
 
 Part of the screen
@@ -41,7 +41,7 @@ Part of the screen
 You can capture only a part of the screen:
 
 .. literalinclude:: examples/part_of_screen.py
-    :lines: 9-
+    :lines: 8-
 
 .. versionadded:: 3.0.0
 
@@ -52,7 +52,7 @@ Part of the screen of the 2nd monitor
 This is an example of capturing some part of the screen of the monitor 2:
 
 .. literalinclude:: examples/part_of_screen_monitor_2.py
-    :lines: 9-
+    :lines: 8-
 
 .. versionadded:: 3.0.0
 
@@ -64,7 +64,7 @@ You can use the same value as you would do with ``PIL.ImageGrab(bbox=tuple(...))
 This is an example that uses it, but also using percentage values:
 
 .. literalinclude:: examples/from_pil_tuple.py
-    :lines: 9-
+    :lines: 8-
 
 .. versionadded:: 3.1.0
 
@@ -83,7 +83,7 @@ Advanced
 You can handle data using a custom class:
 
 .. literalinclude:: examples/custom_cls_image.py
-    :lines: 9-
+    :lines: 8-
 
 .. versionadded:: 3.1.0
 
@@ -94,7 +94,7 @@ You can use the Python Image Library (aka Pillow) to do whatever you want with r
 This is an example using `frombytes() <http://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.frombytes>`_:
 
 .. literalinclude:: examples/pil.py
-    :lines: 9-
+    :lines: 8-
 
 .. versionadded:: 3.0.0
 
@@ -104,7 +104,7 @@ Playing with pixels
 This is an example using `putdata() <https://github.com/python-pillow/Pillow/blob/b9b5d39f2b32cec75b9cf96b882acb7a77a4ed4b/PIL/Image.py#L1523>`_:
 
 .. literalinclude:: examples/pil_pixels.py
-    :lines: 9-
+    :lines: 8-
 
 .. versionadded:: 3.0.0
 
@@ -116,7 +116,7 @@ You can easily view a HD movie with VLC and see it too in the OpenCV window.
 And with __no__ lag please.
 
 .. literalinclude:: examples/opencv_numpy.py
-    :lines: 9-
+    :lines: 8-
 
 .. versionadded:: 3.0.0
 
diff --git a/docs/source/examples/callback.py b/docs/source/examples/callback.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/docs/source/examples/custom_cls_image.py b/docs/source/examples/custom_cls_image.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
@@ -22,6 +21,6 @@ def __init__(self, data, monitor, **kwargs):
 
 
 with mss.mss() as sct:
-    sct.cls_image = SimpleScreenShot
+    sct.cls_image = SimpleScreenShot  # type: ignore
     image = sct.grab(sct.monitors[1])
     # ...
diff --git a/docs/source/examples/fps.py b/docs/source/examples/fps.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
@@ -7,8 +6,6 @@
     https://pythonprogramming.net/game-frames-open-cv-python-plays-gta-v/
 """
 
-from __future__ import print_function
-
 import time
 
 import cv2
diff --git a/docs/source/examples/from_pil_tuple.py b/docs/source/examples/from_pil_tuple.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
@@ -24,7 +23,7 @@
     # Grab the picture
     # Using PIL would be something like:
     # im = ImageGrab(bbox=bbox)
-    im = sct.grab(bbox)
+    im = sct.grab(bbox)  # type: ignore
 
     # Save it!
     mss.tools.to_png(im.rgb, im.size, output="screenshot.png")
diff --git a/docs/source/examples/linux_display_keyword.py b/docs/source/examples/linux_display_keyword.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/docs/source/examples/opencv_numpy.py b/docs/source/examples/opencv_numpy.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/docs/source/examples/part_of_screen.py b/docs/source/examples/part_of_screen.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/docs/source/examples/part_of_screen_monitor_2.py b/docs/source/examples/part_of_screen_monitor_2.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/docs/source/examples/pil.py b/docs/source/examples/pil.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/docs/source/examples/pil_pixels.py b/docs/source/examples/pil_pixels.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,15 +5,14 @@ Welcome to Python MSS's documentation!
 
     from mss import mss
 
-
     # The simplest use, save a screen shot of the 1st monitor
     with mss() as sct:
         sct.shot()
 
 
 An ultra fast cross-platform multiple screenshots module in pure python using ctypes.
 
-    - **Python 2 & 3** and :pep:`8` compliant, no dependency;
+    - **Python 3.5+** and :pep:`8` compliant, no dependency;
     - very basic, it will grab one screen shot by monitor or a screen shot of all monitors and save it to a PNG file;
     - but you can use PIL and benefit from all its formats (or add yours directly);
     - integrate well with Numpy and OpenCV;
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -9,7 +9,7 @@ Recommended Way
 
 Quite simple::
 
-    $ python -m pip install --upgrade --user mss
+    $ python -m pip install -U --user mss
 
 
 From Sources
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -81,7 +81,7 @@ On GNU/Linux, you can specify which display to use (useful for distant screensho
 A more specific example to only target GNU/Linux:
 
 .. literalinclude:: examples/linux_display_keyword.py
-    :lines: 9-
+    :lines: 8-
 
 
 Command Line
diff --git a/mss/__init__.py b/mss/__init__.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 An ultra fast cross-platform multiple screenshots module in pure python
 using ctypes.
diff --git a/mss/__main__.py b/mss/__main__.py
@@ -1,11 +1,8 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
 """
 
-from __future__ import print_function
-
 import os.path
 import sys
 from argparse import ArgumentParser
diff --git a/mss/base.py b/mss/base.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/mss/darwin.py b/mss/darwin.py
@@ -1,13 +1,8 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
 """
 
-# pylint: disable=import-error, too-many-locals
-
-from __future__ import division
-
 import ctypes
 import ctypes.util
 import sys
@@ -177,6 +172,8 @@ def grab(self, monitor):
         See :meth:`MSSMixin.grab <mss.base.MSSMixin.grab>` for full details.
         """
 
+        # pylint: disable=too-many-locals
+
         # Convert PIL bbox style
         if isinstance(monitor, tuple):
             monitor = {
diff --git a/mss/exception.py b/mss/exception.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/mss/factory.py b/mss/factory.py
@@ -1,15 +1,22 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
 """
 
 import platform
+from typing import TYPE_CHECKING
 
 from .exception import ScreenShotError
 
 
+if TYPE_CHECKING:
+    from typing import Any  # noqa
+
+    from .base import MSSMixin  # noqa
+
+
 def mss(**kwargs):
+    # type: (Any) -> MSSMixin
     """ Factory returning a proper MSS class instance.
 
         It detects the plateform we are running on
@@ -20,18 +27,21 @@ def mss(**kwargs):
         instantiation.
     """
 
-    # pylint: disable=import-error
-
-    operating_system = platform.system().lower()
-    if operating_system == "darwin":
-        from .darwin import MSS  # type: ignore
-    elif operating_system == "linux":
-        from .linux import MSS  # type: ignore
-    elif operating_system == "windows":
-        from .windows import MSS  # type: ignore
-    else:
-        raise ScreenShotError(
-            "System {!r} not (yet?) implemented.".format(operating_system)
-        )
-
-    return MSS(**kwargs)
+    os_ = platform.system().lower()
+
+    if os_ == "darwin":
+        from . import darwin
+
+        return darwin.MSS(**kwargs)
+
+    if os_ == "linux":
+        from . import linux
+
+        return linux.MSS(**kwargs)
+
+    if os_ == "windows":
+        from . import windows
+
+        return windows.MSS(**kwargs)
+
+    raise ScreenShotError("System {!r} not (yet?) implemented.".format(os_))
diff --git a/mss/linux.py b/mss/linux.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/mss/models.py b/mss/models.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/mss/screenshot.py b/mss/screenshot.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/mss/tools.py b/mss/tools.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
diff --git a/mss/windows.py b/mss/windows.py
@@ -1,11 +1,8 @@
-# coding: utf-8
 """
 This is part of the MSS Python's module.
 Source: https://github.com/BoboTiG/python-mss
 """
 
-from __future__ import division
-
 import ctypes
 from ctypes.wintypes import (
     BOOL,
diff --git a/tests/bench_bgra2rgb.py b/tests/bench_bgra2rgb.py
@@ -1,5 +1,7 @@
-# coding: utf-8
 """
+This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss
+
 2018-03-19.
 
 Maximum screenshots in 1 second by computing BGRA raw values to RGB.
@@ -27,8 +29,6 @@
   numpy_slice       22
 """
 
-from __future__ import print_function
-
 import time
 
 from PIL import Image
diff --git a/tests/bench_general.py b/tests/bench_general.py
@@ -1,5 +1,7 @@
-# coding: utf-8
 """
+This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss
+
 2018-03-19.
 
 Original means MSS 3.1.2.
diff --git a/tests/conftest.py b/tests/conftest.py
diff --git a/tests/res/dummy.xorg.conf b/tests/res/dummy.xorg.conf
diff --git a/tests/test_bgra_to_rgb.py b/tests/test_bgra_to_rgb.py
diff --git a/tests/test_cls_image.py b/tests/test_cls_image.py
diff --git a/tests/test_find_monitors.py b/tests/test_find_monitors.py
diff --git a/tests/test_get_pixels.py b/tests/test_get_pixels.py
diff --git a/tests/test_gnu_linux.py b/tests/test_gnu_linux.py
diff --git a/tests/test_implementation.py b/tests/test_implementation.py
diff --git a/tests/test_leaks.py b/tests/test_leaks.py
diff --git a/tests/test_macos.py b/tests/test_macos.py
diff --git a/tests/test_save.py b/tests/test_save.py
diff --git a/tests/test_third_party.py b/tests/test_third_party.py
diff --git a/tests/test_tools.py b/tests/test_tools.py
diff --git a/tests/test_windows.py b/tests/test_windows.py

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-# coding: utf-8`
`2`		`-`
`3`	`1`	`# -- General configuration ------------------------------------------------`
`4`	`2`
`5`	`3`	`# Add any Sphinx extension module names here, as strings. They can be`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# coding: utf-8`
`2`	`1`	`"""`
`3`	`2`	`This is part of the MSS Python's module.`
`4`	`3`	`Source: https://github.com/BoboTiG/python-mss`