Flask Test Client API
FlaskClient はサーバーを起動せずにリクエストを送信し、レスポンスを検証できるシミュレートされたブラウザです。
を使用してapp.test_client()インスタンスを作成します。
テストクライアントの作成
| 方法 | 説明 |
|---|---|
| app.test_client(use_cookies=True) | 標準の作成方法。use_cookies=False で Cookie 処理を無効にします。 |
| with app.test_client() as client: | コンテキストマネージャー。終了時にリクエストコンテキストを自動的にクリーンアップします。 |
リクエストメソッド
すべてのメソッドが返すのはTestResponseResponse から継承したオブジェクトです。
| メソッド | 説明 |
|---|---|
| get(path, **kwargs) | GET リクエストを送信する |
| post(path, **kwargs) | POST リクエストを送信する |
| put(path, **kwargs) | PUT リクエストを送信する |
| delete(path, **kwargs) | DELETE リクエストを送信する |
| patch(path, **kwargs) | PATCH リクエストを送信する |
| open(path, method, **kwargs) | 汎用リクエストメソッド。method を明示的に指定する必要があります。 |
リクエストパラメータ(kwargs)
| パラメータ | 説明 |
|---|---|
| data | リクエストボディ(文字列またはバイト)。フォーム送信用。 |
| json | JSON データ。自動的にシリアライズされ、Content-Type: application/json が設定されます。 |
| query_string | URL クエリパラメータの文字列または辞書。 |
| headers | リクエストヘッダーの辞書。 |
| content_type | カスタム Content-Type。 |
| follow_redirects | bool。リダイレクトを自動的に追跡するかどうか。デフォルトは False。 |
| buffered | bool。レスポンスをバッファリングするかどうか。デフォルトは False。 |
レスポンスオブジェクト(TestResponse)
| 属性/メソッド | 説明 |
|---|---|
| status_code | HTTP ステータスコード(int) |
| status | HTTP ステータステキスト、例:"200 OK" |
| data | レスポンスボディ(bytes) |
| text | テキスト形式でレスポンスボディを取得(str) |
| get_json() | レスポンスボディを JSON として解析します。dict または list を返します。 |
| headers | レスポンスヘッダー(Headers オブジェクト) |
| location | リダイレクト先の URL(3xx レスポンスのみ) |
| json_module | JSON シリアライズに使用するモジュール(デフォルトは app.json) |
Session テスト
| メソッド | 説明 |
|---|---|
| session_transaction(**kwargs) | コンテキストマネージャー。session を直接読み書きするために使用します。SessionMixin オブジェクトを返します。 |
コード例
実例
from app import create_app
app = create_app()
app.config["TESTING"] = True
def test_api():
with app.test_client() as client:
# GET リクエスト
resp = client.get("/api/posts")
assert resp.status_code == 200
data = resp.get_json()
assert isinstance(data, list)
# POST JSON リクエスト
resp = client.post("/api/posts", json={
"title": "サンプル チュートリアル",
"body": "入門コンテンツ"
})
assert resp.status_code == 201
assert resp.get_json()["title"] == "サンプル チュートリアル"
# クエリパラメータ付きのリクエスト
resp = client.get("/search?q=flask")
assert b"flask" in resp.data
# ログイン済み状態をシミュレート
with client.session_transaction() as sess:
sess["username"] = "サンプル"
resp = client.get("/dashboard")
assert b"サンプル" in resp.data
# リダイレクトを追跡
resp = client.post("/login", data={
"username": "admin"
}, follow_redirects=True)
assert resp.status_code == 200
app = create_app()
app.config["TESTING"] = True
def test_api():
with app.test_client() as client:
# GET リクエスト
resp = client.get("/api/posts")
assert resp.status_code == 200
data = resp.get_json()
assert isinstance(data, list)
# POST JSON リクエスト
resp = client.post("/api/posts", json={
"title": "サンプル チュートリアル",
"body": "入門コンテンツ"
})
assert resp.status_code == 201
assert resp.get_json()["title"] == "サンプル チュートリアル"
# クエリパラメータ付きのリクエスト
resp = client.get("/search?q=flask")
assert b"flask" in resp.data
# ログイン済み状態をシミュレート
with client.session_transaction() as sess:
sess["username"] = "サンプル"
resp = client.get("/dashboard")
assert b"サンプル" in resp.data
# リダイレクトを追跡
resp = client.post("/login", data={
"username": "admin"
}, follow_redirects=True)
assert resp.status_code == 200