PyCQA/isort
Isort
isort is a Python import sorter and code formatter that organizes import statements into alphabetical groups and sections. It functions as both a utility to automatically rearrange imports for a consistent layout and as a linting tool to verify if code follows specific ordering rules.
The project provides configurable layout settings for indentation, wrapping modes, and section ordering to ensure compliance with project style guides and PEP 8. It allows for the exclusion of specific lines or files through inline comments and docstrings.
The tool integrates into development workflows via IDE and editor plugins and functions as a pre-commit hook for quality assurance within git workflows. It includes syntax validation to ensure that modifications to source code do not introduce errors.
Features
- Import Organizers - Automatically sorts, cleans, and organizes Python import statements to maintain project consistency.
- Import Sorters - Automatically organizes and sorts Python import statements using configurable ordering and wrapping styles.
- Import Order Linters - Verifies if Python import statements follow defined ordering rules and reports discrepancies.
- Python Source Formatters - Reformats Python source code imports to comply with project style guides and PEP 8.
- Import Order Validation - Functions as a linting tool to verify if code follows defined import ordering rules without altering the files.
- Layout Settings - Offers customizable indentation, wrapping modes, and section ordering to comply with specific project style guides.
- IDE Integrated Tooling - Embeds import sorting capabilities directly into the development environment to reduce context switching.
- IDE Plugins - Integrates with various text editors and IDEs to automate import sorting during the development process.
- AST-Based Analysis - Implements AST parsing to precisely target import statements without altering unrelated source code.
- Pre-commit Hooks - Provides integration for running import verification as part of a pre-commit quality workflow.
- Configuration-Driven Sorting - Determines import ordering based on a flexible hierarchy of project-specific settings and PEP 8 guides.
- Sequential Formatting Passes - Applies a series of discrete transformation rules through sequential passes over the source text.
- Syntax Validation Linters - Verifies that no syntax errors were introduced by running modified code through the Python parser.
- Code Analysis - Listed in the “Code Analysis” section of the Awesome Python awesome list.
- Code Analysis and Quality - Utility for automatically sorting and organizing imports.
- Code Formatters - Utility for automatically sorting and organizing import statements.
