我的 Python 編碼規(guī)范
版權聲明：本文為CSDN博主「天元浪子」?
原文鏈接：https://blog.csdn.net/xufive/article/details/84957425
python 文件的組成
#!/usr/bin/env python# -*- coding: utf-8 -*-"""通常這里是關于本文檔的說明（docstring），須以半角的句號、 問號或驚嘆號結尾!本行之前應當空一行，繼續(xù)完成關于本文檔的說明如果文檔說明可以在一行內結束，結尾的三個雙引號不需要換行；否則，就要像下面這樣"""import os, timeimport datetimeimport mathimport numpy as npimport xlrd, xlwt, xlutilsimport youth_mongodbimport youth_curlBASE_PATH = r"d:\YouthGit"LOG_FILE = u"運行日志.txt"class GameRoom(object):"""對局室"""def __init__(self, name, limit=100, **kwds):"""構造函數!name 對局室名字limit 人數上限kwds 參數字典"""passdef craete_and_start():"""創(chuàng)建并啟動對局室"""passif __name__ == '__main__':# 開啟游戲服務start()
解釋器聲明
編碼格式聲明
模塊注釋或文檔字符串
模塊導入
常量和全局變量聲明
頂級定義（函數或類定義）
執(zhí)行代碼
編碼格式聲明
# -*- coding: utf-8 -*-# coding = utf-8#!/usr/bin/env python# -*- coding: utf-8 -*-
縮進
var_dict = {'name': 'xufive','mail': '[email protected]'}
引號
自然語言使用雙引號 機器標識使用單引號 正則表達式使用雙引號 文檔字符串 (docstring) 使用三個雙引號
注釋
# 塊注釋# 塊注釋## 塊注釋# 塊注釋
行內注釋，至少使用兩個空格和語句分開：
age += 1 # 年齡增加一歲server= gogame(room, options)# =====================================# 請勿在此處傾倒垃圾!!!# =====================================if __name__ == '__main__':server.run()
空行
編碼格式聲明、模塊導入、常量和全局變量聲明、頂級定義和執(zhí)行代碼之間空兩行
頂級定義之間空兩行，方法定義之間空一行
在函數或方法內部，可以在必要的地方空一行以增強節(jié)奏感，但應避免連續(xù)空行
空格
在二元運算符兩邊各空一格，算術操作符兩邊的空格可靈活使用，但兩側務必要保持一致
不要在逗號、分號、冒號前面加空格，但應該在它們后面加（除非在行尾）
函數的參數列表中，逗號之后要有空格
函數的參數列表中，默認值等號兩邊不要添加空格
左括號之后，右括號之前不要加添加空格
參數列表， 索引或切片的左括號前不應加空格
文檔字符串
導入模塊
標準庫導入
第三方庫導入
應用程序指定導入
from math import *模塊盡量使用小寫命名，首字母保持小寫，盡量不要用下劃線 類名使用駝峰(CamelCase)命名風格，首字母大寫，私有類可用一個下劃線開頭 函數名一律小寫，如有多個單詞，用下劃線隔開 私有函數可用一個下劃線開頭 變量名盡量小寫, 如有多個單詞，用下劃線隔開 常量采用全大寫，如有多個單詞，使用下劃線隔開
—?完?—
回復關鍵字“簡明python ”，立即獲取入門必備書籍《簡明python教程》電子版
回復關鍵字“爬蟲”，立即獲取爬蟲學習資料
python入門與進階 每天與你一起成長 推薦閱讀
點「在看」的人都變好看了哦！
評論
圖片
表情