Merge pull request #127 from nicoddemus/black-pre-commit

Use pre-commit and black

Author: nicoddemus

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+exclude: '^($|.*\.bin)'
+repos:
+  - repo: https://github.com/ambv/black
+    rev: 18.6b4
+    hooks:
+      - id: black
+        args: [--safe, --quiet]
+        language_version: python3.6
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v1.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: local
+    hooks:
+      - id: rst
+        name: rst
+        entry: rst-lint --encoding utf-8
+        files: ^(CHANGELOG.rst|README.rst|HOWTORELEASE.rst|changelog/.*)$
+        language: python
+        additional_dependencies: [pygments, restructuredtext_lint]
+        python_version: python3.6

CHANGELOG.rst

@@ -331,5 +331,3 @@ First release.
 .. _@rouge8: https://github.com/rouge8
 .. _@The-Compiler: https://github.com/The-Compiler
 .. _@tigarmo: https://github.com/tigarmo
-
-

HOWTORELEASE.rst

@@ -0,0 +1,7 @@
+Here are the steps on how to make a new release.
+
+1. Create a ``release-VERSION`` branch from ``upstream/master``.
+2. Update ``CHANGELOG.rst``.
+3. Push a branch with the changes.
+4. Once all builds pass, push a tag to ``upstream``.
+5. Merge the PR.

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.rst

@@ -10,22 +10,21 @@ of a test:
 .. code-block:: python
 
     import os
-    
+
     class UnixFS:
-    
+
         @staticmethod
         def rm(filename):
             os.remove(filename)
-    
+
     def test_unix_fs(mocker):
         mocker.patch('os.remove')
         UnixFS.rm('file')
         os.remove.assert_called_once_with('file')
 
 
-.. Using PNG badges because PyPI doesn't support SVG
 
-|python| |version| |anaconda| |ci| |appveyor| |coverage|
+|python| |version| |anaconda| |ci| |appveyor| |coverage| |black|
 
 .. |version| image:: http://img.shields.io/pypi/v/pytest-mock.svg
   :target: https://pypi.python.org/pypi/pytest-mock
@@ -44,13 +43,16 @@ of a test:
 
 .. |python| image:: https://img.shields.io/pypi/pyversions/pytest-mock.svg
   :target: https://pypi.python.org/pypi/pytest-mock/
-  
-  
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+  :target: https://github.com/ambv/black
+
+
 .. image:: http://www.opensourcecitizen.org/badge?url=github.com/pytest-dev/pytest-mock
   :target: http://www.opensourcecitizen.org/project?url=github.com/pytest-dev/pytest-mock
 
 If you found this library useful, donate some CPU cycles to its
-development efforts by clicking above. Thank you! 😇  
+development efforts by clicking above. Thank you! 😇
 
 Usage
 =====
@@ -160,8 +162,8 @@ diff::
     E         Right contains more items:
     E         {'bar': 4}
     E         Use -v to get the full diff
-    
-    
+
+
     test_foo.py:6: AssertionError
     ========================== 1 failed in 0.03 seconds ===========================
 
@@ -322,6 +324,26 @@ temporarily:
         return my_cm
 
 
+Contributing
+============
+
+Contributions are welcome! After cloning the repository, create a virtual env
+and install ``pytest-mock`` in editable mode with ``dev`` extras:
+
+.. code-block:: console
+
+    $ pip install --editable .[dev]
+    $ pre-commit install
+
+Tests are run with ``tox``, you can run the baseline environments before submitting a PR:
+
+.. code-block:: console
+
+    $ tox -e py27,py36,linting
+
+Style checks and formatting are done automatically during commit courtesy of
+`pre-commit <https://pre-commit.com>`_.
+
 License
 =======
 

pytest_mock.py

