pytest-mock/CHANGELOG.rst
2019-08-24 18:33:04 +02:00

361 lines
11 KiB
ReStructuredText

1.10.4
------
* Fix plugin when 'terminal' plugin is disabled
1.10.3
------
* Fix test suite in Python 3.8. Thanks `@hroncok`_ for the report and `@blueyed`_ for the PR (`#140`_).
.. _#140: https://github.com/pytest-dev/pytest-mock/pull/140
.. _@hroncok: https://github.com/hroncok
1.10.2
------
* Fix bug at the end of the test session when a call to ``patch.stopall`` is done explicitly by
user code. Thanks `@craiga`_ for the report (`#137`_).
.. _#137: https://github.com/pytest-dev/pytest-mock/issues/137
.. _@craiga: https://github.com/craiga
1.10.1
------
* Fix broken links and update README. Also the code is now formatted using `black <https://github.com/ambv/black>`__.
1.10.0
------
* Add support for the recently added ``assert_called`` method in Python 3.6 and ``mock-2.0``. Thanks `@rouge8`_ for the PR (`#115`_).
.. _#115: https://github.com/pytest-dev/pytest-mock/pull/115
1.9.0
-----
* Add support for the recently added ``assert_called_once`` method in Python 3.6 and ``mock-2.0``. Thanks `@rouge8`_ for the PR (`#113`_).
.. _#113: https://github.com/pytest-dev/pytest-mock/pull/113
1.8.0
-----
* Add aliases for ``NonCallableMock`` and ``create_autospec`` to ``mocker``. Thanks `@mlhamel`_ for the PR (`#111`_).
.. _#111: https://github.com/pytest-dev/pytest-mock/pull/111
1.7.1
-----
* Fix ``setup.py`` to correctly read the ``README.rst``. Thanks `@ghisvail`_ for the fix (`#107`_).
.. _#107: https://github.com/pytest-dev/pytest-mock/issues/107
1.7.0
-----
**Incompatible change**
* ``pytest-mock`` no longer supports Python 2.6 and Python 3.3, following the lead of
``pytest`` and other projects in the community. Thanks `@hugovk`_ for the PR (`#96`_).
**Packaging**
* Fix ``mock`` requirement in Python 2. Thanks `@ghisvail`_ for the report (`#101`_).
**Internal**
* Some tests in ``pytest-mock``'s suite are skipped if assertion rewriting is disabled (`#102`_).
.. _@ghisvail: https://github.com/ghisvail
.. _@hugovk: https://github.com/hugovk
.. _#96: https://github.com/pytest-dev/pytest-mock/pull/96
.. _#101: https://github.com/pytest-dev/pytest-mock/issues/101
.. _#102: https://github.com/pytest-dev/pytest-mock/issues/102
1.6.3
-----
* Fix ``UnicodeDecodeError`` during assert introspection in ``assert_called_with`` in Python 2.
Thanks `@AndreasHogstrom`_ for the report (`#91`_).
.. _@AndreasHogstrom: https://github.com/AndreasHogstrom
.. _#91: https://github.com/pytest-dev/pytest-mock/issues/91
1.6.2
-----
* Provide source package in ``tar.gz`` format and remove obsolete ``MANIFEST.in``.
1.6.1
-----
* Fix ``mocker.resetall()`` by ignoring mocker objects which don't have a
``resetall`` method, like for example ``patch.dict``.
Thanks `@jdavisp3`_ for the PR (`#88`_).
.. _@jdavisp3: https://github.com/jdavisp3
.. _#88: https://github.com/pytest-dev/pytest-mock/pull/88
1.6.0
-----
* The original assertions raised by the various ``Mock.assert_*`` methods
now appear in the failure message, in addition to the message obtained from
pytest introspection.
Thanks `@quodlibetor`_ for the initial patch (`#79`_).
.. _@quodlibetor: https://github.com/quodlibetor
.. _#79: https://github.com/pytest-dev/pytest-mock/pull/79
1.5.0
-----
* New ``mocker.mock_module`` variable points to the underlying mock module being used
(``unittest.mock`` or ``mock``).
Thanks `@blueyed`_ for the request (`#71`_).
.. _#71: https://github.com/pytest-dev/pytest-mock/pull/71
1.4.0
-----
* New configuration variable, ``mock_use_standalone_module`` (defaults to ``False``). This forces
the plugin to import ``mock`` instead of ``unittest.mock`` on Python 3. This is useful to import
a newer version than the one available in the Python distribution.
* Previously the plugin would first try to import ``mock`` and fallback to ``unittest.mock``
in case of an ``ImportError``, but this behavior has been removed because it could hide
hard to debug import errors (`#68`_).
* Now ``mock`` (Python 2) and ``unittest.mock`` (Python 3) are lazy-loaded to make it possible to
implement the new ``mock_use_standlone_module`` configuration option. As a consequence of this
the undocumented ``pytest_mock.mock_module`` variable, which pointed to the actual mock module
being used by the plugin, has been removed.
* `DEFAULT <https://docs.python.org/3/library/unittest.mock.html#default>`_ is now available from
the ``mocker`` fixture.
.. _#68: https://github.com/pytest-dev/pytest-mock/issues/68
1.3.0
-----
* Add support for Python 3.6. Thanks `@hackebrot`_ for the report (`#59`_).
* ``mock.mock_open`` is now aliased as ``mocker.mock_open`` for convenience.
Thanks `@pokidovea`_ for the PR (`#66`_).
.. _@hackebrot: https://github.com/hackebrot
.. _@pokidovea: https://github.com/pokidovea
.. _#59: https://github.com/pytest-dev/pytest-mock/issues/59
.. _#66: https://github.com/pytest-dev/pytest-mock/pull/66
1.2
---
* Try to import ``mock`` first instead of ``unittest.mock``. This gives the user flexibility
to install a newer ``mock`` version from PyPI instead of using the one available in the
Python distribution.
Thanks `@wcooley`_ for the PR (`#54`_).
* ``mock.sentinel`` is now aliased as ``mocker.sentinel`` for convenience.
Thanks `@kjwilcox`_ for the PR (`#56`_).
.. _@wcooley: https://github.com/wcooley
.. _@kjwilcox: https://github.com/kjwilcox
.. _#54: https://github.com/pytest-dev/pytest-mock/issues/54
.. _#56: https://github.com/pytest-dev/pytest-mock/pull/56
1.1
---
* From this version onward, ``pytest-mock`` is licensed under the `MIT`_ license (`#45`_).
* Now the plugin also adds introspection information on differing call arguments when
calling helper methods such as ``assert_called_once_with``. The extra introspection
information is similar to pytest's and can be disabled with the ``mock_traceback_monkeypatch``
option.
Thanks `@asfaltboy`_ for the PR (`#36`_).
* ``mocker.stub()`` now allows passing in the name for the constructed `Mock
<https://docs.python.org/3/library/unittest.mock.html#the-mock-class>`_
object instead of having to set it using the internal ``_mock_name`` attribute
directly. This is useful for debugging as the name is used in the mock's
``repr`` string as well as related assertion failure messages.
Thanks `@jurko-gospodnetic`_ for the PR (`#40`_).
* Monkey patching ``mock`` module for friendlier tracebacks is automatically disabled
with the ``--tb=native`` option. The underlying
mechanism used to suppress traceback entries from ``mock`` module does not work with that option
anyway plus it generates confusing messages on Python 3.5 due to exception chaining (`#44`_).
Thanks `@blueyed`_ for the report.
* ``mock.call`` is now aliased as ``mocker.call`` for convenience.
Thanks `@jhermann`_ for the PR (`#49`_).
.. _@jurko-gospodnetic: https://github.com/jurko-gospodnetic
.. _@asfaltboy: https://github.com/asfaltboy
.. _@jhermann: https://github.com/jhermann
.. _#45: https://github.com/pytest-dev/pytest-mock/issues/45
.. _#36: https://github.com/pytest-dev/pytest-mock/issues/36
.. _#40: https://github.com/pytest-dev/pytest-mock/issues/40
.. _#44: https://github.com/pytest-dev/pytest-mock/issues/44
.. _#49: https://github.com/pytest-dev/pytest-mock/issues/49
.. _MIT: https://github.com/pytest-dev/pytest-mock/blob/master/LICENSE
1.0
---
* Fix AttributeError with ``mocker.spy`` when spying on inherited methods
(`#42`_). Thanks `@blueyed`_ for the PR.
.. _@blueyed: https://github.com/blueyed
.. _#42: https://github.com/pytest-dev/pytest-mock/issues/42
0.11.0
------
* `PropertyMock <https://docs.python.org/3/library/unittest.mock.html#unittest.mock.PropertyMock>`_
is now accessible from ``mocker``.
Thanks `@satyrius`_ for the PR (`#32`_).
* Fix regression using one of the ``assert_*`` methods in patched
functions which receive a parameter named ``method``.
Thanks `@sagarchalise`_ for the report (`#31`_).
.. _@sagarchalise: https://github.com/sagarchalise
.. _@satyrius: https://github.com/satyrius
.. _#31: https://github.com/pytest-dev/pytest-mock/issues/31
.. _#32: https://github.com/pytest-dev/pytest-mock/issues/32
0.10.1
------
* Fix regression in frozen tests due to ``distutils`` import dependency.
Thanks `@The-Compiler`_ for the report (`#29`_).
* Fix regression when using ``pytest-mock`` with ``pytest-2.7.X``.
Thanks `@akscram`_ for the report (`#28`_).
.. _@akscram: https://github.com/Chronial
.. _#28: https://github.com/pytest-dev/pytest-mock/issues/28
.. _#29: https://github.com/pytest-dev/pytest-mock/issues/29
0.10
----
* ``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-mock/issues/26
.. _#27: https://github.com/pytest-dev/pytest-mock/issues/27
0.9.0
-----
* New ``mocker.resetall`` function, which calls ``reset_mock()`` in all mocked
objects up to that point. Thanks to `@mathrick`_ for the PR!
0.8.1
-----
* ``pytest-mock`` is now also available as a wheel. Thanks `@rouge8`_ for the PR!
0.8.0
-----
* ``mock.ANY`` is now accessible from the mocker fixture (`#17`_), thanks `@tigarmo`_ for the PR!
.. _#17: https://github.com/pytest-dev/pytest-qt/issues/17
0.7.0
-----
Thanks to `@fogo`_, mocker.spy can now prey upon staticmethods and classmethods. :smile:
0.6.0
-----
* Two new auxiliary methods, ``spy`` and ``stub``. See ``README`` for usage.
(Thanks `@fogo`_ for complete PR!)
0.5.0
-----
* ``Mock`` and ``MagicMock`` are now accessible from the ``mocker`` fixture,
many thanks to `@marcwebbie`_ for the complete PR!
0.4.3
-----
* ``mocker`` fixture now returns the same object (`#8`_). Many thanks to `@RonnyPfannschmidt`_ for the PR!
.. _#8: https://github.com/pytest-dev/pytest-qt/issues/8
0.4.2
-----
* Small fix, no longer using wheel as an alternate package since it
conditionally depends on mock module based on Python version,
as Python >= 3.3 already includes ``unittest.mock``.
Many thanks to `@The-Compiler`_ for letting me know and providing a PR with the fix!
0.4.1
-----
* Small release that just uses ``pytest_mock`` as the name of the plugin,
instead of ``pytest-mock``: this makes it simple to depend on this plugin
explicitly using ``pytest_plugins`` module variable mechanism.
0.4.0
-----
* Changed fixture name from ``mock`` into ``mocker`` because it conflicted
with the actual mock module, which made using it awkward when access to both
the module and the fixture were required within a test.
Thanks `@kmosher`_ for request and discussion in `#4`_. :smile:
.. _#4: https://github.com/pytest-dev/pytest-qt/issues/4
0.3.0
-----
* Fixed bug `#2`_, where a patch would not be uninstalled correctly after
patching the same object twice.
0.2.0
-----
* Added ``patch.dict`` support.
0.1.0
-----
First release.
.. _#2: https://github.com/pytest-dev/pytest-qt/issues/2
.. _@fogo: https://github.com/fogo
.. _@kmosher: https://github.com/kmosher
.. _@marcwebbie: https://github.com/marcwebbie
.. _@mathrick: https://github.com/mathrick
.. _@mlhamel: https://github.com/mlhamel
.. _@RonnyPfannschmidt: https://github.com/RonnyPfannschmidt
.. _@rouge8: https://github.com/rouge8
.. _@The-Compiler: https://github.com/The-Compiler
.. _@tigarmo: https://github.com/tigarmo