Naming conventions¶

1. Class names should use CamelCase.

classTestClass(object):pass

2. No underscores in class names except for a leading underscore to as “private”.

class_PrivateTestClass(object):pass

3. Constants must be ALL_CAPS with an underscore separating the words.

CONSTANT_VALUE=True

4. Class attributes/properties/methods should be lower_case_with_underscores.

classTestClass(object):def__init__(self,value1,value2):self.value1=value1self._value2=value2@propertydefvalue2(self):returnself._value2defsome_method(self):returnself.value1+self.value2

5. Singleton objects or “the instance” objects (objects that should be the one and only instance of a class) should also use lower_case_with_underscores.

classTestClass(object):passtest_class=TestClass()

6. All global variable objects (which are not constants) should also use lower_case_with_underscores.

start_value=True

7. Any global variables created in the scope which are not to be imported by other modules should use a leading underscore.

_private_variable=False

8. Never use two leading and/or two trailing underscores.

9. All names should be very descriptive as to what the object does or is.

Formatting¶

1. Lines must be no longer than 80 characters (that includes the built-in \n, making it 79 characters of code).

2. Must use 4 space indentation, no TABs.

3. Must have 2 blank lines prior to functions and classes.

• If the function/class is starting a new <Section> (explained below), the blank lines need to be prior to the section separator.

4. All other lines should only have 1 blank line between.

• An exception that is sometimes used is 2 blank lines prior to a <Section> change (explained below)

5. No extra whitespace at the end of a line.

• This also means that any “blank” lines should have absolutely nothing, not even spaces, in them.

6. Exactly 1 space between arguments (after the comma) for all functions/classes/methods, including when calling them.

• No leading space before first argument or trailing space after last argument.

7. Exactly one space after a colon (:) when setting an item in a dictionary.

8. There must be exactly one blank line at the end of the file.

Documentation¶

1. All classes/methods/properties/functions must be followed by a comment using a triple quote docstring (using quotes and not apostrophes).

2. Most lines of code should follow a one line comment (using the # character).

• Some exceptions apply, like comments that suffice for multiple lines.

3. Files should always start with this line.

# ../<path from source-python directory>

4. Different sections of code should be separated by the following lines (where <Section> should describe what is in the following section).

# =============================================================================# >> <Section># =============================================================================

• Some examples of what <Section> types there are to be used:

  • IMPORTS

  • GLOBAL VARIABLES

  • CLASSES

  • FUNCTIONS

Import comments¶

1. Separate base Python imports (including site-packages) from Source.Python imports with 1 blank line.

2. Use a comment line with 1 space after the # showing whether the current section is from Python or Source.Python.

3. Python imports should always go first, then Source.Python imports.

4. Separate each module by using a comment about which module is being imported (with 3 spaces after the # before the modules name).

5. Modules should be listed in alphabetic order.

Example:

# =============================================================================# >> IMPORTS# =============================================================================# Python Imports#   ConfigobjfromconfigobjimportConfigObj#   OSfromos.pathimportdirnamefromos.pathimportjoin#   Tracebackfromtracebackimportformat_exception# Source.Python Imports#   Corefromcore.versionimportis_newer_version_availablefromcore.versionimportVERSION#   EventsfromeventsimportEvent#   PathsfrompathsimportGAME_PATH

Do’s and don’ts of importing¶

1. Never import “all” from a module.

# Badfromsomethingimport*# Goodfromsomethingimportone_objectfromsomethingimportsecond_object

2. For “most” imports, import each object individually, and on a separate line.

# Badfromos.pathimportdirname,join,curdir# Goodfromos.pathimportdirnamefromos.pathimportjoinfromos.pathimportcurdir# "Ok", but use only when necessaryimportos.pathimportsys