摘要:原文作者原題的代碼庫使用編碼風格。此外,推薦的用于連續行的編碼風格毫無一點品味,絕不允許在代碼庫使用與開局定界符對齊。但是,關于靈活設定行長的部分,我舉雙手雙腳贊同。關于代碼風格,沒有絕對完全一致的標準。
原文:https://www.kennethreitz.org/...
作者: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+本精選電子書。
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/43057.html
摘要:因為清楚地意識到自己的基礎并不扎實,所以,幾個月以來,我花了不少時間系統性地學習了一些內容。時間過得真快,現在能拿得出手的也就僅僅是字符串系列切片系列和迭代器系列了。關于技術寫作和翻譯,我初見門道,今后還會多作總結分享。 showImg(https://segmentfault.com/img/bVbn6bh?w=4167&h=2569); 從去年國慶節開始,我連續更新了 4 個月公眾...
閱讀 3213·2021-11-02 14:44
閱讀 3725·2021-09-02 15:41
閱讀 1661·2019-08-29 16:57
閱讀 1784·2019-08-26 13:38
閱讀 3297·2019-08-23 18:13
閱讀 2104·2019-08-23 15:41
閱讀 1668·2019-08-23 14:24
閱讀 3029·2019-08-23 14:03