Flask入門

【概要】

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

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

前提知識：Pythonの基本文法，関数定義，デコレータ（関数の前に付けて，その関数に機能を追加する記法。@app.route() がこれにあたる）の概念。

【目次】

【関連する外部ページ】

【サイト内の関連情報】

前準備

Python 3.12 のインストール

Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

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

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

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして、コマンド全体をコマンドプロンプトにコピー＆ペーストする。

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

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; $c=[Environment]::GetEnvironmentVariable('Path','Machine'); if((Test-Path $p) -and (';'+$c+';' -notlike \"*;$p;*\") -and (';'+$c+';' -notlike \"*;$s;*\")){[Environment]::SetEnvironmentVariable('Path',\"$p;$s;$c\",'Machine')}"

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

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

インストールの確認

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

python --version

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

Python の開発環境 Visual Studio Code のインストールと Python 用の設定

Python の開発環境Visual Studio Code（プログラムを編集するソフトウェア。以下、VS Code）を整える。

[Windows での Visual Studio Code のインストールと Python 用の設定手順を見るには、ここをクリック]

Windows での Visual Studio Code のインストールと Python 用の設定手順

1. VS Code と拡張機能のインストール

以下のコマンドにより，既存の VS Code を削除し，全ユーザー共有の設定で再インストールしたうえで，拡張機能（VS Code に機能を追加するソフトウェア）をまとめて導入する．

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windows キーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして，コマンド全体をコマンドプロンプトにコピー＆ペーストする。

インストールコマンド


REM ============================================================
REM Microsoft Visual Studio Code
REM ============================================================
winget uninstall -e --id Microsoft.VisualStudioCode --silent --disable-interactivity --accept-source-agreements
rmdir /s /q C:\ProgramData\vscode-extensions 2>nul
rmdir /s /q "%APPDATA%\Code" 2>nul
rmdir /s /q "%USERPROFILE%\.vscode" 2>nul
rmdir /s /q "%LOCALAPPDATA%\Microsoft\vscode-update" 2>nul

REM VS Code をシステム領域に新規インストール
winget install --scope machine --id Microsoft.VisualStudioCode -e --silent --accept-source-agreements --accept-package-agreements

REM 全ユーザー共有の拡張機能フォルダ
mkdir C:\ProgramData\vscode-extensions 2>nul
icacls "C:\ProgramData\vscode-extensions" /grant "Everyone:(OI)(CI)M" /T

REM スタートメニューのショートカットを --extensions-dir 付きで再作成
rmdir /s /q "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code" 2>nul
del "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk" 2>nul
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); $lnk.TargetPath='C:\Program Files\Microsoft VS Code\Code.exe'; $lnk.Arguments='--extensions-dir \"C:\ProgramData\vscode-extensions\"'; $lnk.Save()"
REM ショートカットの検証
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); Write-Host 'TargetPath:' $lnk.TargetPath; Write-Host 'Arguments:' $lnk.Arguments"

REM ファイル / フォルダ右クリックの「Code で開く」を登録
reg add "HKLM\SOFTWARE\Classes\*\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\Background\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%V\"" /f

REM --extensions-dir 付きで起動する code.cmd ラッパを作成
REM （%* を echo で書くと対話的 cmd で失われるため、PowerShell で [char]37+'*' を書き出す）
powershell -NoProfile -Command "$pct=[char]37; $q=[char]34; $c='@echo off'+[char]13+[char]10+$q+'C:\Program Files\Microsoft VS Code\bin\code.cmd'+$q+' --extensions-dir '+$q+'C:\ProgramData\vscode-extensions'+$q+' '+$pct+'*'+[char]13+[char]10; [IO.File]::WriteAllText('C:\ProgramData\vscode-extensions\vscode.cmd',$c,[Text.Encoding]::ASCII)"

REM 拡張機能のインストール
set "CODE=C:\Program Files\Microsoft VS Code\bin\code.cmd"
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot-chat
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.python
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.vscode-pylance
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.debugpy
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension MS-CEINTL.vscode-language-pack-ja
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension saoudrizwan.claude-dev
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension rust-lang.rust-analyzer
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension tamasfe.even-better-toml
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension anthropic.claude-code
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension almenon.arepl
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --list-extensions --show-versions
echo === セットアップ完了 ===

2. Python インタプリタの選択

同一マシンに複数の Python がインストールされている場合，VS Code で使用する Python 本体（インタプリタ：Python プログラムを解釈・実行するソフトウェア）を選択する必要がある．

  1. コマンドパレット（コマンド名で機能を呼び出す VS Code の入力欄）を開く（Ctrl+Shift+P）
  2. Python: Select Interpreter と入力する
  3. 表示される一覧から，使用する Python（例：C:\Program Files\Python312\python.exe）を選択する．

