One of the major software engineering principles is that the earlier a defect is found, the more cheaply it can be solved. In this article, I'll go through the most popular tools nowadays that check your code even before running it. These tools work with the principle of static analysis, meaning they treat code as text (in simpler terms). I picked only the most popular and sufficiently maintained ones. Linters Alright, so first things first, let's talk about what a linter is. So there's this tool called "lint" that was originally designed to analyze C source code. It's like a lint trap in a clothes dryer, except it catches small program bugs instead. This utility was created by Stephen C. Johnson back in 1978 when he was working at Bell Labs. The original lint tool and other similar utilities were mainly used to analyze source code to optimize compilers. But over time, these lint-like tools started doing a whole lot more, like performing other types of checks and verifications. Code style/errors checkers 1. Pyflakes https://github.com/PyCQA/pyflakes A simple tool which checks Python source files for errors. Pyflakes makes a simple promise: it will never complain about style, and it will try very, very hard to never emit false positives. 2. Pycodestyle (formerly called pep8) https://github.com/PyCQA/pycodestyle Pycodestyle is a tool to check your Python code against some of the style conventions in . PEP 8 3. Pydocstyle https://github.com/PyCQA/pydocstyle Same as Pycodestyle but it checks docstring conventions. 4. Pylint https://github.com/pylint-dev/pylint Pylint analyses your code without actually running it. It checks for errors, enforces a coding standard, looks for , and can make suggestions about how the code could be refactored. code smells 5. Pyroma https://github.com/regebro/pyroma It's a package style checker that rates how well your project complies with the best practices of the Python packaging ecosystem and lists issues that could be improved. Useful for authors of public libraries. 6. Vulture https://github.com/jendrikseipp/vulture It finds dead Python code, including unused classes, functions, and variables. It's a great tool for refactoring your code. 7. Bandit https://github.com/PyCQA/bandit Bandit is a tool designed to find common security issues in Python code. Type checkers Type checkers help ensure that variables and functions in your code are consistent with each other in terms of type. 1. Mypy https://github.com/python/mypy Mypy is a pioneer in the world of Python type checkers. It was written by Jukka Lehtosalo in 2012 with further contributions from Guido van Rossum, Ivan Levkivskyi, and many others over the years. With mypy, add type hints ( ) to your Python programs, and mypy will warn you when you use those types incorrectly. For a detailed history, refer to . PEP 484 this documentation 2. Pyright (Microsoft) https://github.com/Microsoft/pyright The first public release was in 2019. Pyright is a full-featured, standards-based static type checker for Python. It is designed for and can be used with Python . Pyright uses its own parser, which can recover from syntax errors and continue parsing. In contrast, mypy uses the parser built into the Python interpreter and cannot recover from syntax errors. Additionally, mypy uses a traditional multi-pass architecture where semantic analysis is performed multiple times on a module until all types converge. Therefore, pyright is . For more details, see . high performance large source bases 3-5 times faster than mypy here 3. Pyre  (Facebook) https://github.com/facebook/pyre-check Type checker which is written in OCaml. Open-sourced in 2018, Pyre is a performant type checker for Python that is compliant with . It is due to running multiple checkers in parallel, and uses bottom-up static analysis. It has a built-in security checker called , which is actually on top of Pyre. It comes with tooling that helps you gradually update your codebase with type hinting. PEP 484 faster than mypy Pysa 4. Pytype (Google) https://github.com/google/pytype Pytype checks and infers types for your Python code - . Google developed this tool for its gigantic monolithic repository; thus, this tool is especially useful for checking large codebases. without requiring type annotations Code complexity checkers These tools will help you maintain your code more readable. The most popular way is to calculate cyclomatic complexity, which is a number used to show how complex a program is. It measures the number of paths that can be taken through a program's code. It was created by Thomas J. McCabe, Sr. in 1976. 1. McCabe https://github.com/PyCQA/mccabe Simple McCabe complexity checker. It can be used as a standalone solution, as well as a plugin for . flake8 2. Radon https://github.com/rubik/radon Radon is a Python tool that computes various metrics from the source code: , i.e. cyclomatic complexity McCabe's complexity metrics (including Source Lines of Code, comment lines, blank lines, etc.). Raw metrics ( ) Halstead wiki (the one used in Visual Studio) Maintainability Index 3. Wily https://github.com/tonybaloney/wily A command-line application for tracking and reporting on the complexity of Python tests and applications. It can analyze commits and build a report to show how complexity changes and whose commit ruins this metric :) Formatters Code formatter is a tool that automatically format code according to certain standards or rules. They can format code to be more readable, consistent, and maintainable. Some formatters use their own rules, while others use the linter's output. Here are some examples of what formatters can do: sorting imports, formatting docstrings, formatting code to conform to style guides such as and , and so on. PEP 8 PEP 257 Code formatting tools seriously save so much time when you're trying to stick to a style guide. You just set it up once and let it do its thing automatically. Plus, it makes your pull request so much . diffs easier to read 1. Isort https://github.com/PyCQA/isort This is a very useful tool for keeping imports in your code organized. 2. Docformatter https://github.com/PyCQA/docformatter Automatically formats docstrings to follow a subset of the PEP 257 conventions. 3. Pydocstringformatter https://github.com/DanielNoord/pydocstringformatter This project is heavily inspired by . This tool automatically formats Python docstrings to follow recommendations from and (or other supported style guides). docformatter PEP 8 PEP 257 4. Black https://github.com/psf/black I'd better provide a quote from the project description: is the uncompromising Python code formatter. By using it, you agree to cede control over minutiae of hand-formatting. In return, gives you speed, determinism, and freedom from nagging about formatting. You will save time and mental energy for more important matters. Black Black pycodestyle Blackened code looks the same regardless of the project you're reading. Formatting becomes transparent after a while and you can focus on the content instead. 5. YAPF (Yet Another Python Formatter by Google) https://github.com/google/yapf More flexible compared to Black. You can configure your own style guide or rely on one of the predefined ones: (default) pep8 (based on the ) google Google Python Style Guide (for use with Google open-source projects) yapf facebook 6. Autoflake https://github.com/PyCQA/autoflake Removes unused imports and unused variables as reported by . pyflakes 7. Pyupgrade https://github.com/asottile/pyupgrade A tool to automatically upgrade syntax for newer versions of the language. Very handy in keeping the code style consistent with the most recent version of Python. 8. Autopep8 https://github.com/hhatto/autopep8 Automatically formats Python code to conform to the style guide. It uses the utility to determine which parts of the code need to be formatted. PEP 8 pycodestyle Multi-tools In this category, I include utilities that can perform multiple tasks right out of the box or be customized to fit your needs using plugins. 1. Flake8 https://github.com/PyCQA/flake8 Flake8 is a Python tool that glues together , , , and third-party plugins to check the style and quality of some Python code. pycodestyle pyflakes mccabe 2. Ruff https://github.com/charliermarsh/ruff Ruff can be used to replace Flake8 (plus dozens of plugins), isort, pydocstyle, yesqa, eradicate, pyupgrade, and autoflake, all while executing than any individual tool. It’s incredibly fast! tens or hundreds of times faster 3. Prospector https://github.com/PyCQA/prospector Inspects Python source files and provides information about type and location of classes, methods etc. It brings together the functionality of other Python analysis tools such as Pylint, pycodestyle, and McCabe complexity. See the documentation section for a complete list. Supported Tools How to run You can run checkers on your computer from time to time, but it's not the best option, as there is a risk of forgetting to do so. It's better to implement auto checkers (see below) first and have the option to run them directly as a more convenient way to debug. directly Using on your computer, you can prevent committing unchecked code, which is convenient. However, don't forget to set up the pre-commit hook right after cloning a repository. pre-commit Using a (in GitHub Actions or GitLab CI/CD) is the most reliable way to check code, no matter where it came from. dedicated CI step Conclusion Static analysis tools for Python code are essential for catching defects early in the development process. Integrating these tools into your workflow can save time and improve code quality, leading to a better end product. I think at least a general code formatter ( or ) and a type checker (I prefer ) should be used for any projects. The earlier you configure them, the less time you will spend fixing problems in the future. Black YAPF mypy References Lint (software) - Wikipedia Martin Fowler - CodeSmell Cyclomatic complexity - Wikipedia Halstead complexity measures - Wikipedia Videos Here is some additional video material about the tools that I mentioned in this article. Black Łukasz Langa - Life Is Better Painted Black, or: How to Stop Worrying and Embrace Auto-Formatting Pyre Pieter Hooimeijer - Types, Deeper Static Analysis, and you Pytype Nathaniel Manista - How I Fell In Love With Pytype & Why You Should Too

This story contains new, firsthand information uncovered by the writer.

The writer is smart, but don't just like, take their word for it. #DoYourOwnResearch before making any investment decisions or decisions regarding you health or security. (Do not regard any of this content as professional investment advice, or health advice)

Python Static Analysis Tools: Clean Your Code Before Running

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Untitled Story

Asyncio: How to Say Goodbye Without Losing Your Data

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

Asyncio: How to Say Goodbye Without Losing Your Data

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps