首頁  >  文章  >  後端開發  >  Python的命名規格是什麼? python命名規範的介紹

Python的命名規格是什麼? python命名規範的介紹

不言
不言原創
2018-09-20 15:58:102215瀏覽

本篇文章帶給大家的內容是關於Python的命名規範是什麼? python命名規範的介紹,有一定的參考價值,有需要的朋友可以參考一下,希望對你有幫助。

檔名
全小寫,可使用底線

套件

應該是簡短的、小寫的名字。如果底線可以改善可讀性可以加入。如mypackage。

模組

與套件的規格同。如mymodule。

類別

總是使用首字母大寫單字串。如MyClass。內部類別可以使用額外的前導下劃線。

函數&方法

函數名稱應該是小寫,可以用下劃線風格單字以增加可讀性。如:myfunction,my_example_function。

*注意*:混合大小寫僅被允許用於這種風格已經佔據優勢的時候,以便保持向後相容。

函數和方法的參數

總是使用「self」作為實例方法的第一個參數。總是使用“cls”作為類別方法的第一個參數。
如果一個函數的參數名稱和保留的關鍵字衝突,通常使用一個後綴下劃線好於使用縮寫或奇怪的拼字。

全域變數

對於from M import *導入語句,如果想要阻止導入模組內的全域變數可以使用舊有的規範,在全域變數上加上一個前導的底線。
*注意*:應避免使用全域變數

變數

變數名稱全部小寫,由底線連接各個單字。如color = WHITE,this_is_a_variable = 1

*注意*:
1.不論是類別成員變數還是全域變量,皆不使用 m 或 g 前綴。
2.私有類別成員使用單一底線前綴標識,多定義公開成員,少定義私有成員。
3.變數名稱不應帶有型別訊息,因為Python是動態型別語言。如 iValue、names_list、dict_obj 等都是不好的命名。

常數

常數名稱所有字母大寫,由底線連接各個單字如MAX_OVERFLOW,TOTAL。

異常

以「Error」作為後綴。

縮寫

命名應當盡量使用全拼字的單字,縮寫的情況有以下兩種:
1.常用的縮寫,如XML、ID等,在命名時也應隻大寫首字母,如XmlParser。
2.命名中含有長單字,對某個單字進行縮寫。這時應使用約定成俗的縮寫方式。

例如:
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num,等。

前導後綴底線

一個前導底線:表示非公有。
一個後綴底線:避免關鍵字衝突。
兩個前導底線:當命名一個類別屬性造成名稱衝突時使用。
兩個前導和後綴底線:「魔」(有特殊用圖)物件或屬性,例如__init__或__file__。絕對不要創造這樣的名字,而只是使用它們。

*注意*:關於下劃線的使用存在一些爭議。

特定命名方式

主要是指 __xxx__ 形式的系統保留字命名法。專案中也可以使用這種命名,它的意義在於這種形式的變數是唯讀的,而這種形式的類別成員函數盡量不要重載。如

class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略

其中 __id__、__parent__ 和 __message__ 都採用了系統保留字命名法。

附:Google Python命名規格

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

以上是Python的命名規格是什麼? python命名規範的介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn