python函數(shù)命名風(fēng)格 Python中函數(shù)命名規(guī)則

Python命名規(guī)則與注釋風(fēng)格

名稱(chēng)不要縮寫(xiě)?。。?/p>

成都創(chuàng)新互聯(lián)公司專(zhuān)業(yè)為企業(yè)提供洛隆網(wǎng)站建設(shè)、洛隆做網(wǎng)站、洛隆網(wǎng)站設(shè)計(jì)、洛隆網(wǎng)站制作等企業(yè)網(wǎng)站建設(shè)、網(wǎng)頁(yè)設(shè)計(jì)與制作、洛隆企業(yè)網(wǎng)站模板建站服務(wù),十多年洛隆做網(wǎng)站經(jīng)驗(yàn),不只是建網(wǎng)站,更提供有價(jià)值的思路和整體網(wǎng)絡(luò)服務(wù)。

名稱(chēng)不要縮寫(xiě)?。?!

名稱(chēng)不要縮寫(xiě)!??!

包命名:小寫(xiě),下劃線_連接單詞

模塊命名:小寫(xiě),下劃線_連接單詞

類(lèi)命名:雙駝峰,MyClass

函數(shù)命名:小寫(xiě),下劃線_連接單詞

全局變量:每個(gè)字母大寫(xiě)

注釋很重要,要注明函數(shù)或類(lèi)的功能,參數(shù)的數(shù)據(jù)類(lèi)型、含義等。

注釋模板:

注釋的作用:

Python有句話是do not repeat yourself,即不要做重復(fù)的事,因此出現(xiàn)了類(lèi)或函數(shù)的封裝和繼承,基于此可提高代碼的重復(fù)利用性。

python怎樣命名變量的

模塊名:

小寫(xiě)字母,單詞之間用_分割

ad_stats.py

包名:

和模塊名一樣

類(lèi)名:

單詞首字母大寫(xiě)

AdStats

ConfigUtil

全局變量名(類(lèi)變量,在java中相當(dāng)于static變量):

大寫(xiě)字母,單詞之間用_分割

NUMBER

COLOR_WRITE

普通變量:

小寫(xiě)字母,單詞之間用_分割

this_is_a_var

實(shí)例變量:

以_開(kāi)頭,其他和普通變量一樣

_price

_instance_var

私有實(shí)例變量(外部訪問(wèn)會(huì)報(bào)錯(cuò)):

以__開(kāi)頭(2個(gè)下劃線),其他和普通變量一樣

__private_var

專(zhuān)有變量:

__開(kāi)頭,__結(jié)尾,一般為python的自有變量,不要以這種方式命名

__doc__

__class__

普通函數(shù):

和普通變量一樣:

get_name()

count_number()

ad_stat()

私有函數(shù)(外部訪問(wèn)會(huì)報(bào)錯(cuò)):

以__開(kāi)頭(2個(gè)下劃線),其他和普通函數(shù)一樣

__get_name()

————————————————————————————————————————————————————————————————————

文件名

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

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

模塊

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

類(lèi)

總是使用首字母大寫(xiě)單詞串。如MyClass。內(nèi)部類(lè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”作為類(lèi)方法的第一個(gè)參數(shù)。

如果一個(gè)函數(shù)的參數(shù)名稱(chēng)和保留的關(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.不論是類(lèi)成員變量還是全局變量,均不使用 m 或 g 前綴。

2.私有類(lèi)成員使用單一下劃線前綴標(biāo)識(shí),多定義公開(kāi)成員,少定義私有成員。

3.變量名不應(yīng)帶有類(lèi)型信息,因?yàn)镻ython是動(dòng)態(tài)類(lè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è)類(lèi)屬性引起名稱(chēng)沖突時(shí)使用。

兩個(gè)前導(dǎo)和后綴下劃線:“魔”(有特殊用途)對(duì)象或者屬性,例如__init__或者_(dá)_file__。絕對(duì)不要?jiǎng)?chuàng)造這樣的名字,而只是使用它們。

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

Python 用下劃線作為變量前綴和后綴指定特殊變量。

_xxx 不能用'from module import *'導(dǎo)入

__xxx__ 系統(tǒng)定義名字

__xxx 類(lèi)中的私有變量名

核心風(fēng)格:避免用下劃線作為變量名的開(kāi)始。

因?yàn)橄聞澗€對(duì)解釋器有特殊的意義,而且是內(nèi)建標(biāo)識(shí)符所使用的符號(hào),我們建議程序員避免用下劃線作為變量名的開(kāi)始。一般來(lái)講,變量名_xxx被看作是“私有的”,在模塊或類(lèi)外不可以使用。當(dāng)變量是私有的時(shí)候,用_xxx 來(lái)表示變量是很好的習(xí)慣。因?yàn)樽兞棵鸰_xxx__對(duì)Python 來(lái)說(shuō)刑厥夂澹雜諂脹ǖ謀淞坑Φ北苊庹庵置綹瘛?br

