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

名稱不要縮寫！！！

公司主營業(yè)務(wù)：做網(wǎng)站、網(wǎng)站設(shè)計(jì)、移動網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實(shí)現(xiàn)互聯(lián)網(wǎng)宣傳，提高企業(yè)的競爭能力。創(chuàng)新互聯(lián)建站是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊(duì)。公司秉承以“開放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化，感謝他們對我們的高要求，感謝他們從不同領(lǐng)域給我們帶來的挑戰(zhàn)，讓我們激情的團(tuán)隊(duì)有機(jī)會用頭腦與智慧不斷的給客戶帶來驚喜。創(chuàng)新互聯(lián)建站推出金溪免費(fèi)做網(wǎng)站回饋大家。

名稱不要縮寫！??！

名稱不要縮寫！??！

包命名：小寫，下劃線_連接單詞

模塊命名：小寫，下劃線_連接單詞

類命名：雙駝峰，MyClass

函數(shù)命名：小寫，下劃線_連接單詞

全局變量：每個字母大寫

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

注釋模板：

注釋的作用：

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

python 變量的命名

Python語言變量命名規(guī)則變量名只能包含字母、數(shù)字和下劃線。

變量名可以字母或下劃線開頭，但不能以數(shù)字開頭。

例如，可將變量命名為message_1，但不能將其命名為1_message。變量名不能包含空格，但可使用下劃線來分隔其中的單詞。

以下示例，變量名greeting_message可行，但變量名greetingmessage會引發(fā)錯誤。

不要將Python關(guān)鍵字和函數(shù)名用作變量名，即不要使用Python保留用于特殊用途的單詞，如print。變量名應(yīng)既簡短又具有描述性。慎用小寫字母l和大寫字母O，因給他們可能被人錯看成數(shù)字1和0；

注意：應(yīng)使用小寫的Python變量名。

駝峰命名法當(dāng)變量名是由二個或多個單詞組成時，還可以利用駝峰命名法來命名。

小駝峰式命名法第一個單詞以小寫字母開始，后續(xù)單詞的首字母大寫。

大駝峰式命名法每一個單詞的首字母都采用大寫字母。

在Python中定義Main函數(shù)

目錄

許多編程語言都有一個特殊的函數(shù)，當(dāng)操作系統(tǒng)開始運(yùn)行程序時會自動執(zhí)行該函數(shù)。這個函數(shù)通常被命名為main()，并且依據(jù)語言標(biāo)準(zhǔn)具有特定的返回類型和參數(shù)。另一方面，Python解釋器從文件頂部開始執(zhí)行腳本，并且沒有自動執(zhí)行的特殊函數(shù)。

盡管如此，為程序的執(zhí)行定義一個起始點(diǎn)有助于理解程序是如何運(yùn)行的。Python程序員提出了幾種方式對此進(jìn)行實(shí)現(xiàn)。

本文結(jié)束時，您將了解以下內(nèi)容：

Python中的基本main()函數(shù)

一些Python腳本中，包含一個函數(shù)定義和一個條件語句，如下所示：

此代碼中，包含一個main()函數(shù)，在程序執(zhí)行時打印Hello World!。此外，還包含一個條件（或if）語句，用于檢查__name__的值并將其與字符串"__main__"進(jìn)行比較。當(dāng)if語句為True時，Python解釋器將執(zhí)行main()函數(shù)。更多關(guān)于Python條件語句的信息可以由此獲得。

這種代碼模式在Python文件中非常常見，它將作為腳本執(zhí)行并導(dǎo)入另一個模塊。為了幫助理解這段代碼的執(zhí)行方式，首先需要了解Python解釋器如何根據(jù)代碼的執(zhí)行方式設(shè)置__name__。

Python中的執(zhí)行模式

Python解釋器執(zhí)行代碼有兩種方式：

更多內(nèi)容可參考如何運(yùn)行Python腳本。無論采用哪種方式，Python都會定義一個名為__name__的特殊變量，該變量包含一個字符串，其值取決于代碼的使用方式。

本文將如下示例文件保存為execution_methods.py，以 探索 代碼如何根據(jù)上下文改變行為：

