Skip to content

Commit

Permalink
Improve README a bit and add CHANGELOG for #27
Browse files Browse the repository at this point in the history
  • Loading branch information
nicoddemus committed Jan 27, 2016
1 parent 773f8d9 commit 7f4ce75
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 7 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
0.10.dev
--------

* ``pytest-mock`` now monkeypatches the ``mock`` library to improve pytest output
for failures of mock call assertions like ``Mock.assert_called_with()``.
Thanks to `@Chronial`_ for idea and PR (`#26`_, `#27`_)!

.. _@Chronial: https://github.com/Chronial
.. _#26: https://github.com/pytest-dev/pytest-qt/issues/26
.. _#27: https://github.com/pytest-dev/pytest-qt/issues/27

0.9.0
-----

Expand Down
24 changes: 17 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,23 @@ The stub is a mock object that accepts any arguments and is useful to test callb
foo(stub)
stub.assert_called_once_with('foo', 'bar')
Improved reporting of mock call assertion errors
------------------------------------------------

*New in version 0.10*

This plugin monkeypatches the mock library to improve pytest output for failures
of mock call assertions like ``Mock.assert_called_with()``. This is probably
safe, but if you encounter any problems this feature can be disabled in
your ``pytest.ini`` file:

.. code-block:: ini
[pytest]
mock_traceback_monkeypatch = false
Note
----

Expand All @@ -143,13 +160,6 @@ module and the plugin were required within a test.
The old fixture ``mock`` still works, but its use is discouraged and will be
removed in version ``1.0``.

Improved reporting of mock call assertion errors
------------------------------------------------

This plugin monkeypatches the mock library to improve pytest output for failures
of mock call assertions like ``Mock.assert_called_with()``. This can be disabled
by setting ``mock_traceback_monkeypatch = false`` in the ini.


Requirements
============
Expand Down

0 comments on commit 7f4ce75

Please sign in to comment.