autopep8 Documentation

You can install or upgrade autopep8 using pip. It is recommended to use the --user option if you do not want to install it globally.

$ pip install --upgrade autopep8

To ensure you are testing against the latest version of autopep8 when reporting bugs, upgrade using the following command:

$ pip install --upgrade git+https://github.com/hhatto/autopep8

Before submitting a pull request:

1. Verify that the issue is not a pycodestyle bug. If it is, file the PR at the pycodestyle repository.
2. Add a test case to test/test_autopep8.py that demonstrates your changes.
3. Ensure all existing tests pass.

To use autopep8 as a pre-commit hook, add the following to your .pre-commit-config.yaml file:

repos:
-   repo: https://github.com/hhatto/autopep8
    rev: ...  # select the tag or revision you want
    hooks:
    -   id: autopep8

You can disable autopep8 for specific sections of a file by using # autopep8: off and re-enabling it with # autopep8: on. Alternatively, # fmt: off and # fmt: on are also valid markers.

# autopep8: off
    [
        [23, 23, 13, 43],
        [32, 34, 34, 34],
        [56, 34, 34, 11],
        [10, 10, 10, 10],
    ]
# autopep8: on

autopep8 searches for configuration in several locations:

1. Global Config: $HOME/.config/pycodestyle (or ~/.pycodestyle on Windows). You can also specify a custom global file using --global-config.
2. Project Config: setup.cfg, tox.ini, .pep8, or .flake8 in the directory of the target file. These can use the [pycodestyle], [pep8], or [flake8] sections.
3. pyproject.toml: Uses the [tool.autopep8] section. This takes precedence over all other configuration files.

[tool.autopep8]
max_line_length = 120
ignore = "E501,W6"  # or ["E501", "W6"]
in-place = true
recursive = true
aggressive = 3

You can add custom formatting rules to autopep8 by defining functions in the module with the pattern fix_<code_name>(source).

• The function must take source as an argument.
• It must return the fixed source code.
• These functions are automatically picked up by apply_global_fixes().

For fixes that depend on pycodestyle, you should add them as methods to the FixPEP8 class.

If you encounter pkg_resources.DistributionNotFound while running autopep8, it is likely due to an outdated version of setuptools. Upgrade setuptools to resolve this issue.

$ pip install --upgrade setuptools

When submitting a bug report, ensure the issue is not actually a bug in pycodestyle. If pycodestyle is behaving incorrectly, file the report at the pycodestyle repository instead.

For an autopep8 bug report, please include:

1. autopep8 --version output
2. pycodestyle --version output
3. python --version output
4. uname -a (if on Unix)
5. The example input that causes the bug
6. The autopep8 command-line options used
7. The expected output
8. Confirmation that the bug persists on the latest version

To automatically format a file and save the changes directly to the file, use the --in-place flag. Adding --aggressive multiple times increases the level of non-whitespace changes applied.

$ autopep8 --in-place --aggressive --aggressive <filename>