python-radon

The python radon extension shows the complexity and rating of a class, method or function inline of the source code.

Requirements

You need to install python-radon at a minimum version 5.1:

pip install "radon>=5.1"

Metrics

See the radon documentation to understand the rating and complextity values presented by the extension.

Maintainability Index

Cyclomatic Complexity

Code Lens and Status Bar

The cyclomatic complexity is shown in front of functions, methods or classes. You can also see the current maintainable index of the source code of the active editor in the status bar.

Extension Settings

This extension contributes the following settings:

• python.radon.enable: enable/disable this extension
• python.radon.executable: set to a path to your radon executable, e.g. /usr/bin/radon

Troubleshooting

Running on Windows

If you install python-radon on a windows system there is no single radon executable. To solve this you can create a batch script radon.cmd in a folder which is part of your PATH environment variable of the following content:

@python -m radon %*

Credits

Complex icons created by Flat Icons - Flaticon

Release Notes

1.0.6

Provide trouble shooting for Windows System

1.0.5

Spelling errors were corrected

1.0.4

Added screenshot of the functionality to the README.md

1.0.3

Show the maintainability index of the current source code in the status bar

1.0.2

Allow editing settings when executable couldn't be found and the documentation was extended

1.0.1

Added the complexity icon Complex icons created by Flat Icons - Flaticon

1.0.0

Initial release of Python radon