也許你經(jīng)常需要對你的的應(yīng)用進行單元測試或者僅僅檢查 Python session 的輸出。理論上講這是很簡單的,你可以偽造一個環(huán)境,通過一個假的 start_response 遍歷應(yīng)用,但是這里還有一個更好的方法。
Werkzeug 提供了一個 Client 對象,可以傳入一個 WSGI 應(yīng)用(可選傳入一個 response),通過這個你可以向應(yīng)用發(fā)出一個虛擬請求。
用三個參數(shù)調(diào)用一個 response: 應(yīng)用迭代器、狀態(tài)和一個 headers。默認 response 返回一個元組。因為 response 對象有相同的簽名,所以你可以像使用 response 一樣使用他們。通過這樣一種方式進行測試功能是很理想的。
>>> from werkzeug.test import Client
>>> from werkzeug.testapp import test_app
>>> from werkzeug.wrappers import BaseResponse
>>> c = Client(test_app, BaseResponse)
>>> resp = c.get('/')
>>> resp.status_code
200
>>> resp.headers
Headers([('Content-Type', 'text/html; charset=utf-8'), ('Content-Length', '8339')])
>>> resp.data.splitlines()[0]
'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"'
或默認沒有 response:
>>> c = Client(test_app)
>>> app_iter, status, headers = c.get('/')
>>> status
'200 OK'
>>> headers
[('Content-Type', 'text/html; charset=utf-8'), ('Content-Length', '8339')]
>>> ''.join(app_iter).splitlines()[0]
'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"'
0.5 新版功能.
交互測試應(yīng)用 最簡單的方法是使用 EnvironBuilder 類。它可以創(chuàng)建標(biāo)準(zhǔn) WSGI環(huán)境和請求對象。
下面的例子創(chuàng)建了一個上傳文件和文件表單的 WSGI 環(huán)境:
>>> from werkzeug.test import EnvironBuilder
>>> from StringIO import StringIO
>>> builder = EnvironBuilder(method='POST', data={'foo': 'this is some text',
... 'file': (StringIO('my file contents'), 'test.txt')})
>>> env = builder.get_environ()
返回的環(huán)境是一個新的 WSGI 環(huán)境,可用于進一步的處理:
>>> from werkzeug.wrappers import Request
>>> req = Request(env)
>>> req.form['foo']
u'this is some text'
>>> req.files['file']
<FileStorage: u'test.txt' ('text/plain')>
>>> req.files['file'].read()
'my file contents'
當(dāng)你將一個字典傳給構(gòu)造函數(shù)數(shù)據(jù), EnvironBuilder 會自動自動找出內(nèi)容類型。如過你傳的似乎一個字符串或者輸入字符流,你不得不自己來做這些處理。
默認地它將會嘗試使用 application/x-www-form-urlencoded ,如果文件被上傳則只使用 multipart/form-data :
>>> builder = EnvironBuilder(method='POST', data={'foo': 'bar'})
>>> builder.content_type
'application/x-www-form-urlencoded'
>>> builder.files['foo'] = StringIO('contents')
>>> builder.content_type
'multipart/form-data'
如果傳入一個字符串(或一個輸入流),你必須自己指定內(nèi)容的類型:
>>> builder = EnvironBuilder(method='POST', data='{"json": "this is"}')
>>> builder.content_type
>>> builder.content_type = 'application/json'
class tests.EnvironBuilder(path='/', base_url=None, query_string=None, method='GET', input_stream=None, content_type=None, content_length=None, errors_stream=None, multithread=False, multiprocess=False, run_once=False, headers=None, data=None, environ_base=None, environ_overrides=None, charset='utf-8')
這個類為了測試可以方便的創(chuàng)建一個 WSGI 環(huán)境。他可以從任意數(shù)據(jù)快速創(chuàng)建 WSGI環(huán)境或請求對象。
這個類的簽名也可用于 Werkzeug 的其他地方(create_environ(), BaseResponse.from_values(), Client.open())。因為大多數(shù)功能只可通過構(gòu)造函數(shù)實現(xiàn)。
文件和表格數(shù)據(jù)可以被各自的 form 和 files 屬性獨立處理。但是以相同的參數(shù)傳入構(gòu)造函數(shù):data。
data 可以是這些值:
a dict: 如果是一個字典,鍵將是一個字符串,值是以下對象:
0.6 新版功能: path 和 base_url 現(xiàn)在是 unicode 字符串,它可以使用 iri_to_uri()函數(shù)編碼。
參數(shù): |
|
---|
path
應(yīng)用的地址。(又叫 PATH_INFO)
charset
編碼 unicode 數(shù)據(jù)的字符集。
headers
一個帶著請求 headers的 Headers 對象。
errors_stream
用于 wsgi.errors 流的錯誤流。
multithread
wsgi.multithread 的值。
multiprocess
wsgi.multiprocess 的值。
environ_base
新創(chuàng)建環(huán)境的基本字典。
environ_overrides
用于覆蓋生成環(huán)境的帶值字典。
input_stream
可選選項輸入流。這個和 form / files 是相互獨立的。同時如果請求方法不是 POST / PUT 或其他類似方法,不要提供輸入流。
args
URL 參數(shù)是 MultiDict。
base_url
base URL 是一個用于提取 WSGI URL ,主機(服務(wù)器名 + 服務(wù)器端口) 和根腳本 (SCRIPT_NAME) 的 URL
close()
關(guān)閉所有文件。如果把 file 對象放入 files 字典,你可以通過調(diào)用這個方法自動關(guān)閉他們。
content_length
整數(shù)的長度,反射給 headers。如果你設(shè)置了 files 或 form屬性不要設(shè)置這個參數(shù)。
content_type
請求的內(nèi)容類型。反射給 headers。如果你設(shè)置了 files 和form 屬性就不能設(shè)置內(nèi)容類型。
get_environ()
返回內(nèi)置環(huán)境。
get_request(cls=None)
返回一個帶數(shù)據(jù)的請求。如果沒有指定請求類,將會是用 request_class。
input_stream
一個可選的輸入流。如果你設(shè)置它,將會清空 form 和 files。
query_string
查詢字符串。如果你設(shè)置它, args 屬性將不再可用。
request_class
默認的請求類 get_request()。
BaseRequest 的別名
server_name
服務(wù)器名 (只讀, 使用 host 設(shè)置)
server_port
整型服務(wù)器接口(只讀,使用 host 設(shè)置)
server_protocol = 'HTTP/1.1'
服務(wù)器使用協(xié)議。默認為 HTTP/1.1
wsgi_version = (1, 0)
使用的 WSGI 版本。默認為(1, 0)。
class tests.Client(application, response_wrapper=None, use_cookies=True, allow_subdomain_redirects=False)
這個類允許你發(fā)送請求給一個包裹的應(yīng)用。
響應(yīng)可以是一個類或者一個有三個參數(shù)工廠函數(shù): app_iter, status and headers。默認的響應(yīng)僅僅是一個元組。
例如:
class ClientResponse(BaseResponse):
...
client = Client(MyApplication(), response_wrapper=ClientResponse)
use_cookies 參數(shù)默認是開啟的,無論 cookies 是否被存儲,他都會和請求一起傳輸。但是你也可以關(guān)閉 cookie。
如果你想要請求應(yīng)用的子域名,你可以設(shè)置 allow_subdomain_redirects 為 True ,如果為 False ,將不允許外部重定向。
0.5 新版功能: use_cookies 是在這個版本添加的。老版本不提供內(nèi)置 cookie 支持。
open(options)
和 EnvironBuilder 一樣的參數(shù)還有一些補充: 你可以提供一個EnvironBuilder 類或一個 WSGI 環(huán)境代替 EnvironBuilder類作為參數(shù)。同時有兩個可選參數(shù) (as_tuple, buffered),可以改變返回值的類型或應(yīng)用執(zhí)行方法。
在 0.5 版更改: 如果為 data 參數(shù)提供一個帶文件的字典,那么內(nèi)容類型必須為 content_type而不是 mimetype。這個改變是為了和 werkzeug.FileWrapper 保持一致。
follow_redirects 參數(shù)被添加到 open().
Additional parameters:
參數(shù): |
|
---|
get(options)
和 open 相似,但是方法強制執(zhí)行 GET。
post(options)
和 open 相似,但是方法強制執(zhí)行 POST。
put(options)
和 open 相似,但是方法強制執(zhí)行 PUT。
delete(options)
和 open 相似,但是方法強制執(zhí)行 DELETE。
head(options)
和 open 相似,但是方法強制執(zhí)行 HEAD。
tests.create_environ([options])
根據(jù)傳入的值創(chuàng)建一個 WSGI 環(huán)境。第一個參數(shù)應(yīng)該是請求的路徑,默認為 ‘/'。另一個參數(shù)或者是一個絕對路徑(在這個例子中主機是 localhost:80)或請求的完整路徑,端口和腳本路徑。
它和 EnvironBuilder 構(gòu)造函數(shù)接受相同的參數(shù)。
在 0.5 版更改: 這個函數(shù)現(xiàn)在是一個 EnvironBuilder 包裹,在 0.5 版本被添加。需要 headers, environ_base, environ_overrides 和 charset 參數(shù)。
tests.run_wsgi_app(app, environ, buffered=False)
返回一個應(yīng)用輸出的元組形式 (app_iter, status, headers)。如果你通過應(yīng)用返回一個迭代器他將會工作的更好。
有時應(yīng)用可以使用 start_ewsponse 返回的 write() 回調(diào)函數(shù)。這將會自動解決邊界情況。如果沒有得到預(yù)期輸出,你應(yīng)該將 buffered 設(shè)為 True 執(zhí)行buffering
如果傳入一個錯誤的應(yīng)用,這個函數(shù)將會是未定義的。不要給這個函數(shù)傳入一個不標(biāo)準(zhǔn)的 WSGI 應(yīng)用。
參數(shù): |
|
---|---|
返回: | 元組形式 (app_iter, status, headers) |
更多建議: