Tool to convert Python code to be PEP8 compliant

by

You can use autopep8! Whilst you make yourself a cup of coffee this tool happily removes all those pesky PEP8 violations which don’t change the meaning of the code.

Install it via pip:

pip install autopep8

Apply this to a specific file:

autopep8 py_file --in-place

or to your project (recursively), the verbose option gives you some feedback of how it’s going:

autopep8 project_dir --recursive --in-place --pep8-passes 2000 --verbose

Note: Sometimes the default of 100 passes isn’t enough, I set it to 2000 as it’s reasonably high and will catch all but the most troublesome files (it stops passing once it finds no resolvable pep8 infractions)…

At this point I suggest retesting and doing a commit!

If you want “full” PEP8 compliance: one tactic I’ve used is to run autopep8 as above, then run PEP8, which prints the remaining violations (file, line number, and what):

pep8 project_dir --ignore=E501

and manually change these individually (e.g. E712s – comparison with boolean).

Note: autopep8 offers an --aggressive argument (to ruthlessly “fix” these meaning-changing violations), but beware if you do use aggressive you may have to debug… (e.g. in numpy/pandas True == np.bool_(True) but not True is np.bool_(True)!)

You can check how many violations of each type (before and after):

pep8 --quiet --statistics .

Note: I consider E501s (line too long) are a special case as there will probably be a lot of these in your code and sometimes these are not corrected by autopep8.

As an example, I applied this technique to the pandas code base.

More Related Contents:

  1. Python `if x is not None` or `if not x is None`? [closed]
  2. How to break a line of chained methods in Python?
  3. Line continuation for list comprehensions or generator expressions in python
  4. Why does PEP-8 specify a maximum line length of 79 characters? [closed]
  5. Best way to return multiple values from a function? [closed]
  6. Should import statements always be at the top of a module?
  7. Single quotes vs. double quotes in Python [closed]
  8. Should I always specify an exception type in `except` statements?
  9. Dictionaries and default values
  10. What are the most common Python docstring formats? [closed]
  11. Why does Python pep-8 strongly recommend spaces over tabs for indentation? [closed]
  12. Python exception chaining [duplicate]
  13. In Python, is it better to use list comprehensions or for-each loops?
  14. Why use def main()? [duplicate]
  15. How to write very long string that conforms with PEP8 and prevent E501
  16. Should I use `import os.path` or `import os`?
  17. python close file descriptor question
  18. Python import mechanics
  19. What does ‘# noqa’ mean in Python comments?
  20. Alternatives for returning multiple values from a Python function [closed]
  21. Is nested function a good approach when required by only one function? [closed]
  22. Creating an empty list in Python
  23. In Python, when should I use a function instead of a method?
  24. Pylint, PyChecker or PyFlakes? [closed]
  25. Is making in-place operations return the object a bad idea?
  26. Python coding standards/best practices [closed]
  27. Attributes initialization/declaration in Python class: where to place them?
  28. What is the recommended way to break a long if statement? (W504 line break after binary operator)
  29. How can we force naming of parameters when calling a function?
  30. Length of longest word in a list

Leave a Comment