Skip to main content

Provides checking for non-existent mock methods and properties

Project description

Remember that a mock’s job is to say, “You got it, boss” whenever anyone calls it. It will do real work, like raising an exception, when one of its convenience methods is called, like assert_called_once_with. But it won’t do real work when you call a method that only resembles a convenience method, such as assert_called_once (no _with!). Sometimes developers may not notice that they are using a non-existent mock method, because they are not getting an output error telling them so. And for some reason they can also forget to verify that the test cases fail before writing implementation code.

This plugin checks for possible non-existent mock methods when you run flake8, the Python code checker.

Inspired by http://engineeringblog.yelp.com/2015/02/assert_called_once-threat-or-menace.html.

Includes edits from

Installation

You can install or upgrade flake8-mock with these commands:

$ pip install flake8-mock
$ pip install --upgrade flake8-mock

Plugin for Flake8

When both flake8 3.5.0 and flake8-mock are installed, the plugin is available in flake8:

$ flake8 --version
3.5.0 (flake8-mock: 0.4, pyflakes: 0.8.1)

Example output

Once you run flake8, you can have something like:

$ flake8 test_file.py
test_file.py:55:5: M201 called_once is a non-existent mock property
test_file.py:56:5: M200 called_once_with is a non-existent mock method

Credits

  • Alejandro Gabriel Pereira is the original author.

  • Ania Warzecha has rewritten it for flake8 3 and with support for more methods

Changes

0.4 (24-11-2018)

  • Added has_calls to checked methods

  • Added a check for not existent properties on mocks

  • Added compatibility for flake8 3.x

  • Added tests

0.3 (09-10-2016)

  • Don’t warn on assert_not_called, assert_called or assert_called_once.

  • Use ASCII only in README.rst

0.2 (12-16-2015)

  • Add Python 3 compatibility.

0.1 (10-20-2015)

  • First release.

0.1dev0 (10-19-2015)

  • First dev release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8-mock-x2-0.4.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flake8_mock_x2-0.4.1-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file flake8-mock-x2-0.4.1.tar.gz.

File metadata

  • Download URL: flake8-mock-x2-0.4.1.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for flake8-mock-x2-0.4.1.tar.gz
Algorithm Hash digest
SHA256 e28e1c6ff91c35d960a9a04c602ab8ca4d49837c892cb58d13cf5e669a2a7da2
MD5 522fac33c699bb8b719b5b2bff6b425a
BLAKE2b-256 5f5224e82e4d871506e735f3d6b655aef5488402b781bfa430cfa82e25f0301a

See more details on using hashes here.

File details

Details for the file flake8_mock_x2-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: flake8_mock_x2-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for flake8_mock_x2-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6e7b7baf15b7ef561aedf32e88bf0accbf3551546ac91aeceaf541aa5d42e8ac
MD5 c8c93d0fe0f56059dd4bec3ede2d893d
BLAKE2b-256 d3ecd239cb93d471e864c1717bc71c3722155f467981580bd6fddcf1b16b26f7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page