Flask ビュー関数
ビュー関数は Flask アプリケーションの中心的な部分であり、リクエストを処理してレスポンスを生成します。
ビュー関数はルーティングと密接に関連し、ルーティングによって URL を特定のビュー関数にマッピングします。
以下では、Flask ビュー関数について、定義方法、リクエストデータの使用、レスポンスの返し方、エラー処理などを含めて詳しく説明します。
- ビュー関数の定義:ビュー関数は、リクエストを処理してレスポンスを返す中心的な機能です。
- リクエストデータの受け取り:使用
requestオブジェクトを使用して URL パラメータ、フォームデータ、クエリパラメータなどを取得します。 - レスポンスの返却:文字列、HTML、JSON、またはカスタムレスポンスオブジェクトを返すことができます。
- リクエストとレスポンスの処理:使用
requestオブジェクトとmake_responseを使用してリクエストを処理し、カスタムレスポンスを生成します。 - エラー処理:ビュー関数内で例外を処理するか、Flask のエラー処理メカニズムを使用します。
- ビュー関数のデコレータ:使用
@app.before_request、@app.after_requestなどのデコレータでリクエスト前後のロジックを処理します。 - ビュー関数が返すステータスコード:HTTP ステータスコードを指定して、リクエストの処理結果を表すことができます。
1. ビュー関数を定義する
ビュー関数は通常の Python 関数であり、リクエストを受け取りレスポンスを返します。ビュー関数は通常ルーティングと組み合わせて使用され、デコレータによって URL をビュー関数にマッピングします。
例
app = Flask(__name__)
@app.route('/')
def home():
return 'Hello, World!'
@app.route('/'):ルート URL を/マッピングする先はhomeビュー関数です。def home():ビュー関数は文字列を返す'Hello, World!'レスポンスとして。
2. リクエストデータを受け取る
ビュー関数は、URL パラメータ、フォームデータ、クエリパラメータなど、さまざまなタイプのリクエストデータを受け取ることができます。
URL パラメータの取得:
例
def greet(name):
return f'Hello, {name}!'
<name>URL パラメータであり、ビュー関数に渡されます。greet。
フォームデータの取得:
例
@app.route('/submit', methods=['POST'])
def submit():
username = request.form.get('username')
return f'Form submitted by {username}!'
request.form.get('username'):POST リクエストのフォームデータ内の username フィールドを取得します。
クエリパラメータの取得:
例
def search():
query = request.args.get('query')
return f'Search results for: {query}'
request.args.get('query'):GET リクエストのクエリパラメータ query を取得します。
3. レスポンスを返す
ビュー関数は、文字列、HTML、JSON、またはカスタムレスポンスオブジェクトなど、さまざまなタイプのレスポンスを返すことができます。
文字列を返す:
例
def message():
return 'This is a simple message.'
HTML テンプレートを返す:
例
@app.route('/hello/<name>')
def hello(name):
return render_template('hello.html', name=name)
render_template('hello.html', name=name):HTML テンプレート hello.html をレンダリングし、name 変数をテンプレートに渡します。
JSON データを返す:
例
@app.route('/api/data')
def api_data():
data = {'key': 'value'}
return jsonify(data)
jsonify(data):Python の辞書を JSON レスポンスに変換します。
カスタムレスポンスオブジェクトを返す:
例
@app.route('/custom')
def custom_response():
response = Response('Custom response with headers', status=200)
response.headers['X-Custom-Header'] = 'Value'
return response
Response('Custom response with headers', status=200):カスタムレスポンスオブジェクトを作成し、レスポンスヘッダーを設定します。
4. リクエストとレスポンスを処理する
ビュー関数はリクエストオブジェクトにアクセスし、リクエストデータに基づいてレスポンスを生成できます。request オブジェクトを使用してリクエストの情報を取得し、make_response を使用してカスタムレスポンスを作成できます。
request オブジェクトを使用する:
例
@app.route('/info')
def info():
user_agent = request.headers.get('User-Agent')
return f'Your user agent is {user_agent}'
request.headers.get('User-Agent'):リクエストヘッダー内の User-Agent 情報を取得します。
make_response を使用する:
例
@app.route('/header')
def custom_header():
response = make_response('Response with custom header')
response.headers['X-Custom-Header'] = 'Value'
return response
make_response('Response with custom header'):レスポンスオブジェクトを作成し、カスタムヘッダー情報を設定します。
5. エラーを処理する
ビュー関数内で例外やエラーを処理するか、Flask が提供するエラー処理メカニズムを使用してアプリケーション内のエラーを処理できます。
ビュー関数内でエラーを処理する:
例
def divide(x, y):
try:
result = x / y
return f'Result: {result}'
except ZeroDivisionError:
return 'Error: Division by zero', 400
try-except 文を使用してゼロ除算エラーを処理し、カスタムエラーメッセージとステータスコードを返します。
グローバルエラー処理:
例
def not_found(error):
return 'Page not found', 404
@app.errorhandler(404):404 エラーを処理する関数を定義します。
6. ビュー関数のデコレータ
@app.route に加えて、Flask はより複雑な機能を実装するための他のデコレータもサポートしています。
例:
@app.before_request:各リクエストの処理前に実行される関数。@app.after_request:各リクエストの処理後に実行される関数。@app.teardown_request:リクエスト終了後に実行され、クリーンアップ作業を行う関数。
デコレータの使用例:
例
def before_request():
print('Before request')
@app.after_request
def after_request(response):
print('After request')
return response
@app.teardown_request
def teardown_request(exception):
print('Teardown request')
7. ビュー関数が返すステータスコード
ビュー関数はコンテンツを返すだけでなく、HTTP ステータスコードを指定することもできます。
例
def status():
return 'Everything is OK', 200
ステータスコード 200 を返すと、リクエストが成功したことを表します。
ステータスコード付きのレスポンスオブジェクトを返す:
例
@app.route('/error')
def error():
return Response('An error occurred', status=500)
ステータスコード 500 を返すと、サーバー内部エラーを表します。
その他の拡張