Flask フォーム処理

Flask では、フォーム処理は Web アプリケーションを構築する際の一般的な要件です。

フォームデータの処理には、ユーザーが送信したフォームの受信、検証、処理が含まれます。Flask は基本的なフォーム処理機能を提供しますが、通常は Flask-WTF 拡張機能と組み合わせてフォーム操作と検証を簡素化します。

  1. 基本的なフォーム処理:使用しrequest.formフォームデータを取得します。
  2. Flask-WTF の使用:WTForms と組み合わせてフォーム処理と検証を行い、フォーム操作を簡素化します。
  3. フォーム検証:バリデータを使用してフォームデータの有効性を確保します。
  4. ファイルアップロード:ファイルのアップロードと保存を処理します。
  5. CSRF 保護:フォームをクロスサイトリクエストフォージェリ攻撃から保護します。

1. 基本的なフォーム処理

Flask はフォームデータを直接処理する方法を提供し、request オブジェクトを使用して送信されたデータを取得します。

HTML フォームを作成する

templates/form.html ファイルのコード:

例

<!DOCTYPE html>
<html>
<head>
    <title>Form Example</title>
</head>
<body>
    <form action="/submit" method="post">
        <label for="name">Name:</label>
        <input type="text" id="name" name="name">
        <br>
        <label for="email">Email:</label>
        <input type="email" id="email" name="email">
        <br>
        <input type="submit" value="Submit">
    </form>
</body>
</html>

action="../submit":フォームデータは /submit パスに送信されます。

method="post":POST メソッドを使用してデータを送信します。

フォームデータの処理

app.py ファイルのコード:

例

from flask import Flask, render_template, request

app = Flask(__name__)

@app.route('/')
def form():
    return render_template('form.html')

@app.route('/submit', methods=['POST'])
def submit():
    name = request.form.get('name')
    email = request.form.get('email')
    return f'Name: {name}, Email: {email}'

if __name__ == '__main__':
    app.run(debug=True)

request.form.get('name')とrequest.form.get('email'):送信されたフォームデータを取得します。

2. Flask-WTF 拡張機能を使用する

Flask-WTF は WTForms をラップした拡張機能で、フォーム処理と検証の機能を提供し、フォーム処理をより簡潔かつ強力にします。

Flask-WTF のインストール

pip install flask-wtf
Flask-WTF の設定

app.py ファイルのコード:

例

from flask import Flask, render_template, redirect, url_for
from flask_wtf import FlaskForm
from wtforms import StringField, EmailField, SubmitField
from wtforms.validators import DataRequired, Email

app = Flask(__name__)
app.secret_key = 'your_secret_key'  # Required for form protection

class MyForm(FlaskForm):
    name = StringField('Name', validators=[DataRequired()])
    email = EmailField('Email', validators=[DataRequired(), Email()])
    submit = SubmitField('Submit')

@app.route('/', methods=['GET', 'POST'])
def form():
    form = MyForm()
    if form.validate_on_submit():
        name = form.name.data
        email = form.email.data
        return f'Name: {name}, Email: {email}'
    return render_template('form.html', form=form)

if __name__ == '__main__':
    app.run(debug=True)

Flask-WTF フォームをサポートするテンプレートを作成する

templates/form.html ファイルのコード:

例

<!DOCTYPE html>
<html>
<head>
    <title>Form Example</title>
</head>
<body>
    <form method="post">
        {{ form.hidden_tag() }}
        <div>
            {{ form.name.label }}<br>
            {{ form.name(size=32) }}
        </div>
        <div>
            {{ form.email.label }}<br>
            {{ form.email(size=32) }}
        </div>
        <div>
            {{ form.submit() }}
        </div>
    </form>
</body>
</html>

{{ form.hidden_tag() }}:フォームを CSRF 攻撃から保護するための隠しフィールドを生成します。

{{ form.name.label }}と{{ form.name(size=32) }}:フォームフィールドとそのラベルをレンダリングします。

3. フォーム検証

Flask-WTF と WTForms は豊富なフォーム検証機能を提供します。組み込みのバリデータまたはカスタムバリデータを使用して、フォームデータの有効性を確保できます。

例

from wtforms import Form, StringField, EmailField, SubmitField
from wtforms.validators import DataRequired, Email, Length

class MyForm(FlaskForm):
    name = StringField('Name', validators=[
        DataRequired(), Length(min=1, max=50)
    ])
    email = EmailField('Email', validators=[
        DataRequired(), Email()
    ])
    submit = SubmitField('Submit')
  • DataRequired():フィールドが空でないことを確認します。
  • Length(min=1, max=50):文字列の最小長と最大長を制限します。
  • Email():フィールドが有効なメールアドレスかどうかを検証します。

4. ファイルアップロード

Flask はファイルアップロードの処理もサポートしています。アップロードされたファイルにはrequest.filesからアクセスできます。

ファイルアップロードフォームを作成する

templates/upload.html ファイルのコード:

例

<!DOCTYPE html>
<html>
<head>
    <title>Upload File</title>
</head>
<body>
    <form action="/upload" method="post" enctype="multipart/form-data">
        <label for="file">File:</label>
        <input type="file" id="file" name="file">
        <br>
        <input type="submit" value="Upload">
    </form>
</body>
</html>

enctype="multipart/form-data":フォームデータのエンコーディングタイプを指定し、ファイルアップロードをサポートします。

ファイルアップロードの処理

app.py ファイルのコード:

例

from flask import Flask, request, redirect, url_for

app = Flask(__name__)
app.secret_key = 'your_secret_key'

@app.route('/upload', methods=['POST'])
def upload():
    file = request.files.get('file')
    if file:
        filename = file.filename
        file.save(f'uploads/{filename}')
        return f'File uploaded successfully: {filename}'
    return 'No file uploaded'

if __name__ == '__main__':
    app.run(debug=True)

request.files.get('file'):アップロードされたファイルオブジェクトを取得します。

file.save(f'uploads/{filename}'):ファイルを指定したディレクトリに保存します。

5. CSRF 保護

Flask-WTF はフォームに CSRF 保護を自動的に提供します。CSRF 保護を有効にするにはシークレットキーを設定し、テンプレートに隠し CSRF トークンを含める必要があります。

CSRF 保護の設定

app.secret_key = 'your_secret_key'

テンプレートに CSRF トークンを追加します:

例

<form method="post">
    {{ form.hidden_tag() }}
    <!-- Form fields here -->
</form>
その他の拡張機能