McCabe complexity checker
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.
Links
Feedback and ideas: http://mail.python.org/mailman/listinfo/code-quality
Cyclomatic complexity: http://en.wikipedia.org/wiki/Cyclomatic_complexity.
Ned Batchelder’s script: http://nedbatchelder.com/blog/200803/python_code_complexity_microtool.html
Changes
0.6.1 - 2017-01-26
Fix signature for PathGraphingAstVisitor.default to match the signature for ASTVisitor
0.6.0 - 2017-01-23
Add support for Python 3.6
Fix handling for missing statement types
0.5.3 - 2016-12-14
Report actual column number of violation instead of the start of the line
0.5.2 - 2016-07-31
When opening files ourselves, make sure we always name the file variable
0.5.1 - 2016-07-28
Set default maximum complexity to -1 on the class itself
0.5.0 - 2016-05-30
PyCon 2016 PDX release
Add support for Flake8 3.0
0.4.0 - 2016-01-27
Stop testing on Python 3.2
Add support for async/await keywords on Python 3.5 from PEP 0492
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
1 maintainer
Metadata
1 maintainer
Release files for mccabe 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| mccabe-0.6.1.tar.gz | 8.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mccabe-0.6.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 17.2 kB
Release files / mccabe-0.6.1.tar.gz
| Download URL | mccabe-0.6.1.tar.gz |
|---|---|
| Size | 8.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f
|
|
BLAKE2b-256 checksum How to use checksums |
0618fa675aa501e11d6d6ca0ae73a101b2f3571a565e0f7d38e062eec18a91ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / mccabe-0.6.1-py2.py3-none-any.whl
| Download URL | mccabe-0.6.1-py2.py3-none-any.whl |
|---|---|
| Size | 8.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42
|
|
BLAKE2b-256 checksum How to use checksums |
8789479dc97e18549e21354893e4ee4ef36db1d237534982482c3681ee6e7b57
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for mccabe 0.6.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
