Skip to main content

McCabe checker, plugin for flake8

Project description

Ned’s script to check McCabe complexity.

This module provides a plugin for flake8, the Python code checker.

Installation

You can install, upgrade, uninstall mccabe with these commands:

$ pip install mccabe
$ pip install --upgrade mccabe
$ pip uninstall mccabe

Standalone script

The complexity checker can be used directly:

$ python -m mccabe --min 5 mccabe.py
("185:1: 'PathGraphingAstVisitor.visitIf'", 5)
("71:1: 'PathGraph.to_dot'", 5)
("245:1: 'McCabeChecker.run'", 5)
("283:1: 'main'", 7)
("203:1: 'PathGraphingAstVisitor.visitTryExcept'", 5)
("257:1: 'get_code_complexity'", 5)

Plugin for Flake8

When both flake8 2.0 and mccabe are installed, the plugin is available in flake8:

$ flake8 --version
2.0 (pep8: 1.4.2, pyflakes: 0.6.1, mccabe: 0.2)

By default the plugin is disabled. Use the --max-complexity switch to enable it. It will emit a warning if the McCabe complexity of a function is higher that the value:

$ flake8 --max-complexity 10 coolproject
...
coolproject/mod.py:1204:1: C901 'CoolFactory.prepare' is too complex (14)

This feature is quite useful to detect over-complex code. According to McCabe, anything that goes beyond 10 is too complex.

Changes

0.3.1 - 2015-06-14

  • Include test_mccabe.py in releases.

  • Always coerce the max_complexity value from Flake8’s entry-point to an integer.

0.3 - 2014-12-17

  • Computation was wrong: the mccabe complexity starts at 1, not 2.

  • The max-complexity value is now inclusive. E.g.: if the value is 10 and the reported complexity is 10, then it passes.

  • Add tests.

0.2.1 - 2013-04-03

  • Do not require setuptools in setup.py. It works around an issue with pip and Python 3.

0.2 - 2013-02-22

  • Rename project to mccabe.

  • Provide flake8.extension setuptools entry point.

  • Read max-complexity from the configuration file.

  • Rename argument min_complexity to threshold.

0.1 - 2013-02-11

  • First 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

mccabe-0.3.1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

mccabe-0.3.1-py2.py3-none-any.whl (7.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file mccabe-0.3.1.tar.gz.

File metadata

  • Download URL: mccabe-0.3.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mccabe-0.3.1.tar.gz
Algorithm Hash digest
SHA256 5f7ea6fb3aa9afe146d07fd6d5cedf788747d8b0c29e44732453c2b2db1e3d16
MD5 9a1570c470ff5db678cc0c03d5c0c237
BLAKE2b-256 bbc9a7d3a53fdaee1fdff753e8333ccf8affe944ac1d4dc4894dbcaa3db5954b

See more details on using hashes here.

Provenance

File details

Details for the file mccabe-0.3.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for mccabe-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bd6c080fb372aebcb0ce19e35ddac744f2abf5a7befa207db2d1097d48efe63a
MD5 bea6b1fdd1cffb8afb4d7cac046f104f
BLAKE2b-256 8475d7966b7280635e96a243d27ca39e5954e9af632a36a4e8eee44660e53540

See more details on using hashes here.

Provenance

Supported by

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