Python 之 風格規範(Google )

来源:https://www.cnblogs.com/lzhh/archive/2018/01/19/python_2.html
-Advertisement-
Play Games

辛苦Mark的 Google公司關於Python的風格規範,emmm~ ...


開頭先mark一下網址:goole官網

任何語言的程式員,編寫出符合規範的代碼,是開始程式生涯的第一步。

一、分號

不要在行尾加分號, 也不要用分號將兩條命令放在同一行。

二、行長度

 每行不超過80個字元

例外:

  1. 長的導入模塊語句
  2. 註釋里的URL

不要使用反斜杠連接行.

Python會將 圓括弧, 中括弧和花括弧中的行隱式的連接起來 , 你可以利用這個特點. 如果需要, 你可以在表達式外圍增加一對額外的圓括弧.

Yes: foo_bar(self, width, height, color='black', design=None, x='foo',
             emphasis=None, highlight=0)

     if (width == 0 and height == 0 and
         color == 'red' and emphasis == 'strong'):

如果一個文本字元串在一行放不下, 可以使用圓括弧來實現隱式行連接

x = ('This will build a very long long '
     'long long long long long long string')

在註釋中,如果必要,將長的URL放在一行上。

Yes: # See details at # http://www.example.com/us/developer/documentation/api/content/v2.0/csv_file_name_extension_full_specification.html

No:  # See details at
     # http://www.example.com/us/developer/documentation/api/content/\
     # v2.0/csv_file_name_extension_full_specification.html

三、括弧

寧缺毋濫的使用括弧

除非是用於實現行連接, 否則不要在返回語句或條件語句中使用括弧. 不過在元組兩邊使用括弧是可以的.

四、縮進

用4個空格來縮進代碼

絕對不要用tab, 也不要tab和空格混用.

對於行連接的情況, 你應該要麼垂直對齊換行的元素(見 行長度 部分的示例),或者使用4空格的懸掛式縮進(這時第一行不應該有參數):

五、空行

頂級定義之間空兩行, 方法定義之間空一行
  • 頂級定義之間空兩行, 比如函數或者類定義.
  • 方法定義, 類定義與第一個方法之間, 都應該空一行. 函數或方法中, 某些地方要是你覺得合適, 就空一行.

六、空格

