Skip to main content

PEP

PEP-0 - Python Enhancement Proposals

PEP-20 - Zen of Python (import this)

https://www.python.org/dev/peps/pep-0001/#what-is-a-pep

https://www.python.org/dev/peps/pep-0020 (The Zen of Python)

PEP-8 - Python Style Guide

For Python, PEP 8 has emerged as the style guide that most projects adhere to; it promotes a very readable and eye-pleasing coding style. Every Python developer should read it at some point; here are the most important points extracted for you:

  • Use 4-space indentation, and no tabs. 4 spaces are a good compromise between small indentation (allows greater nesting depth) and large indentation (easier to read). Tabs introduce confusion, and are best left out.
  • Wrap lines so that they don't exceed 79 characters. This helps users with small displays and makes it possible to have several code files side-by-side on larger displays.
  • Use blank lines to separate functions and classes, and larger blocks of code inside functions.
  • When possible, put comments on a line of their own.
  • Use docstrings.
  • Use spaces around operators and after commas, but not directly inside bracketing constructs:a=f(1,2)+g(3,4).
  • Name your classes and functions consistently; the convention is to useCamelCasefor classes andlower_case_with_underscoresfor functions and methods. Always useselfas the name for the first method argument (see A First Look at Classes for more on classes and methods).
  • Don't use fancy encodings if your code is meant to be used in international environments. Python's default, UTF-8, or even plain ASCII work best in any case.
  • Likewise, don't use non-ASCII characters in identifiers if there is only the slightest chance people speaking a different language will read or maintain the code.