Python 標準庫 BaseHTTPServer 中文翻譯

標籤：python   文檔   

Python 標準庫 BaseHTTPServer 中文翻譯。

注意: BaseHTTPServer模組在Python3中已被合并到http.server，當轉換你的資源為 Python3 時 2to3 工具將自動適配匯入。

源碼：Lib/BaseHTTPServer.py

此模組定義了兩個類用於實現HTTP伺服器(Web servers)。通常，此模組不被直接使用，但是它用來作為基類建立功能性的Web servers。查看 SimpleHTTPServer 和 CGIHTTPServer 模組。

第一個類，HTTPServer，是一個 SocketServer.TCPServer 的子類，因此實現 SocketServer.BaseServer 的介面，它建立和監聽 HTTP socket，分配請求和處理，建立和運行server的代碼看起來是這樣的：

def run(server_class=BaseHTTPServer.HTTPServer,        handler_class=BaseHTTPServer.BaseHTTPRequestHandler):    server_address = (‘‘, 8000)    httpd = server_class(server_address, handler_class)    httpd.serve_forever()

Class BaseHTTPServer.HTTPServer(server_address, RequestHandlerClass)

此類建立在 TCPServer 上通過儲存伺服器位址作為執行個體變數名為 server_name 和 server_port，
伺服器可經由處理者進入，典型的是通過處理者的 server 執行個體變數。

class BaseHTTPServer.BaseHTTPRequestHandler(request, client_address, server)

這個類用來處理到達伺服器的 HTTP 要求，通過它自身，它不能響應任何實際的 HTTP 要求。它必須子類化來處理每個要求方法(例如：GET 或 POST)。BaseHTTPRequestHandler 提供一個若干類和執行個體變數，和可以通過子類使用的方法。

處理者將解析請求和頭資訊，然後調用一個請求類型的特定方法。方法名從請求構造。例子中，對於要求方法 SPAM，do_SPAM() 方法將會無參數調用。所有相關的資訊被儲存進處理者的執行個體變數。子類應該不需要覆寫或者擴充 __init__ 方法。

BaseHTTPServerHandler 有下列執行個體變數：

client_address

包含一個關於用戶端地址的結構為 (host, port) 的元祖。

server

包含server執行個體

command

包含命令(請求類型)，例子：‘GET‘。

path

包含請求路徑

request_version

包含請求的HTTP版本的字串，例子：‘HTTP/1.0‘。

headers

擁有一個通過 MessageClass 變數指定的類執行個體。這個執行個體解析和管理 HTTP 要求的頭資訊。

rfile

包含一個輸入資料流 stream，放置在輸入資料選項的開始。

wfile

包含輸出資料流用於回複一個響應response給用戶端client。當寫入這些stream時必須使用適當的HTTP協議。

BaseHTTPRequestHandler 有下列類變數：

server_vesion

指定伺服器版本，你也許會覆寫它。he format is multiple whitespace-separated strings, where each string is of the form name[/version]，例子：‘BaseHTTP/0.2‘。

sys_version

包含Python版本，通過 version_string 方法和 server_version 類變數使用。例子：‘Python/1.4‘。

error_message_format

指定一個格式化字串用於建立一個錯誤響應給用戶端。它使用弧括弧，鍵格式指定，所以格式運算元必須是一個字典。code key 應該是一個整數，指定HTTP錯誤碼值。message 應該是一個字串包含一個錯誤資訊的細節，explain 應該是一個錯誤碼數位解釋。預設 message 和 explain 的值能在 responses 類變數中被找到。

error_content_type

指定錯誤響應的 Content-Type HTTP 頭髮送給用戶端，預設值是 ‘text/html‘。

2.6新增，在以前，內容類型總是 ‘text/html‘

protocol_version

這個指定的HTTP協議版本用於響應，如果設定 ‘HTTP/1.1‘，伺服器會運行HTTP硬串連；無論如何，你的伺服器必須包含一個精確的 Content-Length 頭（使用 send_header()）在所有它響應的用戶端中。為了向後相容，預設設定為 ‘HTTP/1.0‘。

MessageClass

指定一個 rfc822.Message-like 類來解析HTTP頭。典型的，這不用覆寫，預設設定 mimetools.Message 。

responses

此變數包含一個錯誤碼數字和一個包含短和長資訊的2元祖的映射，例子： {code:(shrotmessage, longmessage)}。shortmessage 通常用於一個錯誤響應中的 message key，longmessage用來解釋（查看 error_message_format 類變數）。

一個 BaseHTTPRequestHandler 執行個體有以下方法：

handle()

召喚一次 handle_one_request() （或者，如果硬串連是啟用的，多次召喚）來響應來到的HTTP請求，你應該永遠不需要覆寫它；反而，實現適當的 do_* 方法。

handle_one_request()

這個方法將解析和分配請求給適配的 do_* 方法，你應該不需要覆寫它。

send_error(code[, message])

發送和記錄一個完整的錯誤回複給用戶端。code 指定HTTP錯誤碼，message 是可選的， 更多特定文本。一個完整的頭設定被發送，隨後使用 error_message_format 類變數排版文本。

send_response(code[,message])

發送一個回應標頭和記錄接受的請求，HTTP響應行被發送，然後是 Server 和 Data 頭，這兩個頭的值分別從 version_string 和 dare_time_string 方法拾起。

send_header(keyword, value)

向輸出資料流寫入一個指定的HTTP頭，ketword 應該指定頭關鍵字，value 指定它的值。

end_headers()

發送一個空白行，表面HTTP頭響應結束。

log_request([code[,size]])

記錄和接受(成功的)請求，code 應該指定為 HTTP code 和響應通訊，如果響應大小是有效，應該作為 size 參數。

log_error(…)

當一個請求不能被履行記錄一個錯誤，預設， 它把資訊傳給 log_message()，所以它獲得同樣的參數(格式的和附加的值)。

log_message(format, …)

記錄一個任意的資訊給 sys.tederr，這是典型的覆寫來建立定製錯誤資訊的原理。format參數是一個標準的 printf-style 格式化字串，在其他參數 log_message() 被用作輸入的格式。用戶端ip地址和當前日期和時間作為每一個資訊記錄(message logged)的首碼。

version_string()

返回伺服器軟體版本，這是一個 server_version 和 sys_version 類變數的組合。

date_time_string([timestamp])

返回由 timestramp 給予的日期和時間（這些必須通過 time.time() 格式返回），通過一個資訊頭來格式化，如果 timestamp 被省略，它將使用當前的日期和時間。

結果看上去像 ‘Sun, 06 Nov 1994 08:49:37 GMT‘。

2.5新增 timestamp 參數。

log_date_time_string()

返回當前日期和時間，logging格式。

address_string()

返回用戶端地址，logging格式，在用戶端IP地址執行一個名字尋找。

更多例子

建立一個不用一直迴圈啟動並執行伺服器，直到某些條件被滿足。

def run_while_true(server_class=BaseHTTPServer.HTTPServer,                   handler_class=BaseHTTPServer.BaseHTTPRequestHandler):    """    This assumes that keep_running() is a function of no arguments which    is tested initially and after each request.  If its return value    is true, the server continues.    """    server_address = (‘‘, 8000)    httpd = server_class(server_address, handler_class)    while keep_running():        httpd.handle_request()

附加：

模組: CGIHTTPServer
支援CGI指令碼的擴充請求處理。

模組: SimpleHTTPServer
實際上根文檔（document root）下限制響應到檔案的基礎請求處理。

著作權聲明：本文為博主原創文章，未經博主允許不得轉載。

Python 標準庫 BaseHTTPServer 中文翻譯