rubik/radon

Various code metrics for Python code

Radon

---

Radon is a Python tool that computes various metrics from the source code. Radon can compute:

• McCabe's complexity, i.e. cyclomatic complexity
• raw metrics (these include SLOC, comment lines, blank lines, &c.)
• Halstead metrics (all of them)
• Maintainability Index (the one used in Visual Studio)

Requirements

Radon will run from Python 2.7 to Python 3.10 (except Python versions from 3.0 to 3.3) with a single code base and without the need of tools like 2to3 or six. It can also run on PyPy without any problems (currently PyPy 3.5 v7.3.1 is used in tests).

Radon depends on as few packages as possible. Currently only mando is strictly required (for the CLI interface). colorama is also listed as a dependency but if Radon cannot import it, the output simply will not be colored.

Note: Python 2.6 was supported until version 1.5.0. Starting from version 2.0, it is not supported anymore.

Installation

With Pip:

$ pip install radon

If you want to configure Radon from pyproject.toml and you run Python <3.11, you'll need the extra toml dependency:

$ pip install radon[toml]

Or download the source and run the setup file:

$ python setup.py install

Usage

Radon can be used either from the command line or programmatically. Documentation is at https://radon.readthedocs.org/.

Cyclomatic Complexity Example

Quick example:

$ radon cc sympy/solvers/solvers.py -a -nc
sympy/solvers/solvers.py
    F 346:0 solve - F
    F 1093:0 _solve - F
    F 1434:0 _solve_system - F
    F 2647:0 unrad - F
    F 110:0 checksol - F
    F 2238:0 _tsolve - F
    F 2482:0 _invert - F
    F 1862:0 solve_linear_system - E
    F 1781:0 minsolve_linear_system - D
    F 1636:0 solve_linear - D
    F 2382:0 nsolve - C

11 blocks (classes, functions, methods) analyzed.
Average complexity: F (61.0)

Explanation:

• cc is the radon command to compute Cyclomatic Complexity
• -a tells radon to calculate the average complexity at the end. Note that the average is computed among the shown blocks. If you want the total average, among all the blocks, regardless of what is being shown, you should use --total-average.
• -nc tells radon to print only results with a complexity rank of C or worse. Other examples: -na (from A to F), or -nd (from D to F).
• The letter in front of the line numbers represents the type of the block (F means function, M method and C class).

Actually it's even better: it's got colors!

Note about file encoding

On some systems, such as Windows, the default encoding is not UTF-8. If you are using Unicode characters in your Python file and want to analyze it with Radon, you'll have to set the RADONFILESENCODING environment variable to UTF-8.

On a Continuous Integration server

If you are looking to use radon on a CI server you may be better off with xenon. Although still experimental, it will fail (that means exiting with a non-zero exit code) when various thresholds are surpassed. radon is more of a reporting tool, while xenon is a monitoring one.

If you are looking for more complete solutions, read the following sections.

Codacy

Codacy uses Radon by default to calculate metrics from the source code.

Code Climate

Radon is available as a Code Climate Engine. To understand how to add Radon's checks to your Code Climate Platform, head over to their documentation: https://docs.codeclimate.com/v1.0/docs/radon

coala Analyzer

Radon is also supported in coala. To add Radon's checks to coala, simply add the RadonBear to one of the sections in your .coafile.

CodeFactor

CodeFactor uses Radon out-of-the-box to calculate Cyclomatic Complexity.

Usage with Jupyter Notebooks

Radon can be used with .ipynb files to inspect code metrics for Python cells. Any % macros will be ignored in the metrics.

Note

Jupyter Notebook support requires the optional nbformat package. To install, run pip install nbformat.

To enable scanning of Jupyter notebooks, add the --include-ipynb flag.

To enable reporting of individual cells, add the --ipynb-cells flag.

Quick example:

$ radon raw --include-ipynb --ipynb-cells .
example.ipynb
    LOC: 63
    LLOC: 37
    SLOC: 37
    Comments: 3
    Single comments: 2
    Multi: 10
    Blank: 14
    - Comment Stats
        (C % L): 5%
        (C % S): 8%
        (C + M % L): 21%
example.ipynb:[0]
    LOC: 0
    LLOC: 0
    SLOC: 0
    Comments: 0
    Single comments: 0
    Multi: 0
    Blank: 0
    - Comment Stats
        (C % L): 0%
        (C % S): 0%
        (C + M % L): 0%
example.ipynb:[1]
    LOC: 2
    LLOC: 2
    SLOC: 2
    Comments: 0
    Single comments: 0
    Multi: 0
    Blank: 0
    - Comment Stats
        (C % L): 0%
        (C % S): 0%
        (C + M % L): 0%

Links

• Documentation: https://radon.readthedocs.org
• PyPI: http://pypi.python.org/pypi/radon
• Issue Tracker: https://github.com/rubik/radon/issues

