Flaskのチュートリアル

Flask とは

Flask とは python の Web フレームワークです。python の Web フレームワークといえば他に Django や FastAPI などがあります。この中で Flask と FastAPI についてはマイクロフレームワークと呼ばれています。マイクロフレームワークとは必要最低限な機能のみを実装したフレームワークのため軽量です。Django はマイクロフレームワークに比べてユーザー認証や管理画面、キャッシュフレームワークなどさまざまな機能が用意されていて充実しています。機能が少ないマイクロフレームワークは機能が少ない分、軽量で学習コストが少なくすぐに実装に取り掛かれることがメリットになります。

Flask では 3 つの機能を実装することができます。

リクエスト : データを受け取ることができます。リクエストのパラメータについてはこちらとほほの Flask 入門に詳しく説明されています。
ルーティング : ユーザーのリクエスト内容とサーバーの処理を紐づける作業のこと
blueprint : アプリケーションの機能を分割することができます

Flask のチュートリアル

上で説明した各機能について確認しながら実装してみます

実装に伴い必要なライブラリや環境については用意してあるものとします。

初めに簡単な"Hello World"を表示するプログラムを app.py という名前で作成します。

ルーティング

from flask import Flask

app = Flask(__name__)

@app.route("/")
def hello_world():
  return "Hello World"

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

@app.route()でデコレートすることによって()内のディレクトリにアクセスするとデーコレーとされたメソッドが実行されるようになります。この処理が紐付けの部分になります。route のメソッドには GET と POST がありデフォルトでは GET に設定されています。ここではホームディレクトリにアクセスした際に hello_world が実行される形となっています。実行するためにはpython app.pyを行い指定された host へ接続すると Hello World が表示されます。

このサンプルプログラムでは直接 Hello World と表示させていますがより複雑な表示をさせたいときに html と python を混同させることは可読性の観点からもあまり良くありません。そこであらかじめ html のテンプレートを作成し render_template を使用することで html と python の混同を防ぐことができます。html のテンプレートとして sample.html というファイルがあるとしたときに render_template を使用すると以下のように書くことができます。

from flask import Flask, render_template

@app.route("/", methods=["GET", "POST"])
def hello_world():
  return render_template("sample.html")

リクエスト

ここで html ファイルについては詳しく載せませんが、ユーザー情報をフォームに送信する機能を持っているものとします。この時フォームに送信された情報を受け取りたい際にリクエストを使用します。html からはユーザー情報として first name と last name が POST 形式で送信されたとします。この時、送信された first name と last name を取得するためには以下のように書くことができます。

@app.route("/signup", methods=["POST"])
def singup():
  first_name = request.form.get("first_name")
  last_name = request.form.get("last_name")

ここでは値の取得のみを行っていますがこの値を html に渡すことで動的なページを作成することができます。

blueprint

blueprint ではページごとにファイルを分けることができます。まずはページの機能を一つのプログラムで記述すると以下のようになります。

from flask import Flask

app = Flask(__name__)

@app.route("/", methods=["POST"])
def hello_world():
  return render_template("sample.html")

@app.route("/signup", methods=["POST"])
def singup():
  first_name = request.form.get("first_name")
  last_name = request.form.get("last_name")

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

このプログラムをページの機能ごとにファイル分けをし blueprint を使用して同じ動作をするようなプログラムに変更します。

# Home.py

from flask import Flask, render_template

app = Flask(__name__)

@app.route("/", methods=["POST"])
def home():
  return render_template("sample.html")

# Signup.py

from flask import Flask

app = Flask(__name__)

@app.route("/signup", methods=["POST"])
def singup():
  first_name = request.form.get("first_name")
  last_name = request.form.get("last_name")

# app.py

from flask import Flask
# 分割したページのインポート
from Home import home
from Signup import signup

app = Flask(__name__)

# blueprintを登録
app.register_blueprint(home)
app.register_blueprint(signup)

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

このようにページごとにファイルを分けることができました。一度登録した blueprint は動的に削除することはできません。簡単なページを作成する際には blueprint を使用する必要はありませんが、複雑な Web ページや規模の大きな開発を行う際には管理を容易にするためにも blueprint が使われます。

まとめ

本記事では Flask についてまとめました。Flask は機能が限られている分学習難易度は低いです。実際にアプリケーションを開発しなくても Flask の機能を理解するだけでバックエンドの基本的な流れは把握できると思います。

参考

備考

Hakky ではエンジニアを募集中です！まずは話してみたいなどでも構いませんので、ぜひお気軽に採用ページからお問い合わせくださいませ。