Python
Style Guide

Why?

• Improve readability/understanding
• Ensure (cross-)functionality

Important

Naming

• Stick to PEP 8 when you
• lowercase package & module names
• CamelCase classes
• lower_case methods and attributes
• UPPER_CASE constants
• Use underscore prefix for _internal_attributes
• Use underscore suffix to resolve naming conflicts:
  class_ > cls
• Indent with 4 spaces, not tabs!

New-Style Classes and super

						class A:
						    def __init__(self):
						        pass

						class B(A):
						    def __init__(self):
						        A.__init__()
						        pass
					

						class A(object):
						    def __init__(self):
						        pass

						class B(A):
						    def __init__(self):
						        super(B, self).__init__()
						        pass
					

Initialize Class attributes

						class C(B):
						    def __init__(self):
						        super(C, self).__init__()
						    def compute_result(self):
						        self.result = 1
					

						class C(B):
						    def __init__(self):
						        super(C, self).__init__()
						        self.result = None
						    def compute_result(self):
						        self.result = 1
					

Other

• Use Sphinx and reStructured Text notation for documentation
• Use unittest for testing
• Make packages pip-installable
• Follow Seb's Example Project

Nice to Have

• Keep namespaces clean, don't from X import *
• Use descriptive names (more writing = less confusion)
• Use __init__.py to improve your package's structure
  • __all__ = [...] specifies what from module import * imports
  • Don't force users to from dlmodule.models.UNet import UNet, instead put from UNet import UNet in the __init__.py for models

Resources

• Much of this guide was inspired by this one
• Seb's Python Example Project
• Hitchhiker's Guide to Python
• Python Style Guide (PEP 8)