ambv/black
Black
Black is a deterministic Python code formatter and style guide enforcer. It automatically reformats source code and Jupyter notebook cells into a consistent style to eliminate manual debates over code layout and reduce noise in version control diffs.
The tool uses abstract syntax tree analysis to restructure code layout while ensuring that the underlying functional logic remains unchanged. It employs a deterministic engine that produces a single consistent output for any given input, removing subjective styling choices.
The system provides capabilities for in-place file mutation, automated style enforcement across entire projects, and the use of configuration files to define line lengths and excluded file patterns. It further verifies code integrity by comparing the abstract syntax trees of the original and reformatted code to ensure functional equivalence.
Features
- Deterministic Formatters - Employs a deterministic engine that produces a single consistent output for any given input.
- Code Formatting - Provides automatic code formatting and style enforcement specifically for the Python language.
- AST Transformation Tools - Uses abstract syntax tree analysis to restructure code layout without altering functional logic.
- AST-Based Formatters - Analyzes the Python abstract syntax tree to ensure functional logic remains unchanged while altering code layout.
- Equivalence Verifiers - Compares the AST of original and reformatted code to ensure no functional changes were introduced.
- Code Formatters - Automatically adjusts Python source code structure and style to maintain a consistent, deterministic appearance.
- Concrete Syntax Tree Generators - Utilizes concrete syntax trees to ensure formatting preserves all necessary structural information during the round-trip.
- Python Source Formatters - Automatically reformats Python source files in place to ensure consistency with a standardized style guide.
- Equivalence Verifiers - Verifies that generated code maintains functional and structural parity with the original source using AST comparison.
- Coding Standards Enforcement - Provides an automated system for maintaining project guidelines and eliminating debates over code layout.
- Deterministic Style Standards - Enforces a deterministic style to ensure a uniform appearance and reduce noise during version control reviews.
- Style Guide Enforcers - Eliminates manual style debates by enforcing a single, deterministic standard across all Python files.
- Notebook Formatters - Applies consistent styling and formatting to interactive Jupyter notebook files.
- Notebook Formatting Tools - Applies consistent code formatting to individual cells within Jupyter notebook files.
- In-Place File Mutators - Writes reformatted content directly back to the source files to update the codebase on disk.
- Style-Based Diff Cleanup - Removes stylistic noise from git diffs by ensuring all code follows a deterministic and uniform format.
- Formatter Rule Schemas - Provides the ability to define project-specific defaults and file patterns via a configuration file.
- Formatter Configurations - Supports external configuration files to define project-specific line lengths and excluded patterns.
- Code Editors and IDEs - Uncompromising automatic formatter for Python source code.
