psf/black
Black
This project is an uncompromising, deterministic code formatter for Python. It functions by parsing source code into an abstract syntax tree and regenerating it according to a rigid, opinionated set of style rules. By automating the formatting process, it eliminates manual style debates and configuration overhead, ensuring that code remains consistent across entire projects regardless of the original input.
The tool distinguishes itself through its focus on speed and seamless integration into development workflows. It utilizes content-based file caching and parallel processing to maintain high performance on large codebases, while supporting version control hooks to enforce style consistency before code is committed. To preserve project history, it provides mechanisms to ignore specific commits in version control blame tracking, ensuring that automated style changes do not obscure original authorship.
Beyond standard source files, the formatter extends its capabilities to include Jupyter notebooks, type stubs, and embedded code examples within documentation. It offers broad compatibility through plugins for major text editors and integrated development environments, as well as support for the language server protocol. Configuration is managed through project-level files that are automatically discovered within the directory hierarchy, allowing for consistent behavior across diverse development environments.
Features
- Code Formatters - Automatically enforces a strict, uniform style across source files.
- Python Development Tools - Provides an uncompromising, deterministic code formatter for the Python ecosystem.
- Automated Formatting Frameworks - Enforces a consistent style across a codebase by automatically applying opinionated rules to source files.
- Python Tooling - Applies opinionated style rules to Python source code, supporting customizable line lengths and target versions.
- VS Code Extensions - Automates code styling within VS Code via extensions.
- Parsers & Lexers - Parses and reconstructs source code according to predefined syntactic rules.
- Code Analysis - Listed in the “Code Analysis” section of the Awesome Python awesome list.
- Code Analysis and Quality - Uncompromising, opinionated code formatter.
- Code Formatters - Uncompromising and opinionated automatic code formatter.
- Code Quality Tools - Formats Python code automatically.
- Developer Tools - Uncompromising Python code formatter.
- Linting And Formatting - Uncompromising Python code formatter.
- Python Packages - Code formatting for Python.
- Notebook Formatting Tools - Applies consistent styling to Jupyter notebook files.
- Development Workflow Integrations - Connects automated styling tools directly into text editors and continuous integration pipelines.
- Language Server Protocols - Connects code editors to formatting tools using standard protocols.
- Git Hooks - Ensures only properly formatted code enters the repository history via pre-commit checks.
- Import Sorters - Aligns import sorting behavior with project style guidelines.
- Project Configuration Discovery - Defines project-specific formatting defaults and exclusion patterns in a configuration file that is automatically discovered.
- Notebook Automation Tools - Integrates notebook file processing into development workflows.
- Notebook Formatters - Applies consistent styling to interactive notebook files to improve readability.
- Build Caches - Stores results on disk to skip unmodified files and speed up workflows.
- Build Caching Systems - Stores hashes of processed files to skip redundant formatting operations and significantly improve performance on large codebases.
- File Exclusion Rules - Allows preventing specific files or directories from being modified.
- Line Wrapping Engines - Wraps long lines of code by applying uniform whitespace rules and bracket-based indentation.
- Version Control Ignore Parsers - Automatically skips files listed in version control ignore files.
- Version Control Utilities - Supports excluding specific commits from history tracking to preserve accurate code authorship during automated formatting.
