From f6ca41a47e66e2d8c3b8453905ec738b9bca39f4 Mon Sep 17 00:00:00 2001 From: Andrew Ingram Date: Tue, 20 Mar 2012 10:52:56 +0000 Subject: [PATCH] started work on python best practices --- python.rst | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 python.rst diff --git a/python.rst b/python.rst new file mode 100644 index 0000000..e09cfc8 --- /dev/null +++ b/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()