基礎python規範

1.註釋

    合理的代碼註釋應該佔源代碼的 1/3 左右，Python 語言容許在任何地方插入空字符或註釋，但不能插入到標識符和字符串中間。

    在 Python 中，一般包括 3 種類型的註釋，分別是單行註釋、多行註釋和中文編碼聲明註釋：

• 單行註釋：

            Python 中使用井號（ # ）做爲單行註釋的符號，語法格式爲：# 註釋內容

1 print('hello world')  # 這是一條註釋

•  多行註釋：

            多行註釋一般用來爲 Python 文件、模塊、類或者函數等添加功能描述等信息，使用三單引號或三雙引號做爲多行註釋符號，同時，也是長字符串符號。

1 st = '''
2     日照香爐生紫煙，
3     遙看瀑布掛前川。
4     飛流直下三千尺，
5     疑是銀河落九天。
6 '''

• 中文編碼聲明註釋:

            主要用來解決 Python 2.x 中不支持直接寫中文的問題，中文編碼聲明註釋的語法有以下 2 種：

            　　# -*- coding:編碼 -*-

            　　或者

           　　 # coding=編碼

1 # -*- coding: UTF-8 -*-

 

2.縮進規則

    Python 採用代碼縮進和冒號（ : ）來區分代碼塊之間的層次。

    對於類定義、函數定義、流程控制語句、異常處理語句等，行尾的冒號和下一行的縮進，表示下一個代碼塊的開始，而縮進的結束則表示此代碼塊的結束。

    Python 中實現對代碼的縮進，可使用空格或者 Tab 鍵實現。但不管是手動敲空格，仍是使用 Tab 鍵，一般狀況下都是採用 4 個空格長度做爲一個縮進量（默認狀況下，一個 Tab 鍵就表示 4 個空格）。

 

3.編碼規範

    Python 採用 PEP 8 做爲編碼規範，下面列出一些常見的編碼規則：

        每一個 import 語句只導入一個模塊，儘可能避免一次導入多個模塊；

        不要在行尾添加分號，也不要用分號將兩條命令放在同一行；

        建議每行不超過 80 個字符，若是超過，建議使用小括號將多行內容隱式的鏈接起來，而不推薦使用反斜槓進行鏈接；

        使用必要的空行能夠增長代碼的可讀性，一般在頂級定義（如函數或類的定義）之間空兩行，而方法定義之間空一行，另外在用於分隔某些功能的位置也能夠空一行；

        一般狀況下，在運算符兩側、函數參數之間以及逗號兩側，都建議使用空格進行分隔。

 

4.標識符命名規範

    標識符主要做用就是做爲變量、函數、類、模塊以及其餘對象的名稱，命名規則以下：

• 標識符是由字符（A~Z 和 a~z）、下劃線和數字組成，但第一個字符不能是數字;

• 標識符不能和 Python 中的保留字相同;

• Python中的標識符中，不能包含空格、@、% 以及 $ 等特殊字符;

• 標識符中的字母是嚴格區分大小寫的;

• 如下劃線開頭的標識符有特殊含義：

            以單下劃線開頭的標識符（如 _width），表示不能直接訪問的類屬性，其沒法經過 from...import* 的方式導入；

            以雙下劃線開頭的標識符（如__add）表示類的私有成員；

            以雙下劃線做爲開頭和結尾的標識符（如 __init__），是專用標識符；

• Python容許漢字做爲標識符，但應避免使用漢字做爲標識符；

• 當標識符用做模塊名時，應儘可能短小，而且所有使用小寫字母，可使用下劃線分割多個字母，例如 game_mian;

• 當標識符用做包的名稱時，應儘可能短小，也所有使用小寫字母，不推薦使用下劃線，例如 com.mr;

• 當標識符用做類名時，應採用單詞首字母大寫的形式。例如，定義一個圖書類，能夠命名爲 Book;

• 模塊內部的類名，能夠採用 "下劃線+首字母大寫" 的形式，如 _Book;

•  函數名、類中的屬性名和方法名，應所有使用小寫字母，多個單詞之間能夠用下劃線分割；

•  常量命名應所有使用大寫字母，單詞之間能夠用下劃線分割；

 

5.python關鍵字

    關鍵字是 Python 語言中一些已經被賦予特定意義的單詞，不能用這些保留字做爲標識符給變量、函數、類、模板以及其餘對象命名。

    使用如下命令查看關鍵字：

1 import keyword
2 keyword.kwlist

 

6.python內置函數

    使用內置函數做爲標識符不會報錯，但會致使同名函數被覆蓋，沒法使用。