在此文件中，定義了三個對print()函數(shù)的調(diào)用。前兩個打印一些介紹性短語。第三個print()會先打印短語The value __name__ is，之后將使用Python內(nèi)置的repr()函數(shù)打印出__name__變量。

在Python中，repr()函數(shù)將對象轉(zhuǎn)化為供解釋器讀取的形式。上述示例通過使用repr()函數(shù)來強(qiáng)調(diào)__name__的值為字符串。更多關(guān)于repr()的內(nèi)容可參考Python文檔。

在本文中，您將隨處可見文件(file)，模塊(module)和腳本(script)這三個字眼。實(shí)際上，三者之間并無太大的差別。不過，在強(qiáng)調(diào)代碼目的時，還是存在細(xì)微的差異：

“如何運(yùn)行Python腳本”一文也討論了三者的差別。

基于命令行執(zhí)行

在這類方法中，Python腳本將通過命令行來執(zhí)行。

執(zhí)行腳本時，無法與Python解釋器正在執(zhí)行的代碼交互。關(guān)于如何通過命令行執(zhí)行代碼的詳細(xì)信息對本文而言并不重要，但您可以通過展開下框閱讀更多有關(guān)Windows，Linux和macOS之間命令行差異的內(nèi)容。

命令行環(huán)境

不同的操作系統(tǒng)在使用命令行執(zhí)行代碼時存在細(xì)微的差異。

在Linux和macOS中，通常使用如下命令：

美元符號($)之前的內(nèi)容可能有所不同，具體取決于您的用戶名和計(jì)算機(jī)名稱。您鍵入的命令位于$之后。在Linux或macOS上，Python3的可執(zhí)行文件名為python3，因此可以通過輸入python3 script_name.py來運(yùn)行python腳本。

在Windows上，命令提示符通常如下所示：

根據(jù)您的用戶名，之前的內(nèi)容可能會有所不同，您輸入的命令位于之后。在Windows上，Python3的可執(zhí)行文件通常為python。因此可以通過輸入python script_name.py來運(yùn)行python腳本。

無論哪種操作系統(tǒng)，本文的Python腳本的輸出結(jié)果都是相同的。因此本文以Linux和macOS為例。

使用命令行執(zhí)行execution_methods.py，如下所示：