@@ -22,13 +22,17 @@ def _get_mock_module(config):
     "unittest.mock" for Python 3, but the user can force to always use "mock" on Python 3 using
     the mock_use_standalone_module ini option.
     """
-    if not hasattr(_get_mock_module, '_module'):
-        use_standalone_module = parse_ini_boolean(config.getini('mock_use_standalone_module'))
+    if not hasattr(_get_mock_module, "_module"):
+        use_standalone_module = parse_ini_boolean(
+            config.getini("mock_use_standalone_module")
+        )
         if sys.version_info[0] == 2 or use_standalone_module:
             import mock
+
             _get_mock_module._module = mock
         else:
             import unittest.mock
+
             _get_mock_module._module = unittest.mock
 
     return _get_mock_module._module
@@ -100,8 +104,7 @@ def spy(self, obj, name):
                 if isinstance(value, (classmethod, staticmethod)):
                     autospec = False
 
-        result = self.patch.object(obj, name, side_effect=method,
-                                   autospec=autospec)
+        result = self.patch.object(obj, name, side_effect=method, autospec=autospec)
         return result
 
     def stub(self, name=None):
@@ -134,7 +137,7 @@ def _start_patch(self, mock_func, *args, **kwargs):
             p = mock_func(*args, **kwargs)
             mocked = p.start()
             self._patches.append(p)
-            if hasattr(mocked, 'reset_mock'):
+            if hasattr(mocked, "reset_mock"):
                 self._mocks.append(mocked)
             return mocked
 
@@ -144,8 +147,7 @@ def object(self, *args, **kwargs):
 
         def multiple(self, *args, **kwargs):
             """API to mock.patch.multiple"""
-            return self._start_patch(self.mock_module.patch.multiple, *args,
-                                     **kwargs)
+            return self._start_patch(self.mock_module.patch.multiple, *args, **kwargs)
 
         def dict(self, *args, **kwargs):
             """API to mock.patch.dict"""
@@ -173,8 +175,10 @@ def mock(mocker):
     Same as "mocker", but kept only for backward compatibility.
     """
     import warnings
-    warnings.warn('"mock" fixture has been deprecated, use "mocker" instead',
-                  DeprecationWarning)
+
+    warnings.warn(
+        '"mock" fixture has been deprecated, use "mocker" instead', DeprecationWarning
+    )
     return mocker
 
 
@@ -188,67 +192,60 @@ def assert_wrapper(__wrapped_mock_method__, *args, **kwargs):
         __wrapped_mock_method__(*args, **kwargs)
         return
     except AssertionError as e:
-        if getattr(e, '_mock_introspection_applied', 0):
+        if getattr(e, "_mock_introspection_applied", 0):
             msg = text_type(e)
         else:
             __mock_self = args[0]
             msg = text_type(e)
             if __mock_self.call_args is not None:
                 actual_args, actual_kwargs = __mock_self.call_args
-                msg += '\n\npytest introspection follows:\n'
+                msg += "\n\npytest introspection follows:\n"
                 try:
                     assert actual_args == args[1:]
                 except AssertionError as e:
-                    msg += '\nArgs:\n' + text_type(e)
+                    msg += "\nArgs:\n" + text_type(e)
                 try:
                     assert actual_kwargs == kwargs
                 except AssertionError as e:
-                    msg += '\nKwargs:\n' + text_type(e)
+                    msg += "\nKwargs:\n" + text_type(e)
     e = AssertionError(msg)
     e._mock_introspection_applied = True
     raise e
 
 
 def wrap_assert_not_called(*args, **kwargs):
     __tracebackhide__ = True
-    assert_wrapper(_mock_module_originals["assert_not_called"],
-                   *args, **kwargs)
+    assert_wrapper(_mock_module_originals["assert_not_called"], *args, **kwargs)
 
 
 def wrap_assert_called_with(*args, **kwargs):
     __tracebackhide__ = True
-    assert_wrapper(_mock_module_originals["assert_called_with"],
-                   *args, **kwargs)
+    assert_wrapper(_mock_module_originals["assert_called_with"], *args, **kwargs)
 
 
 def wrap_assert_called_once(*args, **kwargs):
     __tracebackhide__ = True
-    assert_wrapper(_mock_module_originals["assert_called_once"],
-                   *args, **kwargs)
+    assert_wrapper(_mock_module_originals["assert_called_once"], *args, **kwargs)
 
 
 def wrap_assert_called_once_with(*args, **kwargs):
     __tracebackhide__ = True
-    assert_wrapper(_mock_module_originals["assert_called_once_with"],
-                   *args, **kwargs)
+    assert_wrapper(_mock_module_originals["assert_called_once_with"], *args, **kwargs)
 
 
 def wrap_assert_has_calls(*args, **kwargs):
     __tracebackhide__ = True
