Flask入門

1. エグゼクティブサマリー

Flaskは，PythonのWebアプリケーションフレームワークである。このページでは，FlaskのインストールからWebサーバの起動，ルーティングの基本までを説明する。

Flaskは，Webサーバの機能を内蔵し，リクエストURLを解析して処理と応答を行うプログラムを簡潔に記述できる。URLパターンと処理関数の対応付け，変数を含むURLの処理，HTML形式の応答の返却といったルーティング機能を備える。

前提知識：Pythonの基本文法，関数定義，デコレータの概念

2. 前準備（必要ソフトウェアの入手）

ここでは、最低限の事前準備について説明する。機械学習や深層学習を行う場合は、NVIDIA CUDA、Visual Studio、Cursorなどを追加でインストールすると便利である。これらについては別ページ https://www.kkaneko.jp/cc/dev/aiassist.htmlで詳しく解説しているので、必要に応じて参照してください。

Python 3.12 のインストール（Windows 上） [クリックして展開]

以下のいずれかの方法で Python 3.12 をインストールする。Python がインストール済みの場合、この手順は不要である。

方法1：winget によるインストール

管理者権限のコマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。

winget install --scope machine --id Python.Python.3.12 -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_pip=1 Include_test=0 Include_launcher=1 InstallLauncherAllUsers=1"

--scope machine を指定することで、システム全体（全ユーザー向け）にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動すると PATH が自動的に設定される。

方法2：インストーラーによるインストール

Python 公式サイト（https://www.python.org/downloads/）にアクセスし、「Download Python 3.x.x」ボタンから Windows 用インストーラーをダウンロードする。
ダウンロードしたインストーラーを実行する。
初期画面の下部に表示される「Add python.exe to PATH」に必ずチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号（例：Python 3.12.x）が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

AIエディタ Windsurf のインストール（Windows 上） [クリックして展開]

Pythonプログラムの編集・実行には、AIエディタの利用を推奨する。ここでは、Windsurfのインストールを説明する。Windsurf がインストール済みの場合、この手順は不要である。

winget install --scope machine --id Codeium.Windsurf -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --custom "/SP- /SUPPRESSMSGBOXES /NORESTART /CLOSEAPPLICATIONS /DIR=""C:\Program Files\Windsurf"" /MERGETASKS=!runcode,addtopath,associatewithfiles,!desktopicon"
powershell -Command "$env:Path=[System.Environment]::GetEnvironmentVariable('Path','Machine')+';'+[System.Environment]::GetEnvironmentVariable('Path','User'); windsurf --install-extension MS-CEINTL.vscode-language-pack-ja --force; windsurf --install-extension ms-python.python --force; windsurf --install-extension Codeium.windsurfPyright --force"

【関連する外部ページ】

Windsurf の公式ページ: https://windsurf.com/

必要なライブラリのインストール [クリックして展開]

python -m pip install -U simplejson flask

バージョン確認

python -c "import flask; print(flask.__version__)"

3. 実行のための準備とその確認手順（Windows 前提）

3.1 プログラムファイルの準備

第5章のソースコードをテキストエディタ（メモ帳等）に貼り付け，hoge.py として保存する（文字コード：UTF-8）。

コマンドプロンプトで次を実行すると，メモ帳で hoge.py を作成・編集できる。

cd /d c:%HOMEPATH%
notepad hoge.py

3.2 実行コマンド

コマンドプロンプトでファイルの保存先ディレクトリに移動し，以下を実行する。

python hoge.py

3.3 動作確認チェックリスト

確認項目	期待される結果
`localhost:5000` にアクセス	「Hello, World!」が表示される
`localhost:5000/hello` にアクセス	「hello」が表示される
`localhost:5000/user/kaneko` にアクセス	「user kaneko」が表示される
`localhost:5000/about` にアクセス	「About」見出しと「Home」へのリンクが表示される

4. 概要・使い方・実行上の注意

4.1 Flaskアプリケーションの基本構造

Flaskを使用した最小構成のWebアプリケーションの構成要素は以下のとおりである。ソースコードは第5章に掲載する。

Flask(__name__)：Flaskアプリケーションのインスタンスを生成する
@app.route('/')：リクエストURL / に対する処理を定義するデコレータである
app.run()：Webサーバを起動する。この例ではポート番号5000で起動する

Webブラウザで localhost:5000 にアクセスし，次のような画面が表示されれば動作は正常である。

確認が終わったらプログラムを終了する。

4.2 ルーティング

ルーティングとは，リクエストURLに応じて実行する処理を振り分ける仕組みである。@app.route() デコレータでURLパターンと処理関数を対応付ける。

4.3 複数のURLパターン

第5章のルーティングのプログラムでは，3つのURLパターンを定義している。

/：処理関数 root()，ルートURLへのアクセス
/hello：処理関数 hello()，/hello へのアクセス
/user/<username>：処理関数 user(username)，変数を含むURL

4.4 URLパターンにおける変数

<username> のように山括弧で囲んだ部分は変数として扱われる。たとえば /user/1 にアクセスすると username に 1 が格納され，/user/tanaka の場合は tanaka が格納される。

4.5 ルーティングの動作確認

プログラムを実行する。

Webブラウザで localhost:5000/user/kaneko にアクセスし，次のような画面が表示されれば動作は正常である。

確認が終わったらプログラムを終了する。

4.6 HTMLを返すルーティング

これまでの例では単純な文字列を返していたが，HTMLを返すことも可能である。第5章のHTMLを返すプログラムでは，/ と /about の2つのルートがHTML文字列を返す。/about ページには / へのリンクが含まれており，ページ間の遷移を確認できる。

5. ソースコード

5.1 最小構成のWebアプリケーション

Flaskを使用した最小構成のWebアプリケーションである。hoge.pyのファイル名で保存する。

from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello, World!'

app.run(host="0.0.0.0", port=5000)

5.2 複数のURLパターンによるルーティング

hoge.pyのファイル名で保存する。

from flask import Flask
app = Flask(__name__)

@app.route('/')
def root():
    return 'root'

@app.route('/hello')
def hello():
    return 'hello'

@app.route('/user/<username>')
def user(username):
    return f'user {username}'

app.run(host="0.0.0.0", port=5000)

5.3 HTMLを返すルーティング

hoge.pyのファイル名で保存する。

from flask import Flask
app = Flask(__name__)

@app.route('/')
def index():
    return '<html><body><h1>Welcome</h1><p>This is a Flask app.</p></body></html>'

@app.route('/about')
def about():
    return '<html><body><h1>About</h1><p><a href="/">Home</a></p></body></html>'

app.run(host="0.0.0.0", port=5000)

6. まとめ

Flask：リクエストURLを解析し，処理と応答を行うプログラムを簡潔に記述できるPythonのWebアプリケーションフレームワークである。Webサーバの機能を内蔵しており，app.run() で host と port を指定してWebサーバを起動する。

ルーティング：リクエストURLに応じて実行する処理を振り分ける仕組みである。@app.route() デコレータでURLパターンと処理関数を対応付ける。

URLパターンにおける変数：<username> のように山括弧で囲んだ部分は変数として扱われ，リクエストURLの該当部分が処理関数の引数に格納される。

Webサーバ：HTTPメソッドとリクエストURLを受け取って処理と応答を行うサーバである。HTTPメソッドにはGET（取得），POST（送信），PUT（更新），DELETE（削除）がある。

HTMLを返す応答：ルーティングでは単純な文字列だけでなく，HTML形式の応答を返すことも可能であり，ページ間の遷移を実現できる。