python編碼規範

2022-06-24 22:27:22 字數 955 閱讀 7460

一、pep8規範

1、縮排

對齊縮排、懸掛縮排、層級縮排

2、行的最大長度

最大限制為79、超過最大行用 \ 進行隱式換行

3、空行

頂層函式和類的定義,前後用兩個空行隔開、類裡的方法定義用乙個空行隔開

4、注釋

行內注釋、塊注釋、文件字串注釋(檢視模組的文件字串注釋:.__doc__)

5、命名約定

變數命名(不能以l(小寫l),o(大寫o),i(大寫i)命名)

函式命名(盡量小寫,或者加下劃線)

類命名(首字母大寫)

6、字串引號

單雙引號:外層引號使用和記憶體引號不一樣來避免用反斜槓

7、模組和包匯入規範包

模組名稱要短,使用小寫,避免使用特殊符號

模組匯入建議:from modu import *(差)、from modu import sqrt(稍好)、import modu (最好)

__all__變數(只會匯入該變數中指定的模組)

包:含__init.py檔案的叫做python包、匯入包時自動執行init檔案

二、pep257規範

python文件字串相關聯的語義和約定

三、工程結構化

readme:對專案的整體介紹,同時也是乙份使用手冊,通常為readme.rst/readme.md

license:闡述該項目的許可說明和授權

setup.py:通過setup把核心**打包發布

專案目錄:存放專案的核心**

requiremente.txt:存放該專案所有依賴的第三方庫

tests:所有的**測試都歸存放於該目錄下

makefile:用於專案的命令管理(開源專案廣泛使用)根據專案需求新增其他的檔案和目錄

Python編碼規範

usr bin python 應用程式要定義main函式而不要直接寫指令碼 def main dosomething if name main main 如果是全域性變數,則需要顯式加上 global python 的注釋分為兩種的概念,一種是由 開頭的 真正的 注釋,另一種是 docstrings...

Python編碼規範

usr bin python 應用程式要定義main函式而不要直接寫指令碼 def main dosomething if name main main 如果是全域性變數,則需要顯式加上 global python 的注釋分為兩種的概念,一種是由 開頭的 真正的 注釋,另一種是 docstrings...

python編碼規範

pep8編碼標準 編寫 1,使用4個空格進行退進,不使用tab鍵,不允許tab和空格混用 2,每行最大長度79位元組,超過部分使用反斜槓折行 3,類和全域性函式定義間隔兩個空行,類內方法定義間隔乙個空行,類內方法定義間隔乙個空行,其他地方不加空行 文件編排 1.import 部分按標準,三方和自己編...