https://github.com/Xion/callee

Argument matchers for unittest.mock
https://github.com/Xion/callee

matchers mocking python testing unit-testing

Last synced: 10 days ago
JSON representation

Argument matchers for unittest.mock

• Host: GitHub
• URL: https://github.com/Xion/callee
• Owner: Xion
• License: bsd-3-clause
• Created: 2015-08-23T20:19:45.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-09-11T14:03:30.000Z (about 4 years ago)
• Last Synced: 2024-07-24T13:59:17.151Z (4 months ago)
• Topics: matchers, mocking, python, testing, unit-testing
• Language: Python
• Homepage: http://callee.readthedocs.org
• Size: 216 KB
• Stars: 87
• Watchers: 6
• Forks: 11
• Open Issues: 13
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
callee

======

Argument matchers for *unittest.mock*

|Version| |Development Status| |Python Versions| |License| |Build Status|

.. |Version| image:: https://img.shields.io/pypi/v/callee.svg?style=flat

    :target: https://pypi.python.org/pypi/callee

    :alt: Version

.. |Development Status| image:: https://img.shields.io/pypi/status/callee.svg?style=flat

    :target: https://pypi.python.org/pypi/callee/

    :alt: Development Status

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/callee.svg?style=flat

    :target: https://pypi.python.org/pypi/callee

    :alt: Python versions

.. |License| image:: https://img.shields.io/pypi/l/callee.svg?style=flat

    :target: https://github.com/Xion/callee/blob/master/LICENSE

    :alt: License

.. |Build Status| image:: https://img.shields.io/travis/Xion/callee.svg?style=flat

    :target: https://travis-ci.org/Xion/callee

    :alt: Build Status

More robust tests

~~~~~~~~~~~~~~~~~

Python's `mocking library`_ (or its `backport`_ for Python <3.3) is simple, reliable, and easy to use.

But it is also a little lacking when it comes to asserting what calls a mock has received.

You can be either very specific::

    my_mock.assert_called_once_with(42, some_foo_object, 'certain string')

or extremely general::

    my_mock.assert_called_with(ANY, ANY, ANY)

    # passes as long as argument count is the same

| The former can make your tests over-specified, and thus fragile.

| The latter could make them too broad, missing some erroneous cases and possibly letting your code fail in production.

----

*callee* provides **argument matchers** that allow you to be exactly as precise as you want::

    my_mock.assert_called_with(GreaterThan(0), InstanceOf(Foo), String())

without tedious, handcrafted, and poorly readable code that checks ``call_args`` or ``call_args_list``::

    self.assertGreater(mock.call_args[0][0], 0)

    self.assertIsInstance(mock.call_args[0][1], Foo)

    self.assertIsInstance(mock.call_args[0][2], str)

It has plenty of matcher types to fit all common and uncommon needs, and you can easily write your own if necessary.

.. _mocking library: https://docs.python.org/3/library/unittest.mock.html

.. _backport: https://pypi.python.org/pypi/mock

Installation

~~~~~~~~~~~~

Installing *callee* is easy with pip::

    $ pip install callee

| *callee* support goes all the way back to Python 2.6.

| It also works both with the ``unittest.mock`` module from Python 3.3+ or its backport.

API reference

~~~~~~~~~~~~~

See the `documentation`_ for complete reference on the library usage and all available matchers.

.. _documentation: http://callee.readthedocs.org

Contributing

~~~~~~~~~~~~

Contributions are welcome!

If you need ideas, head to the issue tracker or search for the various ``TODO``\ s scattered around the codebase.

Or just think what matchers you'd like to add :)

After cloning the repository, this should get you up and running::

    # ... create virtualenv as necessary ...

    pip install -r requirements-dev.txt

    tox

To regenerate documentation and display it in the browser, simply run::

    inv docs

Happy hacking!