"單下劃線" 開(kāi)始的成員變量叫做保護(hù)變量,意思是只有類(lèi)對(duì)象和子類(lèi)對(duì)象自己能訪問(wèn)到這些變量;

"雙下劃線" 開(kāi)始的是私有成員,意思是只有類(lèi)對(duì)象自己能訪問(wèn),連子類(lèi)對(duì)象也不能訪問(wèn)到這個(gè)數(shù)據(jù)。

以單下劃線開(kāi)頭(_foo)的代表不能直接訪問(wèn)的類(lèi)屬性,需通過(guò)類(lèi)提供的接口進(jìn)行訪問(wèn),不能用“from xxx import *”而導(dǎo)入;以雙下劃線開(kāi)頭的(__foo)代表類(lèi)的私有成員;以雙下劃線開(kāi)頭和結(jié)尾的(__foo__)代表python里特殊方法專(zhuān)用的標(biāo)識(shí),如 __init__()代表類(lèi)的構(gòu)造函數(shù)。

特定命名方式

主要是指 __xxx__ 形式的系統(tǒng)保留字命名法。項(xiàng)目中也可以使用這種命名,它的意義在于這種形式的變量是只讀的,這種形式的類(lèi)成員函數(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)保留字命名法。

python中函數(shù)名的命名規(guī)則

Python 命名一般來(lái)說(shuō)有一下不成文的規(guī)則 :

模塊名一般使用全部小寫(xiě) 如 myphone

類(lèi)名第一個(gè)字母大寫(xiě),如果有多個(gè)單詞,每一個(gè)單詞的第一個(gè)字母大寫(xiě)如 : MyPhone

函數(shù)名 : 小寫(xiě), 如果有多個(gè)單詞用下劃線隔開(kāi) 如 my_phone

常量名字一般全大寫(xiě) : MYPHONE

python程序有哪些編碼規(guī)范

編碼格式聲明

通常,編碼格式聲明是必需的。如果 python 源碼文件沒(méi)有聲明編碼格式,python 解釋器會(huì)默認(rèn)使用 ASCII 編碼,一旦源碼文件包含非ASCII編碼的字符,python 解釋器就會(huì)報(bào)錯(cuò)。以 UTF-8 為例,以下兩種編碼格式聲明都是合乎規(guī)則的。

縮進(jìn)

統(tǒng)一使用 4 個(gè)空格進(jìn)行縮進(jìn)。絕對(duì)不要用tab, 也不要tab和空格混用。對(duì)于行連接的情況,我一般使用4空格的懸掛式縮進(jìn)。例如:

引號(hào)

自然語(yǔ)言使用雙引號(hào)

機(jī)器標(biāo)識(shí)使用單引號(hào)

正則表達(dá)式使用雙引號(hào)

空行

編碼格式聲明、模塊導(dǎo)入、常量和全局變量聲明、頂級(jí)定義和執(zhí)行代碼之間空兩行

頂級(jí)定義之間空兩行,方法定義之間空一行

在函數(shù)或方法內(nèi)部,可以在必要的地方空一行以增強(qiáng)節(jié)奏感,但應(yīng)避免連續(xù)空行

導(dǎo)入模塊

導(dǎo)入總應(yīng)該放在文件頂部,位于模塊注釋和文檔字符串之后,模塊全局變量和常量之前。導(dǎo)入應(yīng)該按照從最通用到最不通用的順序分組,分組之間空一行

標(biāo)準(zhǔn)庫(kù)導(dǎo)入

第三方庫(kù)導(dǎo)入

應(yīng)用程序指定導(dǎo)入

命名規(guī)范

模塊盡量使用小寫(xiě)命名,首字母保持小寫(xiě),盡量不要用下劃線

類(lèi)名使用駝峰(CamelCase)命名風(fēng)格,首字母大寫(xiě),私有類(lèi)可用一個(gè)下劃線開(kāi)頭

函數(shù)名一律小寫(xiě),如有多個(gè)單詞,用下劃線隔開(kāi)

私有函數(shù)可用一個(gè)下劃線開(kāi)頭

變量名盡量小寫(xiě), 如有多個(gè)單詞,用下劃線隔開(kāi)

常量采用全大寫(xiě),如有多個(gè)單詞,使用下劃線隔開(kāi)

本文題目:python函數(shù)命名風(fēng)格 Python中函數(shù)命名規(guī)則
網(wǎng)站鏈接:http://www.muchs.cn/article36/hggesg.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供面包屑導(dǎo)航、自適應(yīng)網(wǎng)站云服務(wù)器、網(wǎng)站排名、網(wǎng)站設(shè)計(jì)公司全網(wǎng)營(yíng)銷(xiāo)推廣

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶(hù)投稿、用戶(hù)轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)

成都seo排名網(wǎng)站優(yōu)化