Python之禪----The Zen of Python

1、Python之禪

在 Python shell 中輸入 import this，就會展現 Tim Peters 的 The Zen of Python：

The Zen of Python, by Tim Peters 

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! 

翻譯以下：

優美勝於醜陋（Python 以編寫優美的代碼爲目標） 
明瞭勝於晦澀（優美的代碼應當是明瞭的，命名規範，風格類似） 
簡潔勝於複雜（優美的代碼應當是簡潔的，不要有複雜的內部實現） 
複雜勝於凌亂（若是複雜不可避免，那代碼間也不能有難懂的關係，要保持接口簡潔） 
扁平勝於嵌套（優美的代碼應當是扁平的，不能有太多的嵌套） 
間隔勝於緊湊（優美的代碼有適當的間隔，不要奢望一行代碼解決問題） 
可讀性很重要（優美的代碼是可讀的） 
即使假借特例的實用性之名，也不可違背這些規則（這些規則至高無上） 
不要包容全部錯誤，除非你肯定須要這樣作（精準地捕獲異常，不寫 except:pass 風格的代碼） 
當存在多種可能，不要嘗試去猜想 
而是儘可能找一種，最好是惟一一種明顯的解決方案（若是不肯定，就用窮舉法） 
雖然這並不容易，由於你不是 Python 之父（這裏的 Dutch 是指 Guido ） 
作也許好過不作，但不假思索就動手還不如不作（動手以前要細思量） 
若是你沒法向人描述你的方案，那確定不是一個好方案；反之亦然（方案測評標準） 
命名空間是一種絕妙的理念，咱們應當多加利用（倡導與號召）

2、編寫Pythonic代碼

避免劣化代碼

• 避免只用大小寫來區分不一樣的對象；

• 避免使用容易引發混淆的名稱，變量名應與所解決的問題域一致；

• 不要懼怕過長的變量名；

代碼中添加適當註釋

• 行註釋僅註釋複雜的操做、算法，難理解的技巧，或不夠一目瞭然的代碼；

• 註釋和代碼要隔開必定的距離，不管是行註釋仍是塊註釋；

• 給外部可訪問的函數和方法（不管是否簡單）添加文檔註釋，註釋要清楚地描述方法的功能，並對參數，返回值，以及可能發生的異常進行說明，使得外部調用的人僅看docstring就能正確使用；

• 推薦在文件頭中包含copyright申明，模塊描述等；

• 註釋應該是用來解釋代碼的功能，緣由，及想法的，不應對代碼自己進行解釋；

• 對再也不須要的代碼應該將其刪除，而不是將其註釋掉；

適當添加空行使代碼佈局更爲優雅、合理

• 在一組代碼表達完一個完整的思路以後，應該用空白行進行間隔，推薦在函數定義或者類定義之間空兩行，在類定義與第一個方法之間，或須要進行語義分隔的地方空一行，空行是在不隔斷代碼之間的內在聯繫的基礎上插入的；

• 儘可能保證上下文語義的易理解性，通常是調用者在上，被調用者在下；

• 避免過長的代碼行，每行最好不要超過80字符；

• 不要爲了保持水平對齊而使用多餘的空格；

編寫函數的幾個原則

• 函數設計要儘可能短小，嵌套層次不宜過深；

• 函數申明應作到合理、簡單、易於使用，函數名應能正確反映函數大致功能，參數設計應簡潔明瞭，參數個數不宜過多；

• 函數參數設計應考慮向下兼容；

• 一個函數只作一件事，儘可能保證函數語句粒度的一致性；

將常量集中到一個文件

Python沒有提供定義常量的直接方式，通常有兩種方法來使用常量；

• 經過命名風格來提醒使用者該變量表明的意義爲常量，如常量名全部字母大寫，用下劃線鏈接各個單詞，如MAX_NUMBER，TOTLE等；

• 經過自定義的類實現常量功能，常量要求符合兩點，一是命名必須所有爲大寫字母，二是值一旦綁定便不可再修改；