autopep8

2.3.2 · active · verified Thu Apr 09

autopep8 is a tool that automatically formats Python code to conform to the PEP 8 style guide. It fixes most PEP 8 issues that can be automatically fixed. Currently at version 2.3.2, it maintains an active release schedule with several updates per year addressing bug fixes, new Python version support, and rule enhancements.

Warnings

breaking Python version compatibility has changed. autopep8 v2.3.2 dropped support for Python 3.8 and now requires Python 3.9+. Previous versions like v2.1.0 dropped Python 3.7 support.
Fix: Ensure your Python environment meets the minimum requirement (Python 3.9+ for latest autopep8). If you need to support older Python versions, pin autopep8 to a compatible older release (e.g., `<2.3.2` for Python 3.8).
deprecated The `--experimental` command-line option was deprecated in autopep8 v2.2.0.
Fix: Remove the `--experimental` option from your `autopep8` commands or configurations. Functionality that was previously experimental might now be enabled by default or handled through different options (e.g., `--aggressive`).
gotcha autopep8 has a direct dependency on `pycodestyle`, and specific versions of `autopep8` might require a minimum version of `pycodestyle`. For instance, autopep8 v2.3.0 requires `pycodestyle v2.12.0+`.
Fix: When upgrading `autopep8`, it's recommended to upgrade `pycodestyle` simultaneously or ensure you meet the minimum required version. Use `pip install --upgrade autopep8 pycodestyle`.
gotcha autopep8 uses `pyproject.toml` (under `[tool.autopep8]`) or `setup.cfg` (under `[autopep8]`) for configuration. It does not look for a dedicated `.autopep8` or `autopep8.cfg` file.
Fix: If you are migrating from other tools or expecting a dedicated configuration file, place your autopep8 options within your `pyproject.toml` or `setup.cfg` file under the appropriate section.
gotcha autopep8 fixes most, but not all, PEP 8 issues automatically. The `--aggressive` option (which can be specified multiple times for higher levels of aggressiveness) is required for certain complex fixes, but even then, some issues might require manual intervention.
Fix: Understand the limitations of automatic formatting. Start without `--aggressive`, then try `--aggressive` or `--aggressive --aggressive` if more issues persist. Always review changes made by automated tools.

Install

pip install autopep8 Install autopep8

Imports

fix_code
```
import autopep8
fixed_code = autopep8.fix_code(source, options={})
```
Primary function for programmatic code fixing. The 'options' argument expects a dictionary or an argparse.Namespace object.

Quickstart

Demonstrates programmatic use of `autopep8.fix_code` with default and custom options. It also mentions the common command-line interface usage.

import autopep8

# Sample code with PEP8 violations
source_code = """
def   my_func ( arg1 ,  arg2 ):
    if (True): # E712 comparison to True
        return arg1+arg2
"""

print("Original code:")
print(source_code)

# Fix the code with default options
# An empty dictionary for options applies default autopep8 behavior.
fixed_code = autopep8.fix_code(source_code, options={})
print("\nFixed code (default options):")
print(fixed_code)

# Fix with specific options, e.g., higher aggressiveness
# Note: Certain fixes (like E712) may require higher aggressive levels.
options_aggressive = {'aggressive': 1}
fixed_code_aggressive = autopep8.fix_code(source_code, options=options_aggressive)
print("\nFixed code (aggressive=1):")
print(fixed_code_aggressive)

# Command line usage example (run in your shell):
# echo "def   my_func ( arg1 ,  arg2 ):\n    return arg1+arg2" > example.py
# autopep8 --in-place example.py
# cat example.py # Will show the formatted code

view raw JSON →