Concise Python Naming Standards

  • Name your classes and functions consistently; the convention is:
    • to use CamelCase for classes and
    • lower_case_with_underscores for functions and methods.
    • Always use self as the name for the first method argument.
  • Use spaces around operators and after commas, but not directly inside bracketing constructs:

    a = f(1, 2) + g(3, 4).

  • 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.

  • Don’t use fancy encodings if your code is meant to be used in international environments. Plain ASCII works best in any case.

 

Source : https://docs.python.org/2.7/tutorial/controlflow.html#intermezzo-coding-style

Excellent resource: https://google.github.io/styleguide/pyguide.html

Leave a Reply

Your email address will not be published. Required fields are marked *