python命名規範

來源:互聯網
上載者:User

常量:

常量名所有字母大寫,由底線串連各個單詞,如
WHITE = 0XFFFFFF
THIS_IS_A_CONSTANT = 1

變數:

1.普通變數:
    全部小寫,由底線串連各個單詞,如:

1
color = WHITE
2
this_is_a_variable = 1
2.保護成員變數:
    單底線作首碼,意思是只有類對象和子類對象自己能訪問到這些變數,且不能用'from module import *'匯入。如:
1
_name=name
3.私人成員變數:
    雙底線作首碼,意思是只有類對象自己能訪問,連子類對象也不能訪問到這個資料。

1
__ha=ha
4.全域變數:
    大寫字母,單詞之間用_分割。
    對於from M import *匯入語句,如果想阻止匯入模組內的全域變數可以使用舊有的規範,在全域變數上加一個前置的底線

1
NUMBER
2
COLOR_WRITE
5. 注意:
    (1) 不論是類成員變數還是全域變數,均不使用 m 或 g 首碼
     (2)變數名不應帶有類型資訊,因為 Python 是動態類型語言。如 iValue、names_list、dict_obj 等都是不好的命名。

函數:

1. 普通函數:
    與普通變數一致,函數名應該為小寫,可以用底線風格單詞以增加可讀性。
     混合大小寫僅被允許用於這種風格已經佔據優勢的時候,以便保持向後相容

1
myfunctio()
2
my_example_function()
3
myName()
2. 私人函數:
    以雙底線開頭。如:

1
__get_name()
3.函數的參數: 
    總使用“self”作為執行個體方法的第一個參數。總使用“cls”作為類方法的第一個參數。
    如果一個函數的參數名稱和保留的關鍵字衝突,通常使用一個尾碼底線好於使用縮寫或奇怪的拼字。
模組:

 應該是簡短的、小寫名字,單詞之間用_分割。模組就是指檔案

1
hello.py
2
ad_stats.py
類:

 類名單字首大寫,不使用底線串連單詞,也不加入 C、T 等首碼
 執行個體用小寫字母

1
class MyClass(object)
包:

 命名方式同模組,是檔案夾

特定命名方式:__xxx__
主要是指 __xxx__ 形式的系統保留字命名法。項目中也可以使用這種命名,它的意義在於這種形式的變數是唯讀,這種形式的類成員函數盡量不要重載。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略
其中 __id__、__parent__ 和 __message__ 都採用了系統保留字命名法。

相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.