Download as PDF, PPTX
Uploaded byJason Myers
Python Static Analysis Tools
This document provides a tour of various Python static analysis tools, including PEP8 for style guidelines, PyFlakes for unused names, Pyroma for checking setup.py files, PEP257 for docstring standards, Vulture for unused code, Pylint for code quality and standards, complexity metrics like McCabe and Halstead, maintainability index, Dodgy for security issues, Bandit also for security, Flake8 which wraps other tools, Prospector which runs multiple tools, and pre-commit for running checks before commit. It aims to help users choose the right tools to improve code quality, style, and health.
Python Static Analysis Tools
- 1. STATIC ANAYLSIS A TOUROF PYTHON TOOLS Created by Jason A Myers / @jasonamyers
- 2.
- 4.
- 5. PYFLAKES Names which areused but not defined or used before they are defined Names which are redefined without having been used
- 6. PYROMA Checks setup.py filesfor errors and issues
- 7. PEP257 Checks that docstringsmatch PEP257 standards
- 9.
- 10. PYLINT Looks at yourproject as a whole and reports back very detailed information on Code Standards, ineffecient code, errored implementation code, and duplicate code
- 11.
- 12. MCCABE/CYCLOMATIC COMPLEXITY Focuses ondecisions made in software
- 13. HALSTEAD COMPLEXITY Focuses onVolume, Difficulty, and Effort
- 15. MAINTAINABILITY INDEX Focuses onease to support and change
- 16.
- 17.
- 19.
- 20.
- 21. FLAKE8 Flake8 is awrapper around these tools: PyFlakes, pep8, and McCabe.
- 22. PROSPECTOR RUN ALL THETHINGS! Combines: PyLint, PEP8, pyflakes, McCabe, dodgy, and PEP257 Optionally: Pyroma and Vulture
- 23. PRE-COMMIT Runs before iflets you create a commit on your machine
- 24.