autopep8

https://pypi.org/project/autopep8/
Admin
autopep8 is a Python tool that automatically formats code to conform to the PEP 8 style guide using...
Tokens:3,288
Snippets:45
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install autopep8 via pip

Source: https://pypi.org/project/autopep8/2.3.2

Use this command to install or upgrade the autopep8 package in your Python environment.

```bash
$ pip install --upgrade autopep8
```

--------------------------------

### Python code before autopep8 formatting

Source: https://pypi.org/project/autopep8/2.3.2

Example of unformatted Python code containing inconsistent spacing, deprecated methods, and poor indentation.

```python
import math, sys;

def example1():
    ####This is a long comment. This should be wrapped to fit within 72 characters.
    some_tuple=(   1,2, 3,'a'  );
    some_variable={'long':'Long code lines should be wrapped within 79 characters.',
    'other':[math.pi, 100,200,300,9876543210,'This is a long string that goes on'],
    'more':{'inner':'This whole logical line should be wrapped.',some_tuple:[1,
    20,300,40000,500000000,60000000000000000]}}
    return (some_tuple, some_variable)
def example2(): return {'has_key() is deprecated':True}.has_key({'f':2}.has_key(''));
class Example3(   object ):
    def __init__    ( self, bar ):
     #Comments should have a space after the hash.
     if bar : bar+=1;  bar=bar* bar   ; return bar
     else:
                    some_string = """
                       Indentation in multiline strings should not be touched.
Only actual code should be reindented.
"""
                    return (sys.path, some_string)
```

--------------------------------

### Upgrade setuptools

Source: https://pypi.org/project/autopep8/2.3.2

Upgrade setuptools to resolve potential DistributionNotFound errors.

```bash
$ pip install --upgrade setuptools
```

--------------------------------

### Run autopep8 with experimental features

Source: https://pypi.org/project/autopep8/2.3.2

Enable experimental functionality such as advanced line shortening.

```bash
$ autopep8 --experimental <filename>
```

--------------------------------

### Run autopep8 with specific rules

Source: https://pypi.org/project/autopep8/2.3.2

Use the --select option to apply only a subset of formatting fixes.

```bash
$ autopep8 --select=E1,W1 <filename>
```

--------------------------------

### Configure autopep8 with pyproject.toml

Source: https://pypi.org/project/autopep8/2.3.2

Use the [tool.autopep8] section in pyproject.toml for project-specific configuration.

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

--------------------------------

### Configure autopep8 with pycodestyle

Source: https://pypi.org/project/autopep8/2.3.2

Define formatting rules in a pycodestyle configuration file.

```ini
[pycodestyle]
max_line_length = 120
ignore = E501
```

--------------------------------

### Run autopep8 with verbose output

Source: https://pypi.org/project/autopep8/2.3.2

Enable verbose progress messages for large files.

```bash
$ autopep8 -v <filename>
```

--------------------------------

### autopep8 command-line options

Source: https://pypi.org/project/autopep8/2.3.2

List of available flags and arguments for the autopep8 command-line interface.

```text
usage: autopep8 [-h] [--version] [-v] [-d] [-i] [--global-config filename]
                [--ignore-local-config] [-r] [-j n] [-p n] [-a]
                [--experimental] [--exclude globs] [--list-fixes]
                [--ignore errors] [--select errors] [--max-line-length n]
                [--line-range line line] [--hang-closing] [--exit-code]
                [files [files ...]]

Automatically formats Python code to conform to the PEP 8 style guide.

positional arguments:
  files                 files to format or '-' for standard in

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -v, --verbose         print verbose messages; multiple -v result in more
                        verbose messages
  -d, --diff            print the diff for the fixed source
  -i, --in-place        make changes to files in place
  --global-config filename
                        path to a global pep8 config file; if this file does
                        not exist then this is ignored (default:
                        ~/.config/pep8)
  --ignore-local-config
                        don't look for and apply local config files; if not
                        passed, defaults are updated with any config files in
                        the project's root directory
  -r, --recursive       run recursively over directories; must be used with
                        --in-place or --diff
  -j n, --jobs n        number of parallel jobs; match CPU count if value is
                        less than 1
  -p n, --pep8-passes n
                        maximum number of additional pep8 passes (default:
                        infinite)
  -a, --aggressive      enable non-whitespace changes; multiple -a result in
                        more aggressive changes
  --experimental        enable experimental fixes
  --exclude globs       exclude file/directory names that match these comma-
                        separated globs
  --list-fixes          list codes for fixes; used by --ignore and --select
  --ignore errors       do not fix these errors/warnings (default:
                        E226,E24,W50,W690)
  --select errors       fix only these errors/warnings (e.g. E4,W)
  --max-line-length n   set maximum allowed line length (default: 79)
  --line-range line line, --range line line
                        only fix errors found within this inclusive range of
                        line numbers (e.g. 1 99); line numbers are indexed at
                        1
```

--------------------------------

### Integrate autopep8 with pre-commit

Source: https://pypi.org/project/autopep8/2.3.2

Add autopep8 as a hook in your pre-commit configuration.

```yaml
repos:
-   repo: https://github.com/hhatto/autopep8
    rev: ...  # select the tag or revision you want, or run `pre-commit autoupdate`
    hooks:
    -   id: autopep8
```

--------------------------------

### Run autopep8 with aggressive options

Source: https://pypi.org/project/autopep8/2.3.2

Use the --aggressive flag to enable fixes that may change program behavior, such as E711 and E712.

```bash
$ autopep8 --aggressive <filename>
```

--------------------------------

### Use autopep8 as a module

Source: https://pypi.org/project/autopep8/2.3.2

Programmatically format code using the fix_code function.

```python
>>> import autopep8
>>> autopep8.fix_code('x=       123\n')
'x = 123\n'
```

```python
>>> import autopep8
>>> autopep8.fix_code('print( 123 )\n',
...                   options={'ignore': ['E']})
'print( 123 )\n'
```

--------------------------------

### Modify file in place with aggressive formatting

Source: https://pypi.org/project/autopep8/2.3.2

Use the --in-place and --aggressive flags to apply formatting changes directly to the specified file.

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

--------------------------------

### Python code after autopep8 formatting

Source: https://pypi.org/project/autopep8/2.3.2

The same code snippet after being processed by autopep8, showing corrected PEP 8 style compliance.

```python
import math
import sys


def example1():
    # This is a long comment. This should be wrapped to fit within 72
    # characters.
    some_tuple = (1, 2, 3, 'a')
    some_variable = {
        'long': 'Long code lines should be wrapped within 79 characters.',
        'other': [
            math.pi,
            100,
            200,
            300,
            9876543210,
            'This is a long string that goes on'],
        'more': {
            'inner': 'This whole logical line should be wrapped.',
            some_tuple: [
                1,
                20,
                300,
                40000,
                500000000,
                60000000000000000]}}
    return (some_tuple, some_variable)


def example2(): return ('' in {'f': 2}) in {'has_key() is deprecated': True}


class Example3(object):
    def __init__(self, bar):
        # Comments should have a space after the hash.
        if bar:
            bar += 1
            bar = bar * bar
            return bar
        else:
            some_string = """
                       Indentation in multiline strings should not be touched.
Only actual code should be reindented.
"""
            return (sys.path, some_string)
```

--------------------------------

### Disable autopep8 formatting for code blocks

Source: https://pypi.org/project/autopep8/2.3.2

Use comments to toggle autopep8 formatting off and on for specific sections of code.

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