版權聲明:本文為CSDN博主「天元浪子」
原文連結:https://blog.csdn.net/xufive/article/details/84957425
python 文件的組成#!/usr/bin/env python# -*- coding: utf-8 -*-
"""通常這裡是關於本文檔的說明(docstring),須以半角的句號、 問號或驚嘆號結尾!
本行之前應當空一行,繼續完成關於本文檔的說明如果文檔說明可以在一行內結束,結尾的三個雙引號不需要換行;否則,就要像下面這樣"""
import os, timeimport datetimeimport math
import numpy as npimport xlrd, xlwt, xlutils
import youth_mongodbimport youth_curl
BASE_PATH = r"d:\YouthGit"LOG_FILE = u"運行日誌.txt"
class GameRoom(object): """對局室"""
def __init__(self, name, limit=100, **kwds): """構造函數!
name 對局室名字 limit 人數上限 kwds 參數字典 """
pass
def craete_and_start(): """創建並啟動對局室"""
pass
if __name__ == '__main__': # 開啟遊戲服務 start()
Linux 平臺上,一個 python 源碼文件應該以下部分組成。Windows 平臺上,可以省略第一項。解釋器聲明
編碼格式聲明
模塊注釋或文檔字符串
模塊導入
常量和全局變量聲明
頂級定義(函數或類定義)
執行代碼
編碼格式聲明
通常,編碼格式聲明是必需的。如果 python 源碼文件沒有聲明編碼格式,python 解釋器會默認使用 ASCII 編碼,一旦源碼文件包含非ASCII編碼的字符,python 解釋器就會報錯。以 UTF-8 為例,以下兩種編碼格式聲明都是合乎規則的。我一直 UTF-8 編碼格式,喜歡使用第一種聲明方式。Windows 平臺上,編碼格式聲明必須位於 python 文件的第一行。Linux 平臺上,編碼格式聲明通常位於 python 文件的第二行,第一行是 python 解釋器的路徑聲明。#!/usr/bin/env python# -*- coding: utf-8 -*-縮進統一使用 4 個空格進行縮進。絕對不要用tab, 也不要tab和空格混用。對於行連接的情況,我一般使用4空格的懸掛式縮進。例如:var_dict = { 'name': 'xufive', 'mail': 'xufive@sdysit.com'}引號文檔字符串 (docstring) 使用三個雙引號
注釋# 塊注釋 # 塊注釋 # # 塊注釋 # 塊注釋行內注釋,至少使用兩個空格和語句分開:
比較重要的注釋段, 使用多個等號隔開, 可以更加醒目, 突出重要性:server= gogame(room, options)
# ===================================== # 請勿在此處傾倒垃圾!!! # =====================================
if __name__ == '__main__': server.run()空行
空格
文檔字符串
文檔字符串是包、模塊、類或函數裡的第一個語句。這些字符串可以通過對象的__doc__成員被自動提取,並且被pydoc所用。文檔字符串的使用三重雙引號(""")。如果文檔字符串內容不能在一行內寫完,首行須以句號、 問號或驚嘆號結尾,接一空行,結束的三重雙引號必須獨佔一行。導入模塊
導入總應該放在文件頂部,位於模塊注釋和文檔字符串之後,模塊全局變量和常量之前。導入應該按照從最通用到最不通用的順序分組,分組之間空一行:標準庫導入
第三方庫導入
應用程式指定導入
模塊儘量使用小寫命名,首字母保持小寫,儘量不要用下劃線類名使用駝峰(CamelCase)命名風格,首字母大寫,私有類可用一個下劃線開頭回復關鍵字「簡明python 」,立即獲取入門必備書籍《簡明python教程》電子版
回復關鍵字「爬蟲」,立即獲取爬蟲學習資料