在這個示例中，__name__具有值'__main__'，其中引號(')表明該值為字符串類型。

請記住，在Python中，使用單引號(')和雙引號(")定義的字符串沒有區(qū)別。更多關(guān)于字符串的內(nèi)容請參考Python的基本數(shù)據(jù)類型。

如果在腳本中包含"shebang行"并直接執(zhí)行它(./execution_methods.py)，或者使用IPython或Jupyter Notebook的%run，將會獲取相同的結(jié)果。

您還可以通過向命令行添加-m參數(shù)的方法實(shí)現(xiàn)以模塊的方式執(zhí)行。通常情況下，推薦如下方式pip: python3 -m pip install package_name。

添加-m參數(shù)將會運(yùn)行包中__main__.py的代碼。更多關(guān)于__main__.py文件的內(nèi)容可參考如何將開源Python包發(fā)布到PyPI中。

在三種情況中，__name__都具有相同的值：字符串'__main__'。

技術(shù)細(xì)節(jié)：Python文檔中具體定義了__name__何時取值為'__main__'。

當(dāng)通過標(biāo)準(zhǔn)輸入，腳本或者交互提示中讀取數(shù)據(jù)時，模塊的__name__將取值為'__main__'。（來源）

__name__與__doc__，__package__和其他屬性一起存儲在模塊的全局命名空間。更多關(guān)于屬性的信息可參考Python數(shù)據(jù)模型文檔，特別是關(guān)于模塊和包的信息，請參閱Python Import文檔。

導(dǎo)入模塊或解釋器

接下來是Python解釋器執(zhí)行代碼的第二種方式：導(dǎo)入。在開發(fā)模塊或腳本時，可以使用import關(guān)鍵字導(dǎo)入他人已經(jīng)構(gòu)建的模塊。

在導(dǎo)入過程中，Python執(zhí)行指定模塊中定義的語句（但僅在第一次導(dǎo)入模塊時）。要演示導(dǎo)入execution_methods.py文件的結(jié)果，需要啟動Python解釋器，然后導(dǎo)入execution_methods.py文件：

在此代碼輸出中，Python解釋器執(zhí)行了三次print()函數(shù)調(diào)用。前兩行由于沒有變量，在輸出方面與在命令行上作為腳本執(zhí)行時完全相同。但是第三個輸出存在差異。

當(dāng)Python解釋器導(dǎo)入代碼時，__name__的值與要導(dǎo)入的模塊的名稱相同。您可以通過第三行的輸出了解這一點(diǎn)。__name__的值為'execution_methods'，是Python導(dǎo)入的.py文件。

注意如果您在沒有退出Python時再次導(dǎo)入模塊，將不會有輸出。

注意：更多關(guān)于導(dǎo)入在Python中如何工作的內(nèi)容請參考官方文檔和Python中的絕對和相對導(dǎo)入。

Main函數(shù)的最佳實(shí)踐

既然您已經(jīng)了解兩種執(zhí)行方式上的差異，那么掌握一些最佳實(shí)踐方案還是很有用的。它們將適用于編寫作為腳本運(yùn)行的代碼或者在另一個模塊導(dǎo)入的代碼。

如下是四種實(shí)踐方式：

將大部分代碼放入函數(shù)或類中

請記住，Python解釋器在導(dǎo)入模塊時會執(zhí)行模塊中的所有代碼。有時如果想要實(shí)現(xiàn)用戶可控的代碼，會導(dǎo)致一些副作用，例如：

在這種情況下，想要實(shí)現(xiàn)用戶控制觸發(fā)此代碼的執(zhí)行，而不是讓Python解釋器在導(dǎo)入模塊時執(zhí)行代碼。

因此，最佳方法是將大部分代碼包含在函數(shù)或類中。這是因?yàn)楫?dāng)Python解釋器遇到def或class關(guān)鍵字時，它只存儲這些定義供以后使用，并且在用戶通知之前不會實(shí)際執(zhí)行。

將如下代碼保存在best_practices.py以證明這個想法：

在此代碼中，首先從time模塊中導(dǎo)入sleep()。

在這個示例中，參數(shù)以秒的形式傳入sleep()函數(shù)中，解釋器將暫停一段時間再運(yùn)行。隨后，使用print()函數(shù)打印關(guān)于代碼描述的語句。

之后，定義一個process_data()函數(shù)，執(zhí)行如下五項(xiàng)操作：

在命令行中執(zhí)行

當(dāng)你將此文件作為腳本用命令行執(zhí)行時會發(fā)生什么呢？

Python解釋器將執(zhí)行函數(shù)定義之外的from time import sleep和print()，之后將創(chuàng)建函數(shù)process_data()。然后，腳本將退出而不做任何進(jìn)一步的操作，因?yàn)槟_本沒有任何執(zhí)行process_data()的代碼。

如下是這段腳本的執(zhí)行結(jié)果：

我們在這里看到的輸出是第一個print()的結(jié)果。注意，從time導(dǎo)入和定義process_data()函數(shù)不產(chǎn)生結(jié)果。具體來說，調(diào)用定義在process_data()內(nèi)部的print()不會打印結(jié)果。

導(dǎo)入模塊或解釋器執(zhí)行

在會話（或其他模塊）中導(dǎo)入此文件時，Python解釋器將執(zhí)行相同的步驟。

Python解釋器導(dǎo)入文件后，您可以使用已導(dǎo)入模塊中定義的任何變量，類或函數(shù)。為了證明這一點(diǎn)，我們將使用可交互的Python解釋器。啟動解釋器，然后鍵入import best_practices：

導(dǎo)入best_practices.py后唯一的輸出來自process_data()函數(shù)外定義的print()。導(dǎo)入模塊或解釋器執(zhí)行與基于命令行執(zhí)行類似。

使用__name__控制代碼的執(zhí)行

如何實(shí)現(xiàn)基于命令行而不使用Python解釋器導(dǎo)入文件來執(zhí)行呢？