radon's Issues

Simplify mi_rank

Semicolons are ignored

As for now the raw module completely ignores semicolons.

ValueError using -s

[22:05 ~/Documents/Dprojects/Python/CoBro] radon cc -s cobro.py
Traceback (most recent call last):
  File "/usr/local/bin/radon", line 8, in <module>
    load_entry_point('radon==0.3', 'console_scripts', 'radon')()
  File "/Library/Python/2.6/site-packages/radon-0.3-py2.6.egg/radon/__init__.py", line 10, in main
    BAKER.run()
  File "build/bdist.macosx-10.6-universal/egg/baker.py", line 823, in run
  File "build/bdist.macosx-10.6-universal/egg/baker.py", line 801, in apply
  File "/Library/Python/2.6/site-packages/radon-0.3-py2.6.egg/radon/cli.py", line 171, in cc
show_complexity)
  File "/Library/Python/2.6/site-packages/radon-0.3-py2.6.egg/radon/cli.py", line 106, in _print_cc_results show_complexity)))
  File "/Library/Python/2.6/site-packages/radon-0.3-py2.6.egg/radon/cli.py", line 83, in _format_line
    compl = ' ({}) '.format(line.complexity) if show_complexity else ''
ValueError: zero length field name in format

Same result for radon cc --show_complexity cobro.py

Finish README

Make the codebase compatible with PyPy

Currently 7 tests fails under PyPy.

Docstrings are a mess

After the big refactor, docstrings are very messy. Fix, bearing in mind:

• consistency: all docstrings should be more or less the same (Sphinx style or not?)
• accuracy: docstrings should be helpful

Please support `radon --version`

Add complete tests for cli.py

Check the output too for the various options.

Complete setup's arguments.

Add missing parameters and short/long description.

Clojures get lost in ComplexityVisitor

ComplexityVisitor should keep track of clojures.

ERROR: invalid syntax (<unknown>, line 1404)

Cloned the repository. Did sudo python radon/setup.py install with apparent success. Installed Baker module.

[21:48 ~/Documents/Dprojects/Python/CoBro] radon cc cobro.py
cobro.py
    ERROR: invalid syntax (<unknown>, line 1404)
[21:48 ~/Documents/Dprojects/Python/CoBro] radon mi cobro.py
cobro.py
    ERROR: invalid syntax (<unknown>, line 1404)
[21:49 ~/Documents/Dprojects/Python/CoBro] radon raw  cobro.py
cobro.py
    LOC: 1404
    LLOC: 688
    SLOC: 1323
    Comments: 491
    Multi: 82
    Blank: 81
    - Comment Stats
        (C % L): 35%
        (C % S): 37%
        (C + M % L): 41%

Noting "1404" as size of input -- that line of cobro.py was: # c'est tout! a comment indented 4 ending in ! -- deleted that line and appropriate output appeared. Restoring line 1404 as #! returned the error.

Reduce pathfinder code to a minimum

Or remove completely and replace with something slimmer.

Should the -n flag be affecting the -a flag of the cc command?

In regards to the cc command, when the -n flag is used with the -a flag, the summary is comprised of only the displayed blocks rather than the entire codebase.

Document commands as seen in setuptools docs

Like this: http://pythonhosted.org/setuptools/setuptools.html

integration with jenkins

Can be awsome if you can export the radon cc to an xml compatible with

https://wiki.jenkins-ci.org/display/JENKINS/CCM+Plugin

The ccm.xml is the result of ccm with this format:

https://github.com/jenkinsci/ccm-plugin/blob/master/src/test/resources/hudson/plugins/ccm/parser/ccm.result.xml

PEP8 & PyLint fixes

External deps?

The README states that:

Radon does not depend on any other Python package (except Baker for the command line, but it is an optional dependency).

However, setup.py contains this snippet:

install_requires=['mando', 'colorama', 'pathfinder'],

Please update the README. :-)

Enhance including and excluding options

Packaging issue with the 'tests/' directory

Hi,
as your tests directory is included in the distributed tarball as a top-level package, it is installed in python's site-packages (which can cause conflicts with other packages doing the same thing):

~ $ ls ~/lib/virtualenvs/radon/lib/python3.4/site-packages/tests
__init__.py  pathfinder_tests/  __pycache__/  run.py  test_cli.py  test_complexity_utils.py  test_complexity_visitor.py  test_halstead.py  test_other_metrics.py  test_raw.py

One option would be to exclude it from the distributed tarball, and the other option is to move it to radon.tests.

Unit tests take too much time

They're not really unit tests if they take so much time. Currently the tests inside test_cli.py run for almost 90% of the total time.

100% coverage for 0.2

As for now it's at 91%. Only metrics.py is missing.

Doc: math formulas not rendered on RTD

