Doc: Python 3.7 ready, add pre-commit hooks

Author: BoboTiG

.github/PULL_REQUEST_TEMPLATE.md

@@ -12,5 +12,4 @@ It is **very** important to keep up to date tests and documentation.
 Is your code right?
 
 - [ ] PEP8 compliant
-- [ ] `flake8` passed (bonus)
-- [ ] `pylint` passed (bonus)
+- [ ] `flake8` passed

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+fail_fast: true
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: master
+    hooks:
+    - id: trailing-whitespace
+    - id: flake8
+    - id: end-of-file-fixer
+    - id: check-docstring-first
+    - id: debug-statements
+    - id: check-ast
+    - id: no-commit-to-branch
+-   repo: https://github.com/ambv/black
+    rev: stable
+    hooks:
+    - id: black
+      language_version: python3.6

.travis.yml

@@ -3,7 +3,8 @@ python:
   - 2.7
   - 3.5
   - 3.6
-  - nightly # currently points to 3.7-dev
+  - 3.7-dev
+  - nightly # currently points to 3.8-dev
 
 addons:
   apt:
@@ -18,13 +19,12 @@ env:
   - DISPLAY=":42"
 
 install:
-  - pip install flake8 numpy pillow pylint sphinx
-  - pip install -e .
+  - python -m pip install flake8 numpy pillow sphinx
+  - python -m pip install -e .
 
 script:
-  - py.test --showlocals --display=":42.0"
-  - flake8 .
-  - if [[ $TRAVIS_PYTHON_VERSION < '3.7' ]]; then pylint mss; fi
+  - python -m pytest --display=":42.0" tests
+  - python -m flake8 .
   - if [[ $TRAVIS_PYTHON_VERSION > '2.8' ]]; then cd docs && make clean html; fi
 
 after_script:

docs/source/api.rst

@@ -50,30 +50,30 @@ Methods
 
     The parent's class for every OS implementation.
 
-    .. method:: grab(monitor)
+    .. method:: grab(region)
 
-        :param dict monitor: monitor's information.
+        :param dict monitor: region's coordinates.
         :rtype: :class:`ScreenShot`
         :raises NotImplementedError: Subclasses need to implement this.
 
-        Retrieve screen pixels for a given monitor.
+        Retrieve screen pixels for a given *region*.
 
         .. note::
 
-            ``monitor`` can be a ``tuple`` like ``PIL.Image.grab()`` accepts,
+            *monitor* can be a ``tuple`` like ``PIL.Image.grab()`` accepts,
             it will be converted to the appropriate ``dict``.
 
     .. method:: save([mon=1], [output='mon-{mon}.png'], [callback=None])
 
         :param int mon: the monitor's number.
         :param str output: the output's file name.
         :type callback: callable or None
-        :param callback: callback called before saving the screen shot to a file. Takes the ``output`` argument as parameter.
+        :param callback: callback called before saving the screen shot to a file. Takes the *output* argument as parameter.
         :rtype: iterable
         :return: Created file(s).
 
         Grab a screen shot and save it to a file.
-        The ``output`` parameter can take several keywords to customize the filename:
+        The *output* parameter can take several keywords to customize the filename:
 
             - ``{mon}``: the monitor number
             - ``{top}``: the screen shot y-coordinate of the upper-left corner
@@ -130,17 +130,17 @@ Methods
     :param tuple size: The (width, height) pair.
     :param int level: PNG compression level.
     :param str output: output's file name.
-    :raises ScreenShotError: On error when writing ``data`` to ``output``.
-    :raises zlib.error: On bad compression ``level``.
+    :raises ScreenShotError: On error when writing *data* to *output*.
+    :raises zlib.error: On bad compression *level*.
 
     Dump data to the image file. Pure Python PNG implementation.
-    If ``output`` is ``None``, create no file but return the whole PNG data.
+    If *output* is ``None``, create no file but return the whole PNG data.
 
     .. versionadded:: 3.0.0
 
     .. versionadded:: 3.2.0
 
-        Added the ``level`` keyword argument to control the PNG compression level.
+        The *level* keyword argument to control the PNG compression level.
 
 
 Properties
@@ -250,11 +250,11 @@ Exception
         On GNU/Linux, and if the error comes from the XServer, it contains XError details.
         This is an empty dict by default.
 