Python プログラム実行手順

[Windows での Python プログラム実行手順を見るには、ここをクリック]

Windows での Python 実行手順（Visual Studio Codeを使用）

プログラムファイルの作成と保存

  1. 左サイドバーの「エクスプローラー」アイコン（Ctrl+Shift+E）をクリックする
  2. 「NO FOLDER OPENED」（作業対象フォルダが未選択の状態）と表示される場合は，「Open Folder」をクリックし，プログラムを保存するフォルダを選択する

    続いて「フォルダを信用するか」を確認する画面（フォルダ内のコードを実行してよいか確認する VS Code の仕組み）が表示されるので，チェックして Yes を選択する

  3. フォルダ名の右側に表示される「新しいファイル」アイコンをクリックする
  4. ファイル名（例：aitask.py．ファイル名は何でも良い）を入力し Enter を押す．拡張子は .py（Python ファイルを示す拡張子）とする
  5. 実行したいコードを選択し，Ctrl+C でコピーする．VS Code のエディタ領域に Ctrl+V で貼り付ける
  6. Ctrl+S で保存する

プログラムの実行

  1. エディタ右上の三角形「▷」アイコン（Run Python File：現在開いている Python ファイルを実行するボタン）をクリックする．または，エディタ上で右クリックし「ターミナルで Python ファイルを実行」を選択する
  2. VS Code 下部のターミナル（コマンドの入出力を表示する画面）に，実行結果（print 関数の出力等）が表示される
  3. tkinter（Python 標準の GUI ライブラリ）のファイル選択ダイアログを使うプログラムを実行した場合は，ダイアログが開くので対象画像を選択する
  4. VS Code 下部のターミナルで実行結果を確認する．OpenCV ウィンドウ（OpenCV が画像を表示するために開く専用ウィンドウ）が開いた場合はそちらも確認する．OpenCV ウィンドウは，マウスクリックでウィンドウをアクティブ（操作対象の状態）にしてからキーを押すと終了する

必要なライブラリのインストール

管理者権限でコマンドプロンプトを起動する （手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。

起動したコマンドプロンプトで次を実行する。

python -m pip install -U --no-user flask

バージョン確認

python -c "import importlib.metadata; print(importlib.metadata.version('flask'))"

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

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

各演習のソースコードをテキストエディタ（メモ帳等）に貼り付けて保存する（文字コード：UTF-8）。

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

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

実行コマンド

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

python a.py

動作確認チェックリスト

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

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

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

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

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

確認が終わったら，コマンドプロンプトで Ctrl+C を押してプログラムを終了する。

ルーティング

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

複数のURLパターン

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

URLパターンにおける変数

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

HTMLを返すルーティング

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

演習1　最小構成のWebアプリケーション

テーマ名：Flaskで最小構成のWebアプリケーションを動かす。

手順

  1. 次のコードを実行する（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）。
  2. Webブラウザで localhost:5000 にアクセスする。
  3. 確認が終わったら，コマンドプロンプトで Ctrl+C を押してプログラムを終了する。

ヒント：@app.route('/') は，ルートURL / へのアクセスと処理関数を対応付ける。

考察ポイント：処理関数が返した文字列が，そのままブラウザに表示されることを確認する。

from flask import Flask
app = Flask(__name__)

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

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

演習2　複数のURLパターンによるルーティング

テーマ名：複数のURLパターンと，変数を含むURLを扱う。

手順

  1. 次のコードを実行する（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）。
  2. Webブラウザで localhost:5000/user/kaneko にアクセスする。
  3. 確認が終わったら，コマンドプロンプトで Ctrl+C を押してプログラムを終了する。

ヒント：<username> は変数であり，URLの該当部分が処理関数の引数に渡される。

考察ポイント：/user/ に続けて入力した文字列が，応答にそのまま反映されることを確認する。

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)

演習3　HTMLを返すルーティング

テーマ名：文字列ではなくHTMLを返し，ページ間の遷移を確認する。

手順

  1. 次のコードを実行する（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）。
  2. Webブラウザで localhost:5000 と localhost:5000/about にアクセスする。
  3. 確認が終わったら，コマンドプロンプトで Ctrl+C を押してプログラムを終了する。

ヒント：処理関数が返した文字列がHTMLであれば，ブラウザはHTMLとして表示する。

考察ポイント：/about ページのリンクから / へ移動できることを確認する。

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)

まとめ

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形式の応答を返すこともでき，ページ間の遷移を実現できる。