Python 標准庫 BaseHTTPServer 中文翻譯。
注意: BaseHTTPServer模塊在Python3中已被合並到http.server,當轉換你的資源為 Python3 時 2to3 工具將自己主動適配導入。
此模塊定義了兩個類用於實現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
包括一個關於client地址的結構為 (host, port)
的元祖。
server
包括server實例
command
包括命令(請求類型),樣例:'GET'
。
path
包括請求路徑
request_version
包括請求的HTTP版本號的字符串,樣例:'HTTP/1.0'
。
headers
擁有一個通過 MessageClass 變量指定的類實例。
這個實例解析和管理 HTTP 請求的頭信息。
rfile
包括一個輸入流 stream,放置在輸入數據選項的開始。
wfile
包括輸出流用於回復一個響應response給clientclient。當寫入這些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
指定一個格式化字符串用於創建一個錯誤響應給client。
它使用弧括號。鍵格式指定,所以格式操作數必須是一個字典。
code key 應該是一個整數。指定HTTP錯誤碼值。message 應該是一個字符串包括一個錯誤信息的細節,explain 應該是一個錯誤碼數字的解釋。缺省 message 和 explain 的值能在 responses 類變量中被找到。
error_content_type
指定錯誤響應的 Content-Type HTTP 頭發送給client,缺省值是 'text/html'
。
2.6新增,在曾經,內容類型總是 'text/html'
protocol_version
這個指定的HTTP協議版本號用於響應,假設設置 'HTTP/1.1'
。服務器會執行HTTP硬連接;不管怎樣,你的服務器必須包括一個精確的 Content-Length
頭(使用 send_header())在全部它響應的client中。
為了向后兼容,默認設置為 '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])
發送和記錄一個完整的錯誤回復給client。
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() 被用作輸入的格式。clientip地址和當前日期和時間作為每個信息記錄(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()
返回client地址。logging格式。在clientIP地址執行一個名字查找。
很多其它樣例
創建一個不用一直循環執行的服務器,直到某些條件被滿足。
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)下限制響應到文件的基礎請求處理。