https://radon.readthedocs.org/en/latest/intro.html#maintainability-index shows the source formula, not a human-friendly rendition.

Port radon.cli to Python 3!

CC Bug: while ... else

I wouldn't expect the following function to have a CC of 10. It seems as if the else-statement of a while-loop adds 1 to CC and so does every line in the else-block.

def func():
    while 1:
        pass
    else:
        pass
        pass
        pass
        pass
        pass
        pass
        pass

Get the docs up-to-date

They're not up-to-date with all the commands.

Include entire pathfinder source into the tree

This would allow for higher customization over the file discovering process. Better ignore option.

MI command should have a "-s" option like CC

"block" output is on random order

I would expect the order to be by line number or alphabetical order.
Score order would also be nice.

Add -i, --ignore option to ignore directories

Remove constants from raw.py

There are tokenize's ones which are always correct. Avoid duplication.

Add a CHANGELOG

Simplify and complete README

New flag for avoid assert statements in CC

I and friend have been talking about the assert statement in the calculation of the Cyclomatic complexity (CC). We found arguments for including it, but also argument for not including it.

One argument to take into account assert statements is that an assert statement may generate a different result when executing. As Radon documentation says: “The assert statement internally roughly equals a conditional statement.”

On the other hand, it is possible to execute a Python script without running the assert statements with option –O. Although an assert increases the CC, there is no usually need to write test cases for verify the assert statements.

It seems clear that a statement introduces a new path in the code, but, it seems unclear the utility to take asserts into account. Due Radeon uses a Python parser, it counts the assert statements even –O option is indicated.

For these reason we would kindly propose a command-line flag to avoid the count of asserts as part of the CC (maybe I can sumbmit a pull request if this issue is accepted).

Replace baker with komandr or manage.py

`iter_filenames` is very slow

Here is an example fix: http://stackoverflow.com/questions/5141437/filtering-os-walk-dirs-and-files

How can i run all the Radon commands in a single call?

Hi folks, I want to execute, in a single shell command, all the 3 Radon commands, something like:

$ radon raw cc mi app.py

is there any way to do that?!
thanks in advance.

Change the image in the README

cc -j or cc --xml fail when an analyzed file has a syntax error.

Complete the documentation

Raw command doc is missing

Convert README to reST

Markdown is awesome but PyPI reads reST...

Add an `endline` attribute to Function and Class objects.

Currently it is only possible to get the line at which a code block starts, not the line where it ends.

Complete all docstrings

Return a non-zero exit code for results below a certain threshold

There should be an option to set a threshold so that this tool will be used during the CI process. For example radon cc --min=B -a --min-average=A will fail if there are modules with cyclic complexity of C and below and if the average is below A.

XML logging for cc tool doesn't respect min/max parameters

I have just recently been tested the latest release of radon to experiment with the new --xml formatting parameter added to the 'cc' tool. In so doing I discovered that the XML output seems to be ignoring either the --min and --max parameters for some reason. Even when these command line options are specified, all complexity levels are included in the resulting XML report.

While this isn't currently a deal breaker for me since I'm using another parsing tool to extract the relevant information I'm looking for from the resulting XML, I did find it non-intuitive to say the least. For example, the results produced by "radon cc -min C myproject" differ from the results produced by "radon cc -min C myproject --xml".

I assume it would be a relatively simple matter to update the tool so the XML output respects these other customization parameters as well, so this may be something to consider changing in a future release.

Add tests for cli.py

For now just check that commands exit without errors...

Create a documentation (readthedocs.org)

Add -e, --exclude options to CLI commands

`endline` could be `float('-inf`)`

This is bad, requires an immediate fix.

raw command fails if file has nothing but an empty string with line end

Hi. On version

radon==0.4.1

I got

./apps/utils/models.py
    LOC: 1
    LLOC: 0
    SLOC: 0
    Comments: 0
    Multi: 0
    Blank: 1
    - Comment Stats
        (C % L): 0%
    load_entry_point('radon==0.4.1', 'console_scripts', 'radon')()
  File "/home/apollov/.local/lib/python2.7/site-packages/radon/__init__.py", line 8, in main
    BAKER.run()
  File "/home/apollov/.local/lib/python2.7/site-packages/baker.py", line 823, in run
    value = self.apply(*self.parse(argv), instance=instance)
  File "/home/apollov/.local/lib/python2.7/site-packages/baker.py", line 801, in apply
    return cmd.fn(*newargs, **newkwargs)
  File "/home/apollov/.local/lib/python2.7/site-packages/radon/cli.py", line 227, in raw
    log('{0}(C % S): {1:.0%}', indent, comments / float(mod.sloc))
ZeroDivisionError: float division by zero

Where ./apps/utils/models.py contains just 1 empty string with line end:

\n

What languages does Radon work on?

Does it only process .py or can it handle other languages such as C?