python-code-style.rst

Style

Table of Contents

• Naming
  • Class
  • Function
  • Variable

Naming

Class

Bad

class fooClass: ...
class foo_class: ...

Good

class FooClass: ...

Function

Bad

def CapCamelCase(*a): ...
def mixCamelCase(*a): ...

Good

def func_separated_by_underscores(*a): ...

Variable

Bad

FooVar = "CapWords"
fooVar = "mixedCase"
Foo_Var = "CapWords_With_Underscore"

Good

# local variable
var = "lowercase"

# internal use
_var = "_single_leading_underscore"

# avoid conflicts with Python keyword
var_ = "single_trailing_underscore_"

# a class attribute (private use in class)
__var = " __double_leading_underscore"

# "magic" objects or attributes, ex: __init__
__name__

# throwaway variable, ex: _, v = (1, 2)
_ = "throwaway"