-        For Xerrors, you can find information on `Using the Default Error Handlers <https://tronche.com/gui/x/xlib/event-handling/protocol-errors/default-handlers.html>`_.
+        For XErrors, you can find information on `Using the Default Error Handlers <https://tronche.com/gui/x/xlib/event-handling/protocol-errors/default-handlers.html>`_.
 
         :rtype: dict[str, Any]
 
-        .. versionchanged:: 3.3.0
+        .. versionadded:: 3.3.0
 
 
 Factory

docs/source/developers.rst

@@ -11,6 +11,11 @@ Setup
 2. Create you own branch.
 3. Be sure to add/update tests and documentation within your patch.
 
+Additionnally, you can install `pre-commit <http://pre-commit.com/>`_ to ensure you are doing things well::
+
+    $ python -m pip install --upgrade --user pre-commit
+    $ pre-commit install
+
 
 Testing
 =======
@@ -20,7 +25,7 @@ Dependency
 
 You will need `pytest <https://pypi.python.org/pypi/pytest>`_::
 
-    $ pip install pytest
+    $ python -m pip install --upgrade --user pytest
 
 
 How to Test?
@@ -32,7 +37,7 @@ Enable the developer mode::
 
 Launch the test suit::
 
-    $ py.test
+    $ python -m pytest tests
 
 .. Note::
 
@@ -42,24 +47,23 @@ Launch the test suit::
 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>`_.
+It is important to keep a clean base code. Use tools like `flake8 <https://pypi.python.org/pypi/flake8>`_.
 
 
 Dependencies
 ------------
 
 Install required packages::
 
-    $ pip install flake8 pylint
+    $ python -m pip install --upgrade --user flake8
 
 
 How to Validate?
 ----------------
 
 ::
 
-    $ flake8
-    $ pylint mss
+    $ python -m flake8 .
 
 If there is no output, you are good ;)
 
@@ -76,7 +80,7 @@ Dependencies
 
 Install required packages::
 
-    $ pip install mypy-lang
+    $ python -m pip install --upgrade --user mypy-lang
 
 
 Running Mypy
@@ -95,7 +99,7 @@ Dependencies
 
 You will need `Sphinx <http://sphinx-doc.org/>`_::
 
-    $ pip install sphinx
+    $ python -m pip install --upgrade --user sphinx
 
 
 How to Build?

docs/source/examples/opencv_numpy.py

@@ -30,7 +30,7 @@
         # cv2.imshow('OpenCV/Numpy grayscale',
         #            cv2.cvtColor(img, cv2.COLOR_BGRA2GRAY))
 
-        print('fps: {0}'.format(1 / (time.time()-last_time)))
+        print('fps: {0}'.format(1 / (time.time() - last_time)))
 
         # Press "q" to quit
         if cv2.waitKey(25) & 0xFF == ord('q'):

docs/source/installation.rst

@@ -9,7 +9,7 @@ Recommended Way
 
 Quite simple::
 
-    $ pip install --upgrade mss
+    $ python -m pip install --upgrade --user mss
 
 
 From Sources
@@ -23,4 +23,4 @@ Alternatively, you can get a copy of the module from GitHub::
 
 And then::
 
-    $ sudo python setup.py install
+    $ python setup.py install --user

setup.cfg

@@ -0,0 +1,19 @@
+[bdist_wheel]
+universal = 1
+
+[flake8]
+ignore =
+    # E203 whitespace before ':', but E203 is not PEP 8 compliant
+    E203
+    # W503 line break before binary operator, but W503 is not PEP 8 compliant
+    W503
+max-line-length = 120
+
+[tool:pytest]
+addopts =
+    --showlocals
+    --strict
+    --failed-first
+    --no-print-logs
+    -r fE
+    -v

setup.py