按照標準的排版規範來使用標點兩邊的空格
  1. 括弧內不要有空格.
  2. 不要在逗號, 分號, 冒號前面加空格, 但應該在它們後面加(除了在行尾).
  3. 參數列表, 索引或切片的左括弧前不應加空格.
  4. 在二元操作符兩邊都加上一個空格, 比如賦值(=), 比較(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布爾(and, or, not). 至於算術操作符兩邊的空格該如何使用, 需要你自己好好判斷. 不過兩側務必要保持一致.
  5. 當’=’用於指示關鍵字參數或預設參數值時, 不要在其兩側使用空格.
  6. 不要用空格來垂直對齊多行間的標記, 因為這會成為維護的負擔(適用於:, #, =等)

七、Shebang

大部分.py文件不必以#!作為文件的開始. 根據 PEP-394 , 程式的main文件應該以 #!/usr/bin/python2或者 #!/usr/bin/python3開始.

(譯者註: 在電腦科學中, Shebang (也稱為Hashbang)是一個由井號和嘆號構成的字元串列(#!), 其出現在文本文件的第一行的前兩個字元. 在文件中存在Shebang的情況下, 類Unix操作系統的程式載入器會分析Shebang後的內容, 將這些內容作為解釋器指令, 並調用該指令, 並將載有Shebang的文件路徑作為該解釋器的參數. 例如, 以指令#!/bin/sh開頭的文件在執行時會實際調用/bin/sh程式.)

#!先用於幫助內核找到Python解釋器, 但是在導入模塊時, 將會被忽略. 因此只有被直接執行的文件中才有必要加入#!.

八、註釋

確保對模塊, 函數, 方法和行內註釋使用正確的風格

塊註釋和行註釋

最需要寫註釋的是代碼中那些技巧性的部分. 如果你在下次 代碼審查 的時候必須解釋一下, 那麼你應該現在就給它寫註釋. 對於複雜的操作, 應該在其操作開始前寫上若幹行註釋. 對於不是一目瞭然的代碼, 應在其行尾添加註釋.

為了提高可讀性, 註釋應該至少離開代碼2個空格.

另一方面, 絕不要描述代碼. 假設閱讀代碼的人比你更懂Python, 他只是不知道你的代碼要做什麼.

九、類

如果一個類不繼承自其它類, 就顯式的從object繼承. 嵌套類也一樣.

繼承自 object 是為了使屬性(properties)正常工作, 並且這樣可以保護你的代碼, 使其不受 PEP-3000 的一個特殊的潛在不相容性影響. 這樣做也定義了一些特殊的方法, 這些方法實現了對象的預設語義, 包括

__new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__

十、字元串

即使參數都是字元串, 使用%操作符或者格式化方法格式化字元串. 不過也不能一概而論, 你需要在+和%之間好好判定.

避免在迴圈中用+和+=操作符來累加字元串. 由於字元串是不可變的, 這樣做會創建不必要的臨時對象, 並且導致二次方而不是線性的運行時間. 作為替代方案, 你可以將每個子串加入列表, 然後在迴圈結束後用 .join 連接列表. (也可以將每個子串寫入一個 cStringIO.StringIO 緩存中.)

十一、文件和sockets

在文件和sockets結束時, 顯式的關閉它.

十二、TODO註釋

為臨時代碼使用TODO註釋, 它是一種短期解決方案. 不算完美, 但夠好了.

十三、導入格式

每個導入應該獨占一行

導入總應該放在文件頂部, 位於模塊註釋和文檔字元串之後, 模塊全局變數和常量之前. 導入應該按照從最通用到最不通用的順序分組:

  1. 標準庫導入
  2. 第三方庫導入
  3. 應用程式指定導入

每種分組中, 應該根據每個模塊的完整包路徑按字典序排序, 忽略大小寫.

十四、語句

通常每個語句應該獨占一行

不過, 如果測試結果與測試語句在一行放得下, 你也可以將它們放在同一行.

如果是if語句, 只有在沒有else時才能這樣做. 特別地, 絕不要對 try/except 這樣做, 因為try和except不能放在同一行.

十五、訪問控制

在Python中, 對於瑣碎又不太重要的訪問函數, 你應該直接使用公有變數來取代它們, 這樣可以避免額外的函數調用開銷. 當添加更多功能時, 你可以用屬性(property)來保持語法的一致性.

(譯者註: 重視封裝的面向對象程式員看到這個可能會很反感, 因為他們一直被教育: 所有成員變數都必須是私有的! 其實, 那真的是有點麻煩啊. 試著去接受Pythonic哲學吧)

十六、命名

module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.

應該避免的名稱

  1. 單字元名稱, 除了計數器和迭代器.
  2. 包/模塊名中的連字元(-)
  3. 雙下劃線開頭並結尾的名稱(Python保留, 例如__init__)

命名約定

  1. 所謂”內部(Internal)”表示僅模塊內可用, 或者, 在類內是保護或私有的.
  2. 用單下劃線(_)開頭表示模塊變數或函數是protected的(使用import * from時不會包含).
  3. 用雙下劃線(__)開頭的實例變數或方法表示類內私有.
  4. 將相關的類和頂級函數放在同一個模塊里. 不像Java, 沒必要限制一個類一個模塊.
  5. 對類名使用大寫字母開頭的單詞(如CapWords, 即Pascal風格), 但是模塊名應該用小寫加下劃線的方式(如lower_with_under.py). 儘管已經有很多現存的模塊使用類似於CapWords.py這樣的命名, 但現在已經不鼓勵這樣做, 因為如果模塊名碰巧和類名一致, 這會讓人困擾.

                           Python之父Guido推薦的規範

TypePublicInternal
Modules lower_with_under _lower_with_under
Packages lower_with_under  
Classes CapWords _CapWords
Exceptions CapWords  
Functions lower_with_under() _lower_with_under()
Global/Class Constants CAPS_WITH_UNDER _CAPS_WITH_UNDER
Global/Class Variables lower_with_under _lower_with_under
Instance Variables lower_with_under _lower_with_under (protected) or __lower_with_under (private)
Method Names lower_with_under() _lower_with_under() (protected) or __lower_with_under() (private)
Function/Method Parameters lower_with_under  
Local Variables lower_with_under  

十七、Main

即使是一個打算被用作腳本的文件, 也應該是可導入的. 並且簡單的導入不應該導致這個腳本的主功能(main functionality)被執行, 這是一種副作用. 主功能應該放在一個main()函數中.

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 題目:一個班有4名學生,5門課程,分別寫三個函數實現以下功能 1.求第一門課程的平均分 2.找出兩門以上不及格學生,輸出其學號,全部成績及平均成績 3.找出平均成績在90分以上,及全部成績在85分以上的學生 思路:這題就是對返回指針值的函數知識點的鞏固。唯一需要註意的是,我們要在函數中處理二維數組時 ...
  • package com.swift; import java.util.*; import java.lang.reflect.*; public class ReflectDemo { public static void main(String[] args) throws Exception ... ...
  • 一、工廠模式(Factory Pattern)的介紹 工廠模式是我們最常用的實例化對象模式了,是用工廠方法代替new操作的一種模式。在工廠模式中,我們在創建對象時不會對客戶端暴露創建邏輯,並且是通過使用一個共同的介面來指向新創建的對象。使用工廠模式可能會多做一些工作,但會給你系統帶來更大的可擴展性和 ...
  • Django創建基本流程 1、創建工程:django-admin startproject 工程名 2、創建應用:python manage.py startapp 應用名 3、激活項目:修改settings.py文件中的INSTALLED_APPS。在該列表的最後加上‘應用名’ 4、配置mysql ...
  • PHP sleep函數一般用於定時執行任務中,表示延遲多少秒在執行程式。這裡主機吧主要給大家講一下sleep函數的語法和應用實例。 sleep函數語法: 應用實例: ...
  • typedef 是C語言提供的一種高級數據特性,它能幫助我們給某一類型創建我們自己的名字,方便我們編碼和使用。 ...
  • 昨天我們使用了dlib和opencv進行了人臉檢測標註(http://www.cnblogs.com/take-fetter/p/8310298.html) 但是運行環境是基於windows的而且可能因為我的電腦上的visual studio配置比較完備,安裝運行沒有出現任何問題. 因為之後我打算把 ...
  • 迭代器 可迭代對象:可迭代對象實現了__iter__方法,該方法返回一個迭代器對象。 迭代器: 那麼什麼迭代器呢?它是一個帶狀態的對象,他能在你調用next()方法的時候返回容器中的下一個值,任何實現了__iter__和__next__(python2中實現next())方法的對象都是迭代器,__i ...
一周排行
    -Advertisement-
    Play Games
  • 前言 在我們開發過程中基本上不可或缺的用到一些敏感機密數據,比如SQL伺服器的連接串或者是OAuth2的Secret等,這些敏感數據在代碼中是不太安全的,我們不應該在源代碼中存儲密碼和其他的敏感數據,一種推薦的方式是通過Asp.Net Core的機密管理器。 機密管理器 在 ASP.NET Core ...
  • 新改進提供的Taurus Rpc 功能,可以簡化微服務間的調用,同時可以不用再手動輸出模塊名稱,或調用路徑,包括負載均衡,這一切,由框架實現並提供了。新的Taurus Rpc 功能,將使得服務間的調用,更加輕鬆、簡約、高效。 ...
  • 順序棧的介面程式 目錄順序棧的介面程式頭文件創建順序棧入棧出棧利用棧將10進位轉16進位數驗證 頭文件 #include <stdio.h> #include <stdbool.h> #include <stdlib.h> 創建順序棧 // 指的是順序棧中的元素的數據類型,用戶可以根據需要進行修改 ...
  • 前言 整理這個官方翻譯的系列,原因是網上大部分的 tomcat 版本比較舊,此版本為 v11 最新的版本。 開源項目 從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎,輕嗅薔薇。 系列文章 web server apache tomcat11-01-官方文檔入門介紹 web serv ...
  • C總結與剖析:關鍵字篇 -- <<C語言深度解剖>> 目錄C總結與剖析:關鍵字篇 -- <<C語言深度解剖>>程式的本質:二進位文件變數1.變數:記憶體上的某個位置開闢的空間2.變數的初始化3.為什麼要有變數4.局部變數與全局變數5.變數的大小由類型決定6.任何一個變數,記憶體賦值都是從低地址開始往高地 ...
  • 如果讓你來做一個有狀態流式應用的故障恢復,你會如何來做呢? 單機和多機會遇到什麼不同的問題? Flink Checkpoint 是做什麼用的?原理是什麼? ...
  • C++ 多級繼承 多級繼承是一種面向對象編程(OOP)特性,允許一個類從多個基類繼承屬性和方法。它使代碼更易於組織和維護,並促進代碼重用。 多級繼承的語法 在 C++ 中,使用 : 符號來指定繼承關係。多級繼承的語法如下: class DerivedClass : public BaseClass1 ...
  • 前言 什麼是SpringCloud? Spring Cloud 是一系列框架的有序集合,它利用 Spring Boot 的開發便利性簡化了分散式系統的開發,比如服務註冊、服務發現、網關、路由、鏈路追蹤等。Spring Cloud 並不是重覆造輪子,而是將市面上開發得比較好的模塊集成進去,進行封裝,從 ...
  • class_template 類模板和函數模板的定義和使用類似,我們已經進行了介紹。有時,有兩個或多個類,其功能是相同的,僅僅是數據類型不同。類模板用於實現類所需數據的類型參數化 template<class NameType, class AgeType> class Person { publi ...
  • 目錄system v IPC簡介共用記憶體需要用到的函數介面shmget函數--獲取對象IDshmat函數--獲得映射空間shmctl函數--釋放資源共用記憶體實現思路註意 system v IPC簡介 消息隊列、共用記憶體和信號量統稱為system v IPC(進程間通信機制),V是羅馬數字5,是UNI ...