Like most Python projects, we try to adhere to PEP 8 (Style Guide for Python Code) and PEP 257 (Docstring Conventions) with the modifications documented here. Be sure to read all documents if you intend to contribute code to ObsPy.
As with numpy.ndarrays or Python lists, we try to reduce the memory consumption by using references where ever possible. In the following example a is appended to b as reference, that is the reason why b get changed when we change a:
>>> a = [1, 2, 3, 4] >>> b = [5, 6] >>> b.append(a) >>> a = -99 >>> print b [5, 6, [-99, 2, 3, 4]]
>>> import numpy as np >>> import matplotlib.pylab as plt
Names to Avoid
|Instance Variables||lower_with_under||_lower_with_under (protected) or __lower_with_under (private)|
|Methods||mixedCase()||_mixedCase() (protected) or __mixedCase() (private)|
One-liner: both """ are in new lines
def someMethod(): """ This is a one line doc string. """ print "test"
Multiple lines: both """ are in new lines - also you should try provide a meaningful one-liner description at the top, followed by two linebreaks with further text.
def someMethod(): """ This is just the short story. The long story is, this docstring would not have been able to fit in one line. Therefore we have to break lines. """ print "test"
In docstrings which annotate functions and methods, the following reStructuredText fields are recognized and formatted nicely:
The field names must consist of one of these keywords and an argument (except for returns and rtype, which do not need an argument). This is best explained by an example:
def formatException(etype, value, tb, limit=None): """ Format the exception with a traceback. :param etype: exception type :param value: exception value :param tb: traceback object :param limit: maximum number of stack frames to show :type limit: integer or None :rtype: list of strings :return: Traceback messages. """
which renders like this:
Format the exception with a traceback.
list of strings
test methods names must start with test_ followed by a mixedCase part
Tests which are expected to fail, because there is a known/unfixed bug should be commented with an XXX: followed by an valid ticket number, e.g.
def test_doSomething(): """XXX: This test does something. But fails badly. See ticket #number. """ print "test" ... # XXX: here it fails ...