File: PKG-INFO

package info (click to toggle)
pytest-mock 1.10.4-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 268 kB
  • sloc: python: 670; makefile: 6
file content (374 lines) | stat: -rw-r--r-- 14,872 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
Metadata-Version: 2.1
Name: pytest-mock
Version: 1.10.4
Summary: Thin-wrapper around the mock package for easier use with py.test
Home-page: https://github.com/pytest-dev/pytest-mock/
Author: Bruno Oliveira
Author-email: nicoddemus@gmail.com
License: MIT
Description: ===========
        pytest-mock
        ===========
        
        This plugin installs a ``mocker`` fixture which is a thin-wrapper around the patching API
        provided by the `mock package <http://pypi.python.org/pypi/mock>`_,
        but with the benefit of not having to worry about undoing patches at the end
        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')
        
        
        
        |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
        
        .. |anaconda| image:: https://img.shields.io/conda/vn/conda-forge/pytest-mock.svg
            :target: https://anaconda.org/conda-forge/pytest-mock
        
        .. |ci| image:: http://img.shields.io/travis/pytest-dev/pytest-mock.svg
          :target: https://travis-ci.org/pytest-dev/pytest-mock
        
        .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/pid1t7iuwhkm9eh6/branch/master?svg=true
          :target: https://ci.appveyor.com/project/pytestbot/pytest-mock
        
        .. |coverage| image:: http://img.shields.io/coveralls/pytest-dev/pytest-mock.svg
          :target: https://coveralls.io/r/pytest-dev/pytest-mock
        
        .. |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
        
        `Professionally supported pytest-mock is now available <https://tidelift.com/subscription/pkg/pypi-pytest_mock?utm_source=pypi-pytest-mock&utm_medium=referral&utm_campaign=readme>`_
        
        Usage
        =====
        
        The ``mocker`` fixture has the same API as
        `mock.patch <https://docs.python.org/3/library/unittest.mock.html#patch>`_,
        supporting the same arguments:
        
        .. code-block:: python
        
            def test_foo(mocker):
                # all valid calls
                mocker.patch('os.remove')
                mocker.patch.object(os, 'listdir', autospec=True)
                mocked_isfile = mocker.patch('os.path.isfile')
        
        The supported methods are:
        
        * `mocker.patch <https://docs.python.org/3/library/unittest.mock.html#patch>`_
        * `mocker.patch.object <https://docs.python.org/3/library/unittest.mock.html#patch-object>`_
        * `mocker.patch.multiple <https://docs.python.org/3/library/unittest.mock.html#patch-multiple>`_
        * `mocker.patch.dict <https://docs.python.org/3/library/unittest.mock.html#patch-dict>`_
        * `mocker.stopall <https://docs.python.org/3/library/unittest.mock.html#unittest.mock.patch.stopall>`_
        * ``mocker.resetall()``: calls `reset_mock() <https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.reset_mock>`_ in all mocked objects up to this point.
        
        These objects from the ``mock`` module are accessible directly from ``mocker`` for convenience:
        
        * `Mock <https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock>`_
        * `MagicMock <https://docs.python.org/3/library/unittest.mock.html#unittest.mock.MagicMock>`_
        * `PropertyMock <https://docs.python.org/3/library/unittest.mock.html#unittest.mock.PropertyMock>`_
        * `ANY <https://docs.python.org/3/library/unittest.mock.html#any>`_
        * `DEFAULT <https://docs.python.org/3/library/unittest.mock.html#default>`_ *(Version 1.4)*
        * `call <https://docs.python.org/3/library/unittest.mock.html#call>`_ *(Version 1.1)*
        * `sentinel <https://docs.python.org/3/library/unittest.mock.html#sentinel>`_ *(Version 1.2)*
        * `mock_open <https://docs.python.org/3/library/unittest.mock.html#mock-open>`_
        
        
        Spy
        ---
        
        The spy acts exactly like the original method in all cases, except it allows use of `mock`
        features with it, like retrieving call count. It also works for class and static methods.
        
        
        .. code-block:: python
        
            def test_spy(mocker):
                class Foo(object):
                    def bar(self):
                        return 42
        
                foo = Foo()
                mocker.spy(foo, 'bar')
                assert foo.bar() == 42
                assert foo.bar.call_count == 1
        
        Stub
        ----
        
        
        The stub is a mock object that accepts any arguments and is useful to test callbacks, for instance.
        May be passed a name to be used by the constructed stub object in its repr (useful for debugging).
        
        .. code-block:: python
        
            def test_stub(mocker):
                def foo(on_something):
                    on_something('foo', 'bar')
        
                stub = mocker.stub(name='on_something_stub')
        
                foo(stub)
                stub.assert_called_once_with('foo', 'bar')
        
        
        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()`` by hiding internal traceback
        entries from the ``mock`` module.
        
        It also adds introspection information on differing call arguments when
        calling the helper methods. This features catches `AssertionError` raised in
        the method, and uses py.test's own `advanced assertions`_ to return a better
        diff::
        
        
            mocker = <pytest_mock.MockFixture object at 0x0381E2D0>
        
                def test(mocker):
                    m = mocker.Mock()
                    m('fo')
            >       m.assert_called_once_with('', bar=4)
            E       AssertionError: Expected call: mock('', bar=4)
            E       Actual call: mock('fo')
            E
            E       pytest introspection follows:
            E
            E       Args:
            E       assert ('fo',) == ('',)
            E         At index 0 diff: 'fo' != ''
            E         Use -v to get the full diff
            E       Kwargs:
            E       assert {} == {'bar': 4}
            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 ===========================
        
        
        This is useful when asserting mock calls with many/nested arguments and trying
        to quickly see the difference.
        
        This feature is probably safe, but if you encounter any problems it can be disabled in
        your ``pytest.ini`` file:
        
        .. code-block:: ini
        
            [pytest]
            mock_traceback_monkeypatch = false
        
        Note that this feature 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
        
        .. _advanced assertions: http://pytest.org/latest/assert.html
        
        
        Use standalone "mock" package
        -----------------------------
        
        *New in version 1.4.0.*
        
        Python 3 users might want to use a newest version of the ``mock`` package as published on PyPI
        than the one that comes with the Python distribution.
        
        .. code-block:: ini
        
            [pytest]
            mock_use_standalone_module = true
        
        This will force the plugin to import ``mock`` instead of the ``unittest.mock`` module bundled with
        Python 3.4+. Note that this option is only used in Python 3+, as Python 2 users only have the option
        to use the ``mock`` package from PyPI anyway.
        
        
        Requirements
        ============
        
        * Python 2.7, Python 3.4+
        * pytest
        * mock (for Python 2)
        
        
        Install
        =======
        
        Install using `pip <http://pip-installer.org/>`_:
        
        .. code-block:: console
        
            $ pip install pytest-mock
        
        Changelog
        =========
        
        Please consult the `changelog page`_.
        
        .. _changelog page: https://github.com/pytest-dev/pytest-mock/blob/master/CHANGELOG.rst
        
        Why bother with a plugin?
        =========================
        
        There are a number of different ``patch`` usages in the standard ``mock`` API,
        but IMHO they don't scale very well when you have more than one or two
        patches to apply.
        
        It may lead to an excessive nesting of ``with`` statements, breaking the flow
        of the test:
        
        .. code-block:: python
        
            import mock
        
            def test_unix_fs():
                with mock.patch('os.remove'):
                    UnixFS.rm('file')
                    os.remove.assert_called_once_with('file')
        
                    with mock.patch('os.listdir'):
                        assert UnixFS.ls('dir') == expected
                        # ...
        
                with mock.patch('shutil.copy'):
                    UnixFS.cp('src', 'dst')
                    # ...
        
        
        One can use ``patch`` as a decorator to improve the flow of the test:
        
        .. code-block:: python
        
            @mock.patch('os.remove')
            @mock.patch('os.listdir')
            @mock.patch('shutil.copy')
            def test_unix_fs(mocked_copy, mocked_listdir, mocked_remove):
                UnixFS.rm('file')
                os.remove.assert_called_once_with('file')
        
                assert UnixFS.ls('dir') == expected
                # ...
        
                UnixFS.cp('src', 'dst')
                # ...
        
        But this poses a few disadvantages:
        
        - test functions must receive the mock objects as parameter, even if you don't plan to
          access them directly; also, order depends on the order of the decorated ``patch``
          functions;
        - receiving the mocks as parameters doesn't mix nicely with pytest's approach of
          naming fixtures as parameters, or ``pytest.mark.parametrize``;
        - you can't easily undo the mocking during the test execution;
        
        
        **Note about usage as context manager**
        
        Although mocker's API is intentionally the same as ``mock.patch``'s, its use
        as context manager and function decorator is **not** supported through the
        fixture. The purpose of this plugin is to make the use of context managers and
        function decorators for mocking unnecessary. Indeed, trying to use the
        functionality in ``mocker`` in this manner can lead to non-intuitive errors:
        
        .. code-block:: python
        
            def test_context_manager(mocker):
                a = A()
                with mocker.patch.object(a, 'doIt', return_value=True, autospec=True):
                    assert a.doIt() == True
        
        .. code-block:: console
        
            ================================== FAILURES ===================================
            ____________________________ test_context_manager _____________________________
            in test_context_manager
                with mocker.patch.object(a, 'doIt', return_value=True, autospec=True):
            E   AttributeError: __exit__
        
        You can however use ``mocker.mock_module`` to access the underlying ``mock``
        module, e.g. to return a context manager in a fixture that mocks something
        temporarily:
        
        .. code-block:: python
        
            @pytest.fixture
            def fixture_cm(mocker):
                @contextlib.contextmanager
                def my_cm():
                    def mocked():
                        pass
        
                    with mocker.mock_module.patch.object(SomeClass, 'method', mocked):
                        yield
                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
        =======
        
        Distributed under the terms of the `MIT`_ license.
        
        .. _MIT: https://github.com/pytest-dev/pytest-mock/blob/master/LICENSE
        
Keywords: pytest mock
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
Provides-Extra: dev