您可以使用__name__來決定執(zhí)行上下文，并且當(dāng)__name__等于"__main__"時才執(zhí)行process_data()。在best_practices.py文件中添加如下代碼：

這段代碼添加了一個條件語句來檢驗(yàn)__name__的值。當(dāng)值為"__main__"時，條件為True。記住當(dāng)__name__變量的特殊值為"__main__"時意味著Python解釋器會執(zhí)行腳本而不是將其導(dǎo)入。

條件語塊內(nèi)添加了四行代碼（第12，13，14和15行）：

現(xiàn)在，在命令行中運(yùn)行best_practices.py，并觀察輸出的變化：

首先，輸出顯示了process_data()函數(shù)外的print()的調(diào)用結(jié)果。

之后，data的值被打印。因?yàn)楫?dāng)Python解釋器將文件作為腳本執(zhí)行時，變量__name__具有值"__main__"，因此條件語句被計(jì)算為True。

接下來，腳本將調(diào)用process_data()并傳入data進(jìn)行修改。當(dāng)process_data執(zhí)行時，將輸出一些狀態(tài)信息。最終，將輸出modified_data的值。

現(xiàn)在您可以驗(yàn)證從解釋器（或其他模塊）導(dǎo)入best_practices.py后發(fā)生的事情了。如下示例演示了這種情況：

注意，當(dāng)前結(jié)果與將條件語句添加到文件末尾之前相同。因?yàn)榇藭r__name__變量的值為"best_practices"，因此條件語句結(jié)果為False，Python將不執(zhí)行process_data()。

創(chuàng)建名為main()的函數(shù)來包含要運(yùn)行的代碼

現(xiàn)在，您可以編寫作為腳本由從命令行執(zhí)行并導(dǎo)入且沒有副作用的Python代碼。接下來，您將學(xué)習(xí)如何編寫代碼并使其他程序員能輕松地理解其含義。

許多語言，如C，C++，Java以及其他的一些語言，都會定義一個叫做main()的函數(shù)，當(dāng)編譯程序時，操作系統(tǒng)會自動調(diào)用該函數(shù)。此函數(shù)通常被稱為入口點(diǎn)(entry point)，因?yàn)樗浅绦蜻M(jìn)入執(zhí)行的起始位置。

相比之下，Python沒有一個特殊的函數(shù)作為腳本的入口點(diǎn)。實(shí)際上在Python中可以將入口點(diǎn)定義成任何名稱。

盡管Python不要求將函數(shù)命名為main()，但是最佳的做法是將入口點(diǎn)函數(shù)命名為main()。這樣方便其他程序員定位程序的起點(diǎn)。

此外，main()函數(shù)應(yīng)該包含Python解釋器執(zhí)行文件時要運(yùn)行的任何代碼。這比將代碼放入條件語塊中更好，因?yàn)橛脩艨梢栽趯?dǎo)入模塊時重復(fù)使用main()函數(shù)。

修改best_practices.py文件如下所示：

在這個示例中，定義了一個main()函數(shù)，它包含了上面的條件語句塊。之后修改條件語塊執(zhí)行main()。如果您將此代碼作為腳本運(yùn)行或?qū)?，將獲得與上一節(jié)相同的輸出。

在main()中調(diào)用其他函數(shù)

另一種常見的實(shí)現(xiàn)方式是在main()中調(diào)用其他函數(shù)，而不是直接將代碼寫入main()。這樣做的好處在于可以實(shí)現(xiàn)將幾個獨(dú)立運(yùn)行的子任務(wù)整合。

例如，某個腳本有如下功能：

如果在單獨(dú)的函數(shù)中各自實(shí)現(xiàn)這些子任務(wù)，您（或其他用戶）可以很容易地實(shí)現(xiàn)代碼重用。之后您可以在main()函數(shù)中創(chuàng)建默認(rèn)的工作流。

您可以根據(jù)自己的情況選擇是否使用此方案。將任務(wù)拆分為多個函數(shù)會使重用更容易，但會增加他人理解代碼的難度。

修改best_practices.py文件如下所示：

