Python Best Practices: using pep8
PEP 8 or Python Enhancement Proposal #8 is the Style Guide propose to write Python code.
This is not enforced by the Python compiler or any runtime, but the Python Community encouraged to use it to keep your code consistent with the rest of the Python ecosystem (Community, libraries, examples, etc).
The Style Guide can be divided into these big pieces:
This is rules about how the code should be written in a file. Indentation, spaces, blank lines, etc
How to use quotes for strings
When and how to use whitespaces with operators
When and how to use trailing commas
How to properly comment your code
The naming of module members, class members, variables, etc
General Recommendations to write Python readable code
When not to use PEP8
However, know when to be inconsistent — sometimes style guide recommendations just aren’t applicable. When in doubt, use your best judgment. Look at other examples and decide what looks best. And don’t hesitate to ask!
In particular: do not break backward compatibility just to comply with this PEP!
Some other good reasons to ignore a particular guideline:
- When applying the guideline would make the code less readable, even for someone who is used to reading code that follows this PEP.
- To be consistent with surrounding code that also breaks it (maybe for historic reasons) — although this is also an opportunity to clean up someone else’s mess (in true XP style).
- Because the code in question predates the introduction of the guideline and there is no other reason to be modifying that code.
- When the code needs to remain compatible with older versions of Python that don’t support the feature recommended by the style guide.
Tools for checking Style:
Linter tool that runs several checks as Syntaxis check, Circular dependencies, and Pep 8 style
Just check for pep8 style guidelines
Check syntaxis as other styles guidelines like unused imports