Appion

h1. Python Coding Standards

This document is a list of python coding standards. To add a new standard copy the template below and modify it.

----

h2. +Name of Coding Standard+

h3. Definition

What is the coding standard

h3. Justification

Why is the coding standard important

h3. Example

GOOD:<pre>

this is a good example code

</pre>

BAD:<pre>

this is a bad example code

</pre>

----

h1. Python Coding Standards for AMI

----

h2. +Checking beginning or ending of strings+

h3. Definition

Use ''.startswith() and ''.endswith() instead of string slicing to check for prefixes or suffixes.

h3. Justification

startswith() and endswith() are cleaner and less error prone.

h3. Example

GOOD:<pre>

if foo.startswith('bar'): 

</pre>

BAD:<pre>

if foo[:3] == 'bar':

</pre>

----

h2. +Never use @from module import *@+

h3. Definition

Never use @from module import *@, use @import module@ instead

h3. Justification

It is hard to track where functions come from when @import *@ is used

h3. Example

GOOD:<pre>

import numpy

a = numpy.ones((3,3))

</pre>

BAD:<pre>

from numpy import *

a = ones((3,3))

</pre>