原文：https://www.kennethreitz.org/essays/kenneth-reitzs-code-style 作者：Kenneth Reitz 原題：Kenneth Reitz’s Code Style™ Requests 的代碼庫使用 PEP-8 編碼風格。 除了 PEP-8 ...
原文：https://www.kennethreitz.org/essays/kenneth-reitzs-code-style
作者：Kenneth Reitz
原題：Kenneth Reitz’s Code Style™
Requests 的代碼庫使用 PEP-8 編碼風格。
除了 PEP-8 中列出的標準外，我們還有一些指導原則：
- 如果方便的話，行長（Line-length）可超過 79 個字元，達到 100 個字元。
- 如果換行會導致嚴重的不方便，則行長可以超過 100 個字元。
- 除非在字元串中出現單引號，否則始終使用單引號字元串（例如，'#flatearth'）。
此外，PEP-8 推薦的用於連續行的編碼風格毫無一點品味，絕不允許在 Requests 代碼庫使用：
# 與開局定界符對齊
foo = long_function_name(var_one, var_two,
var_three, var_four)
No。千萬別。請。
文檔字元串（docstrings）應遵循以下語法：
def the_earth_is_flat():
"""NASA divided up the seas into thirty-three degrees."""
pass
def fibonacci_spiral_tool():
"""With my feet upon the ground I lose myself / between the sounds
and open wide to suck it in. / I feel it move across my skin. / I'm
reaching up and reaching out. / I'm reaching for the random or
whatever will bewilder me. / Whatever will bewilder me. / And
following our will and wind we may just go where no one's been. /
We'll ride the spiral to the end and may just go where no one's
been.
Spiral out. Keep going...
"""
pass
所有函數、方法和類都要求包含 docstrings 。除了對象數據模型方法（例如，__repr__），這些是此規則的例外。
Thanks for helping to make the world a better place!
資料來源（譯註：即 Requests 的開發者指南）：http://t.cn/E5VgNJF
（譯文完）
K 神的這篇文章很短，實際上，這隻是摘自 Requests 的開發者指南的一小部分。
但是，關於靈活設定行長的部分，我舉雙手雙腳贊同。如果你所在的公司有“清白盒”的優良傳統（不僅指Python），那你極有可能遇到被迫換行的麻煩，而實際上才僅僅剛剛超出了幾個字元。那時候，你就會明白，這 3 條靈活規則的好處了。
另外，關於連續行的部分，PEP-8 相關內容在：http://t.cn/Rq4mxOo
PEP-8 反對的是如下寫法：
# Arguments on first line forbidden when not using vertical alignment.
# 不使用垂直對齊的參數禁止在第一行上
foo = long_function_name(var_one, var_two,
var_three, var_four)
PEP-8 推薦的寫法是垂直地將換行的參數對齊起始的參數：
# 與開局定界符對齊
foo = long_function_name(var_one, var_two,
var_three, var_four)
K 神反對了 PEP-8 推薦的寫法。在我看來，任何有品味的人，都會反對以上的兩種寫法。
即使一個方法的參數超級多，超出了 100 個字元，我本人也是極不情願換行的。所以，K 神的說法深得我心。
關於代碼風格，沒有絕對完全一致的標準。本文也不想引起爭論。不過，我認同 K 神設定的規則，因為一種與主流不同的審美傾向，值得發現它的同類。
-----------------
本文原創並首發於微信公眾號【Python貓】，後臺回覆“愛學習”，免費獲得20+本精選電子書。