在此示例代碼中，文件的前10行具有與之前相同的內(nèi)容。第12行的第二個函數(shù)創(chuàng)建并返回一些示例數(shù)據(jù)，第17行的第三個函數(shù)模擬將修改后的數(shù)據(jù)寫入數(shù)據(jù)庫。

第21行定義了main()函數(shù)。在此示例中，對main()做出修改，它將調(diào)用數(shù)據(jù)讀取，數(shù)據(jù)處理以及數(shù)據(jù)寫入等功能。

首先，從read_data_from_web()中創(chuàng)建data。將data作為參數(shù)傳入process_data()，之后將返回modified_data。最后，將modified_data傳入write_data_to_database()。

腳本的最后兩行是條件語塊用于驗(yàn)證__name__，并且如果if語句為True，則執(zhí)行main()。

在命令行中運(yùn)行如下所示：

根據(jù)執(zhí)行結(jié)果，Python解釋器在執(zhí)行main()函數(shù)時，將依次執(zhí)行read_data_from_web()，process_data()以及write_data_to_database()。當(dāng)然，您也可以導(dǎo)入best_practices.py文件并重用process_data()作為不同的數(shù)據(jù)輸入源，如下所示：

在此示例中，導(dǎo)入了best_practices并且將其簡寫為bp。

導(dǎo)入過程會導(dǎo)致Python解釋器執(zhí)行best_practices.py的全部代碼，因此輸出顯示解釋文件用途的信息。

然后，從文件中存儲數(shù)據(jù)而不是從Web中讀取數(shù)據(jù)。之后，可以重用best_practices.py文件中的process_data()和write_data_to_database()函數(shù)。在此情況下，可以利用代碼重寫來取代在main()函數(shù)中實(shí)現(xiàn)全部的代碼邏輯。

實(shí)踐總結(jié)

以下是Python中main()函數(shù)的四個關(guān)鍵最佳實(shí)踐：

結(jié)論

恭喜！您現(xiàn)在已經(jīng)了解如何創(chuàng)建Python main()函數(shù)了。

本文介紹了如下內(nèi)容：

現(xiàn)在，您可以開始編寫一些非常棒的關(guān)于Python main()函數(shù)代碼啦！

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

Python 命名一般來說有一下不成文的規(guī)則 ：

模塊名一般使用全部小寫 如 myphone

類名第一個字母大寫，如果有多個單詞，每一個單詞的第一個字母大寫如 : MyPhone

函數(shù)名 ： 小寫， 如果有多個單詞用下劃線隔開 如 my_phone

常量名字一般全大寫 ： MYPHONE

python語言變量命名規(guī)則是什么?

python語言變量命名規(guī)則是只能包含字母、數(shù)字和下劃線。

變量名可以字母或下劃線開頭，但不能以數(shù)字開頭。例如可將變量命名為message_1，但不能將其命名為1_message。變量名不能包含空格，但可使用下劃線來分隔其中的單詞。

變量名greeting_message可行，但變量名greetingmessage會引發(fā)錯誤。不要將Python關(guān)鍵字和函數(shù)名用作變量名，即不要使用Python保留用于特殊用途的單詞，如print。變量名應(yīng)既簡短又具有描述性。慎用小寫字母l和大寫字母O，因可能被人錯看成數(shù)字1和0。

應(yīng)用領(lǐng)域：

1、圖形處理：有PIL、Tkinter等圖形庫支持，能方便進(jìn)行圖形處理。

2、數(shù)學(xué)處理：NumPy擴(kuò)展提供大量與許多標(biāo)準(zhǔn)數(shù)學(xué)庫的接口。

3、文本處理：python提供的re模塊能支持正則表達(dá)式，還提供SGML，XML分析模塊，許多程序員利用python進(jìn)行XML程序的開發(fā)。

以上內(nèi)容參考：百度百科--變量

當(dāng)前標(biāo)題：python類內(nèi)函數(shù)命名 python中類名的命名規(guī)則
URL地址：http://jinyejixie.com/article8/hpchop.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)站設(shè)計(jì)公司、外貿(mào)網(wǎng)站建設(shè)、動態(tài)網(wǎng)站、自適應(yīng)網(wǎng)站、App開發(fā)、網(wǎng)頁設(shè)計(jì)公司

廣告

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