Naming of modules, classes, methods and variables in python

[AndrewSazonov]

For code consistency use PEP-8 style where the most important conventions are:

Module

Name should always be snake_small_caps (file tree)

• root_folder.first_folder
• Important to use underscore dandy_fine and minus never-ever. Python will give strange errors

Class

Name should be CamelCase for the individual words.

• BestClassEver

If acronym is part of the name it should be ALLCAPS

• SWATCodeIsTheBest

Methods and variables

Public methods and variables should be snake_small_caps.

Private methods and variables should have a leading underscore _private_method

Assume we have initialized an object of the MyClass:

my_obj = MyClass()
my_obj.public_method()
my_obj._private_method()  # A private method should not be used outside of the class
my_obj.public_variable
my_obj._private_variable  # A private variable should not be used outside of the class

Links to the original discussions: #13