Skip to content

Commit

Permalink
started work on python best practices
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Ingram committed Mar 20, 2012
1 parent 9d6ee6d commit f6ca41a
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions python.rst
@@ -0,0 +1,49 @@
Python Coding Standards
=======================

The Zen of Python
-----------------

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.

In the face of ambiguity, refuse the temptation to guess.
There should be one—and preferably only one—obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than right now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea—let's do more of those!


Use explicit imports
--------------------

Don't use:

```
from foo import *
Bar()
```

Use:

```
from foo import Bar
Bar()

Or:

```
import foo
foo.Bar()

0 comments on commit f6ca41a

Please sign in to comment.