@@ -6,54 +6,57 @@
 
 
 classifiers = [
-    'Development Status :: 5 - Production/Stable',
-    'Environment :: MacOS X',
-    'Environment :: Win32 (MS Windows)',
-    'Environment :: X11 Applications',
-    'Intended Audience :: Customer Service',
-    'Intended Audience :: Developers',
-    'Intended Audience :: Information Technology',
-    'Intended Audience :: Education',
-    'Intended Audience :: End Users/Desktop',
-    'Intended Audience :: Financial and Insurance Industry',
-    'Intended Audience :: Healthcare Industry',
-    'Intended Audience :: Other Audience',
-    'Intended Audience :: Science/Research',
-    'Intended Audience :: System Administrators',
-    'Intended Audience :: Telecommunications Industry',
-    'License :: OSI Approved :: MIT License',
-    'Natural Language :: English',
-    'Operating System :: MacOS',
-    'Operating System :: MacOS :: MacOS X',
-    'Operating System :: Microsoft',
-    'Operating System :: Microsoft :: Windows',
-    'Operating System :: OS Independent',
-    'Operating System :: POSIX :: Linux',
-    'Programming Language :: Python',
-    'Programming Language :: Python :: 2',
-    'Programming Language :: Python :: 2.7',
-    'Programming Language :: Python :: 3',
-    'Programming Language :: Python :: 3.4',
-    'Programming Language :: Python :: 3.5',
-    'Programming Language :: Python :: 3.6',
-    'Topic :: Multimedia :: Graphics :: Capture :: Screen Capture'
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: MacOS X",
+    "Environment :: Win32 (MS Windows)",
+    "Environment :: X11 Applications",
+    "Intended Audience :: Customer Service",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: Education",
+    "Intended Audience :: End Users/Desktop",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Intended Audience :: Healthcare Industry",
+    "Intended Audience :: Other Audience",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: System Administrators",
+    "Intended Audience :: Telecommunications Industry",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: MacOS",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 2",
+    "Programming Language :: Python :: 2.7",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.4",
+    "Programming Language :: Python :: 3.5",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Topic :: Multimedia :: Graphics :: Capture :: Screen Capture",
 ]
 config = {
-    'name': 'mss',
-    'version': __version__,
-    'author': 'Tiger-222',
-    'author_email': 'contact@tiger-222.fr',
-    'maintainer': 'Tiger-222',
-    'maintainer_email': 'contact@tiger-222.fr',
-    'url': 'https://github.com/BoboTiG/python-mss',
-    'description': ('An ultra fast cross-platform multiple screenshots module '
-                    'in pure python using ctypes.'),
-    'long_description': open('README.rst').read(),
-    'classifiers': classifiers,
-    'platforms': ['Darwin', 'Linux', 'Windows'],
-    'packages': ['mss'],
-    'entry_points': {'console_scripts': ['mss=mss.__main__:main']},
-    'license': 'MIT',
+    "name": "mss",
+    "version": __version__,
+    "author": "Tiger-222",
+    "author_email": "contact@tiger-222.fr",
+    "maintainer": "Tiger-222",
+    "maintainer_email": "contact@tiger-222.fr",
+    "url": "https://github.com/BoboTiG/python-mss",
+    "description": (
+        "An ultra fast cross-platform multiple screenshots module "
+        "in pure python using ctypes."
+    ),
+    "long_description": open("README.rst").read(),
+    "classifiers": classifiers,
+    "platforms": ["Darwin", "Linux", "Windows"],
+    "packages": ["mss"],
+    "entry_points": {"console_scripts": ["mss=mss.__main__:main"]},
+    "license": "MIT",
 }
 
 setup(**config)

tests/test_gnu_linux.py

@@ -41,11 +41,7 @@ def test_factory_systems(monkeypatch):
     with pytest.raises(ScreenShotError) as exc:
         mss.mss()
     monkeypatch.undo()
-    if not PY3:
-        error = exc.value[1]['self']
-    else:
-        error = exc.value.args[1]['self']
-    assert isinstance(error, MSSBase)
+    assert isinstance(exc.value.details['self'], MSSBase)
 
     # Windows
     monkeypatch.setattr(platform, 'system', lambda: 'wInDoWs')
@@ -88,20 +84,20 @@ def find_lib(lib):
         It is a naive approach, but works for now.
         """
 
-        if lib == "Xrandr":
+        if lib == 'Xrandr':
             return None
         return x11
 
     # No `Xrandr` library
-    monkeypatch.setattr(ctypes.util, "find_library", find_lib)
+    monkeypatch.setattr(ctypes.util, 'find_library', find_lib)
     with pytest.raises(ScreenShotError):
         mss.mss()
     monkeypatch.undo()
 
     # Bad display data
     import mss.linux
 
-    monkeypatch.setattr(mss.linux, "Display", lambda: None)
+    monkeypatch.setattr(mss.linux, 'Display', lambda: None)
     with pytest.raises(TypeError):
         mss.mss()