編碼規範資料型別拓展

pep 8 – style guide for python code

python pep8 編碼規範中文版

當**不符合pep8規範時，**下方會出現波浪線。如：

**上方空行過多，達到3行：

逗號後面沒有留空格：

與**相矛盾的注釋比沒有注釋還糟糕，當**更改時，優先更新對應的注釋！

注釋應該是完整的句子。如果乙個注釋是乙個短語或者句子，它的第乙個單詞應該大寫，除非它是以小寫字母開頭的識別符號（永遠不要改變識別符號的大小寫！）

如果注釋很短，結尾的句號可以省略。塊注釋一般由完整句子的乙個或多個段落組成，並且每句話結束有個句號。

在句尾結束的時候應該使用兩個空格。

請使用英文寫注釋，除非你百分百確信你的**不會被使用其他語言的人閱讀。

行內注釋

文件字串

#  檢視模組文件字串  
print(requests.get.__doc__)
print(requests.post.__doc__)

sends a get request. :param url: url for the new :class:`request` object. :param params: (optional) dictionary, list of tuples or bytes to send in the query string for the :class:`request`. :param \*\*kwargs: optional arguments that ``request`` takes. :return: :class:`response ` object :rtype: requests.response sends a post request. :param url: url for the new :class:`request` object. :param data: (optional) dictionary, list of tuples, bytes, or file-like object to send in the body of the :class:`request`. :param json: (optional) json data to send in the body of the :class:`request`. :param \*\*kwargs: optional arguments that ``request`` takes. :return: :class:`response ` object :rtype: requests.response process finished with exit code 0

一般封裝的公共api需要寫文件字串。

函式命名

類命名

類裡面的方法和函式

單引號和雙引號字串是相通的。pep不會為這個給出建議。選擇一條規則並堅持使用下去。當乙個字串中包含單引號或者雙引號的時候，使用和最外層不同的符號來避免使用反斜槓，從而提高可讀性。

命名規範

模組匯入建議

模組匯入盡量放在py檔案頂部

#推薦
import requests
import os

#不推薦
import requests,os
```#也可以
from subprocess import popen,pipe

#盡量不要使用這種方式匯入
from os import *

模組匯入順序

先導入python的官方庫

再匯入安裝的第三方模組

最後匯入自定義的模組和包

編碼規範資料型別拓展

資料型別拓展

資料型別拓展

資料型別拓展

相關推薦