4.3 KiB
Python Style Guide
This guide starts out with our general Python coding style guidelines and ends with a section on how we write & run (Python) tests.
General Python Coding Style Guidelines
Our starting point is PEP8, the standard "Style Guide for Python Code." Many Python IDEs will check your code against PEP8. (Note that PEP8 isn't frozen; it actually changes over time, but slowly.)
BigchainDB uses Python 3.4+, so you can ignore all PEP8 guidelines specific to Python 2.
Python Docstrings
PEP8 says some things about docstrings, but not what to put in them or how to structure them. PEP257 was one proposal for docstring conventions, but we prefer Google-style docstrings instead: they're easier to read and the napoleon extension for Sphinx lets us turn them into nice-looking documentation. Here are some references on Google-style docstrings:
- Google's docs on Google-style docstrings
- napoleon's docs include an overview of Google-style docstrings
- Example Google-style docstrings (from napoleon's docs)
Maximum Line Length
PEP8 has some maximum line length guidelines, starting with "Limit all lines to a maximum of 79 characters" but "for flowing long blocks of text with fewer structural restrictions (docstrings or comments), the line length should be limited to 72 characters."
We discussed this at length, and it seems that the consensus is: try to keep line lengths less than 79/72 characters, unless you have a special situation where longer lines would improve readability. (The basic reason is that 79/72 works for everyone, and BigchainDB is an open source project.)
Single or Double Quotes?
Python lets you use single or double quotes. PEP8 says you can use either, as long as you're consistent. We try to stick to using single quotes, except in cases where using double quotes is more readable. For example:
print('This doesn\'t look so nice.')
print("Doesn't this look nicer?")
Breaking Strings Across Multiple Lines
Should we use parentheses or slashes (\) to break strings across multiple lines, i.e.
my_string = ('This is a very long string, so long that it will not fit into just one line '
'so it must be split across multiple lines.')
# or
my_string = 'This is a very long string, so long that it will not fit into just one line ' \
'so it must be split across multiple lines.'
It seems the preference is for slashes, but using parentheses is okay too. (There are good arguments either way. Arguing about it seems like a waste of time.)
Using the % operator or format() to Format Strings
Given the choice:
x = 'name: %s; score: %d' % (name, n)
# or
x = 'name: {}; score: {}'.format(name, n)
we use the format() version. It's newer and doesn't require you to remember a bunch of arcane markup.
Writing (Python) Tests
We write tests for our Python code using the pytest framework.
All tests go in the bigchaindb/tests directory or one of its subdirectories. You can use the tests already in there as templates or examples.
To run all the tests, first make sure you have RethinkDB running:
$ rethinkdb
then in another terminal, do:
$ py.test -v
If that doesn't work (e.g. maybe you are running in a conda virtual environment), try:
$ python -m pytest -v
We use Travis CI, so that whenever someone creates a new BigchainDB pull request on GitHub, Travis CI gets the new code and does a bunch of stuff. You can find out what we tell Travis CI to do in the .travis.yml file: it tells Travis CI how to install BigchainDB, how to run all the tests, and what to do "after success" (e.g. run codecov). (We use Codecov to get a rough estimate of our test coverage.)