-    assert_wrapper(_mock_module_originals["assert_has_calls"],
-                   *args, **kwargs)
+    assert_wrapper(_mock_module_originals["assert_has_calls"], *args, **kwargs)
 
 
 def wrap_assert_any_call(*args, **kwargs):
     __tracebackhide__ = True
-    assert_wrapper(_mock_module_originals["assert_any_call"],
-                   *args, **kwargs)
+    assert_wrapper(_mock_module_originals["assert_any_call"], *args, **kwargs)
 
 
 def wrap_assert_called(*args, **kwargs):
     __tracebackhide__ = True
-    assert_wrapper(_mock_module_originals["assert_called"],
-                   *args, **kwargs)
+    assert_wrapper(_mock_module_originals["assert_called"], *args, **kwargs)
 
 
 def wrap_assert_methods(config):
@@ -263,26 +260,25 @@ def wrap_assert_methods(config):
     mock_module = _get_mock_module(config)
 
     wrappers = {
-        'assert_called': wrap_assert_called,
-        'assert_called_once': wrap_assert_called_once,
-        'assert_called_with': wrap_assert_called_with,
-        'assert_called_once_with': wrap_assert_called_once_with,
-        'assert_any_call': wrap_assert_any_call,
-        'assert_has_calls': wrap_assert_has_calls,
-        'assert_not_called': wrap_assert_not_called,
+        "assert_called": wrap_assert_called,
+        "assert_called_once": wrap_assert_called_once,
+        "assert_called_with": wrap_assert_called_with,
+        "assert_called_once_with": wrap_assert_called_once_with,
+        "assert_any_call": wrap_assert_any_call,
+        "assert_has_calls": wrap_assert_has_calls,
+        "assert_not_called": wrap_assert_not_called,
     }
     for method, wrapper in wrappers.items():
         try:
             original = getattr(mock_module.NonCallableMock, method)
         except AttributeError:  # pragma: no cover
             continue
         _mock_module_originals[method] = original
-        patcher = mock_module.patch.object(
-            mock_module.NonCallableMock, method, wrapper)
+        patcher = mock_module.patch.object(mock_module.NonCallableMock, method, wrapper)
         patcher.start()
         _mock_module_patches.append(patcher)
 
-    if hasattr(config, 'add_cleanup'):
+    if hasattr(config, "add_cleanup"):
         add_cleanup = config.add_cleanup
     else:
         # pytest 2.7 compatibility
@@ -298,26 +294,33 @@ def unwrap_assert_methods():
 
 
 def pytest_addoption(parser):
-    parser.addini('mock_traceback_monkeypatch',
-                  'Monkeypatch the mock library to improve reporting of the '
-                  'assert_called_... methods',
-                  default=True)
-    parser.addini('mock_use_standalone_module',
-                  'Use standalone "mock" (from PyPI) instead of builtin "unittest.mock" '
-                  'on Python 3',
-                  default=False)
+    parser.addini(
+        "mock_traceback_monkeypatch",
+        "Monkeypatch the mock library to improve reporting of the "
+        "assert_called_... methods",
+        default=True,
+    )
+    parser.addini(
+        "mock_use_standalone_module",
+        'Use standalone "mock" (from PyPI) instead of builtin "unittest.mock" '
+        "on Python 3",
+        default=False,
+    )
 
 
 def parse_ini_boolean(value):
     if value in (True, False):
         return value
     try:
-        return {'true': True, 'false': False}[value.lower()]
+        return {"true": True, "false": False}[value.lower()]
     except KeyError:
-        raise ValueError('unknown string for bool: %r' % value)
+        raise ValueError("unknown string for bool: %r" % value)
 
 
 def pytest_configure(config):
-    tb = config.getoption('--tb')
-    if parse_ini_boolean(config.getini('mock_traceback_monkeypatch')) and tb != 'native':
+    tb = config.getoption("--tb")
+    if (
+        parse_ini_boolean(config.getini("mock_traceback_monkeypatch"))
+        and tb != "native"
+    ):
         wrap_assert_methods(config)