How to write a pep8 configuration (pep8.rc) file?

python pep8 pep
Aditya Srivastava picture Aditya Srivastava · May 18, 2015 · Viewed 10.9k times · Source

I found the documentation for pep8 but wasn't able to understand how to write these. I couldn't even find any examples with options other than setting max-line-length and ignore.

I am trying to write a .pep8.rc file in which, among other things, I need to do the following:

  • enable show source
  • enable statistics
  • enable count
  • exclude a directory (say, for example ./random)

Can somebody answer with an example or link to one?

Answer

Andy Hayden picture Andy Hayden · Dec 17, 2015

The preferred way is to use a setup.cfg in the top-level of the project (.cfg has the same syntax as a .ini file), which should contain a [pep8] section. For example:

[pep8]
ignore = E226,E302,E41
max-line-length = 160

Note: the error codes are defined in the pep8 docs.

Related questions

Triple-double quote v.s. Double quote

What is the preferred way to write Python doc string? """ or " In the book Dive Into Python, the author provides the following example: def buildConnectionString(params): """Build a connection string from a dictionary of parameters. Returns string.""" In another chapter, …

Read More
What PEP 8 guidelines do you ignore, and which ones do you stick to?

Over the years, the more Python I write, the more I find myself agreeing with most of the guidelines, though I consistently and intentionally break some for my own reasons. I'd be curious to know what in PEP 8 (or other …

Read More
Python PEP 8: Blank lines at the beginning of a module

There is a question who treat about this but not talk about all the points I interested. PEP 8 says about blank lines: Separate top-level function and class definitions with two blank lines. Then if you have: A module with only …

Read More