Naming conventions - cma-open/cmatools GitHub Wiki

Modules

• should have short, all-lowercase names.
• Underscores can be used in the module name if it improves readability.
• e.g. midas_reader.py

Python packages (and subpackages)

• should have short, all-lowercase names,
• the use of underscores is discouraged.
• e.g. cmatools

Class names

• Class names should normally use the CapWords convention.
• e.g. ObservationMetadata

Global variables names

• for use within one module
• prefix with an underscore to indicate these are module non-public, or follow convention for functions
• e.g. global_variable_name
• e.g. _non_public_global_variable_name

Class variable names

• lowercase, with words separated by underscores as necessary to improve readability.
• e.g. class_variable_name

Function names

• lowercase, with words separated by underscores as necessary to improve readability.
• e.g. function_name

Variable names

• lowercase, with words separated by underscores as necessary to improve readability.
• e.g.variable_name

Method names

• lowercase with words separated by underscores as necessary to improve readability.
• e.g. method_name

Instance variables

• lowercase with words separated by underscores as necessary to improve readability.
• e.g. instance_variable_name

Constants (module constants or class constants)

• usually defined on a module level and written in all capital letters with underscores separating words.
• e.g.MAX_OVERFLOW

Source: https://www.python.org/dev/peps/pep-0008/#package-and-module-names