google/yapf
Yapf
YAPF is a Python code formatter and style compliance tool. It operates as an AST-based reformatter that uses concrete syntax trees to ensure structural consistency and a uniform visual presentation across source files.
The engine utilizes a penalty-based layout optimizer to determine the best line breaks by calculating numerical costs for different formatting choices. It employs a multi-process code processor to distribute the formatting of multiple files across several CPU cores.
The tool covers source code reformatting through in-place file modifications, difference analysis, and the processing of partial code fragments. It includes a rule-based configuration system for managing style presets, layout rules, and project-level settings.
Integration capabilities include style compliance verification for continuous integration pipelines, git hook automation, and editor-based format-on-save functionality.
Features
- Python Code Formatters - Reformats Python source code to adhere to defined style guides for consistent visual presentation.
- Penalty-Based Layout Optimizers - Implements a penalty-based layout optimizer to determine the most aesthetically pleasing line breaks based on numerical costs.
- Formatting Processors - Employs a recursive descent pattern to traverse the code tree and determine the optimal layout of nested elements.
- AST-Based Formatters - Uses concrete syntax tree analysis to restructure code layout while preserving functional logic.
- Style Rule Configurations - Provides a rule-based configuration system for defining how specific Python constructs should be formatted.
- Python Development Tools - Provides productivity utilities for the Python ecosystem, including automatic code reformatting.
- Layout Rule Definitions - Defines specific layout rules for indentation and line length to ensure visual consistency.
- Source Code Formatters - Automatically reformats Python source code to adhere to a standardized style guide for consistent presentation.
- Style Compliance Checkers - Includes a check-only mode to verify style compliance without modifying files, suitable for continuous integration pipelines.
- Project Configuration Management - Manages formatting and ignore configurations at the project level to ensure consistency across teams.
- Concrete Syntax Tree Transformations - Reconstructs source code by modifying concrete syntax tree representations while preserving the original structural integrity.
- Formatting Behavior Adjustments - Adjusts the layout behavior for Python expressions, lists, and dictionaries using style flags and penalties.
- Git Style Verifiers - Verifies style compliance within git diffs and automates formatting during commit events.
- In-Place File Mutators - Supports updating source files directly on disk with the reformatted version.
- Large-Scale Style Maintenance - Maintains consistent formatting and style across extremely large software repositories using parallel processing.
- Concrete Syntax Tree Generators - Uses concrete syntax trees to maintain high fidelity to the original source code structure during the formatting process.
- Continuous Integration Checks - Executes formatting checks within automated pipelines to identify style violations during pull requests.
- Formatting Exclusion Markers - Provides inline markers that allow developers to exclude specific blocks of code from being reformatted.
- Multi-Process Parallelism - Utilizes multi-process parallelism to distribute the formatting workload across multiple CPU cores for faster execution on large projects.
- Partial Fragment Formatting - Processes specific line ranges or fragments of code to support targeted formatting updates.
- Parallel Processing - Improves performance by distributing the formatting of multiple Python files across several CPU cores.
- Style Presets - Provides named style presets and configuration files to control code indentation and spacing.
- Textual Difference Analysis - Identifies textual differences between the current source and the proposed formatted version without applying changes.
- Code Formatters - Configurable formatter that reformats code to follow best practices.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
