詳解python里的命名規(guī)范

更新時(shí)間：2018年07月16日 14:32:17 作者：Williamwhc

這篇文章主要介紹了詳解python里的命名規(guī)范，命名應(yīng)當(dāng)盡量使用全拼寫(xiě)的單詞，縮寫(xiě)的情況文章中也給大家提到，需要的朋友參考下吧

文件名

全小寫(xiě),可使用下劃線

包

應(yīng)該是簡(jiǎn)短的、小寫(xiě)的名字。如果下劃線可以改善可讀性可以加入。如mypackage。

模塊

與包的規(guī)范同。如mymodule。

類

總是使用首字母大寫(xiě)單詞串。如MyClass。內(nèi)部類可以使用額外的前導(dǎo)下劃線。

函數(shù)&方法

函數(shù)名應(yīng)該為小寫(xiě)，可以用下劃線風(fēng)格單詞以增加可讀性。如：myfunction，my_example_function。
*注意*：混合大小寫(xiě)僅被允許用于這種風(fēng)格已經(jīng)占據(jù)優(yōu)勢(shì)的時(shí)候，以便保持向后兼容。

函數(shù)和方法的參數(shù)

總使用“self”作為實(shí)例方法的第一個(gè)參數(shù)?？偸褂谩癱ls”作為類方法的第一個(gè)參數(shù)。
如果一個(gè)函數(shù)的參數(shù)名稱和保留的關(guān)鍵字沖突，通常使用一個(gè)后綴下劃線好于使用縮寫(xiě)或奇怪的拼寫(xiě)。

全局變量

對(duì)于from M import *導(dǎo)入語(yǔ)句，如果想阻止導(dǎo)入模塊內(nèi)的全局變量可以使用舊有的規(guī)范，在全局變量上加一個(gè)前導(dǎo)的下劃線。
*注意*:應(yīng)避免使用全局變量

變量

變量名全部小寫(xiě)，由下劃線連接各個(gè)單詞。如color = WHITE，this_is_a_variable = 1

*注意*：

1.不論是類成員變量還是全局變量，均不使用 m 或 g 前綴。
2.私有類成員使用單一下劃線前綴標(biāo)識(shí)，多定義公開(kāi)成員，少定義私有成員。
3.變量名不應(yīng)帶有類型信息，因?yàn)镻ython是動(dòng)態(tài)類型語(yǔ)言。如 iValue、names_list、dict_obj 等都是不好的命名。

常量

常量名所有字母大寫(xiě)，由下劃線連接各個(gè)單詞如MAX_OVERFLOW，TOTAL。

異常

以“Error”作為后綴。

縮寫(xiě)

命名應(yīng)當(dāng)盡量使用全拼寫(xiě)的單詞，縮寫(xiě)的情況有如下兩種：

1.常用的縮寫(xiě)，如XML、ID等，在命名時(shí)也應(yīng)只大寫(xiě)首字母，如XmlParser。
2.命名中含有長(zhǎng)單詞，對(duì)某個(gè)單詞進(jìn)行縮寫(xiě)。這時(shí)應(yīng)使用約定成俗的縮寫(xiě)方式。

例如：

function 縮寫(xiě)為 fn
text 縮寫(xiě)為 txt
object 縮寫(xiě)為 obj
count 縮寫(xiě)為 cnt
number 縮寫(xiě)為 num，等。
前導(dǎo)后綴下劃線
一個(gè)前導(dǎo)下劃線：表示非公有。
一個(gè)后綴下劃線：避免關(guān)鍵字沖突。
兩個(gè)前導(dǎo)下劃線：當(dāng)命名一個(gè)類屬性引起名稱沖突時(shí)使用。
兩個(gè)前導(dǎo)和后綴下劃線：“魔”（有特殊用圖）對(duì)象或者屬性，例如__init__或者_(dá)_file__。絕對(duì)不要?jiǎng)?chuàng)造這樣的名字，而只是使用它們。

*注意*：關(guān)于下劃線的使用存在一些爭(zhēng)議。

特定命名方式

主要是指 __xxx__ 形式的系統(tǒng)保留字命名法。項(xiàng)目中也可以使用這種命名，它的意義在于這種形式的變量是只讀的，這種形式的類成員函數(shù)盡量不要重載。如

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

其中 __id__、__parent__ 和 __message__ 都采用了系統(tǒng)保留字命名法。

附:Google Python命名規(guī)范

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

總結(jié)

以上所述是小編給大家介紹的python里的命名規(guī)范，希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)請(qǐng)給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！

您可能感興趣的文章: