Recommended
More Related Content
What's hot
What's hot (20)
Similar to 20190809
Similar to 20190809 (20)
More from iPride Co., Ltd.
More from iPride Co., Ltd. (20)
Recently uploaded
Recently uploaded (7)
20190809
- 2. 目次 • Flaskとは • Flaskのインストール • Hello worldまで • 任意のHTMLを 表示させたい • ルートに パラメータを持たせたい • CSSやJavaScriptを 読み込ませたい • PythonからHTMLに 引数を渡したい • formでの受け渡し • ルートに 階層を持たせたい • まとめ • 参考資料
- 3. Flaskとは • Pythonのウェブアプリケーションフレームワーク • 軽量で必要最低限の機能を搭載 → URLルーティング、テンプレート等のwebの基本は持っている → 学習コストが低い • つまり、Flaskは簡単なREST APIの作成に適してい る
- 4. Flaskのインストール • $ pip install flask • これだけ ※ インストールされたpythonバージョンによって pip3だったりする（IDEをインストールしよう） ※ Flask使用時は、 ファイル名に「flask.py」は使わないようにする
- 5. Hello worldまで 〜雛形コード〜 hello.py ~ ~ ~ ~ ~ from flask import Flask app = Flask(__name__) @app.route('/') def index(): return "Hello world" if __name__ == '__main__': app.debug = True app.run() ~ ~ ~ ~ ~ $ python hello.py
- 6. Hello worldまで ~解説（前半）~ from flask import Flask • Flaskパッケージのインポート app = Flask(__name__) • Flaskクラスのインスタンスを作ってappに代入 • __name__はPythonの特殊なグローバル変数の一つ → どこから呼ばれて実行されるかを格納している変数 → インポートからではモジュール名（今回はhello） → コマンドラインからでは__main__という文字列 → 値はpythonによって自動的に定義される
- 7. Hello worldまで ~解説（後半）~ @app.route('/') • 指定したエンドポイントにアクセスした際、このアノテーションが付けられた関数を呼び出す def index(): return "Hello world" if __name__ == '__main__': app.debug = True app.run() • Flaskアプリケーションの実行部分 • 今回はスクリプトを実行してコマンドラインから呼ばれるため、__name__は__main__になる • app.debug = Trueにすることにより、コードを修正＆保存するだけで再実行してくれる ↑ おすすめ ただし、毎回ファイルを探すため、対話モードで開発する場合はFalse推奨 • app.run()でFlaskアプリケーションの実行を定義している
- 8. Hello worldまで ~再掲~ hello.py ~ ~ ~ ~ ~ from flask import Flask app = Flask(__name__) @app.route('/') def index(): return "Hello world" if __name__ == '__main__': app.debug = True app.run() ~ ~ ~ ~ ~ $ python hello.py
- 9. 任意のHTMLを表示させたい from flask import Flask, render_template # ← render_templateを追加 app = Flask(__name__) @app.route('/') def index(): return render_template('index.html') # ← 任意のHTMLを記述 if __name__ == '__main__': app.debug = True app.run() ※HTMLファイルはtemplatesディレクトリ内に置く必要がある それ以外の名前にしたり、プロジェクト直下に置いたりすると、例外を返す jinja2.exceptions.TemplateNotFound
- 10. ルートにパラメータを持たせた い @app.route("/<name>") # ← <>内にパラメータ変数を記述 def hello_name(name): return "Hello {}".format(name)
- 11. CSSやJavaScriptを読み込ませたい • html内で{{url_for()}}を使って読み込み先を指定する <head> <link rel="stylesheet" href="{{url_for('static', filename='index.css')}}"> <script src="{{url_for('static', filename='index.js')}}"></script> </head> ※css、jsファイルはstaticディレクトリ内に置く必要がある それ以外から呼び出そうとするとエラーを返す werkzeug.routing.BuildError
- 12. pythonからHTMLに引数を渡したい 〜テンプレートエンジン〜 • FlaskではテンプレートエンジンのJinja2を利用することができる • Jinja2とは • Python用のテンプレート言語 • Djangoというテンプレートエンジンを模している • $ pip install Jinja2でインストール（IDEをインs…） • ちなみに名前の由来[1]は、 テンプレート→テンプル→寺→神社（日本の寺）→Jinja と、発音が似ているからだそうだ （公式さん…「神社」と「日本の寺」は違うのでは…） [ 公式ドキュメント参照
- 13. PythonからHTMLに引数を渡したい ~Python側~ @app.route('/temp') def temp(): s = "abc" lis = ["a1", "a2", "a3"] dic = {"name": "John", "age": 24} bl = True return render_template('temp.html', s=s, lis=lis, dic=dic, bl=bl) • python側では、render_templateの第2引数以降に渡す値を指定 • HTML側の変数=python側の変数
- 14. PythonからHTMLに引数を渡したい ~HTML側~ <body> <p>{{ s }}</p> <ul> {% for x in lis %} <li>{{ x }}</li> {% endfor %} </ul> <p>{{ "name: %s age: %s" % (dic["name"], dic["age"]) }}</p> {% if bl %} <p>True</p> {% else %} <p>False</p> {% endif %} </body> • HTML側では、Jinja2に則した方式で引数の受け取り口を作成
- 15. formでの受け渡し ~Python側~ @app.route('/form') def form(): return render_template('form.html') @app.route('/form_result', methods=['GET', 'POST']) def form_result(): if request.method == 'GET': res = request.args.get('get_value') + " from get" elif request.method == 'POST': res = request.form['post_value'] + " from post" return res • リクエストメソッドを記述する 例えば、GETだけならmethods=['GET']のみ なにも記述しない場合はデフォルトでGETリクエストがルーティングされる • 値を取得する場合は GETではrequest.args.get()関数 POSTではrequest.form[]関数
- 16. formでの受け渡し ~テンプレート側~ <form action="/form_result" method="get"> <input type="text" name="get_value" /> <button name="get_value">get submit</button> </form> <form action="/form_result" method="post"> <input type="text" name="post_value" /> <button name="post_value">post submit</button> </form> • formの書き方はHTMLリファレンスに準拠する • action属性にはリクエストの送信先エンドポイント • method属性にはリクエストメソッド
- 17. ルートに階層を持たせたい • Flaskでは機能を分割して実装することが可能な Blueprintというパッケージがある • Blueprintを利用することで 機能の管理やメンテナンスが容易になる → アプリ全体の管理ファイル → それと分割させたそれぞれの機能ファイル
- 19. ルートに階層を持たせたい ~機能ファイル作成手順~ 1. フォルダを作成、そこで機能ファイルを作成 2. Blueprintをインポート 3. Blueprintオブジェクトを作成（以下の設定を含める） • Blueprintオブジェクト名 • __name__（いつもの） • 分割エンドポイントの指定 • テンプレート操作パスの指定 ↑ 今回は使わないが、デフォルトのテンプレートフォルダから変更が可能 4. 通常通りにルーティング設定+処理
- 21. ルートに階層を持たせたい 〜管理ファイル〜 server.py ~ ~ ~ ~ ~ from flask import Flask from apps import root from apps import api from apps import func1 from apps import func2 app = Flask(__name__) # Blueprintを登録する app.register_blueprint(root.app) # / app.register_blueprint(api.app) # /api app.register_blueprint(func1.app) # /api/func1 app.register_blueprint(func2.app) # /api/func2 if __name__ == "__main__": app.debug = True app.run()
- 22. ルートに階層を持たせたい ~/~ root.py ~ ~ ~ ~ ~ from flask import render_template, Blueprint # 'root'という名前のBlueprintオブジェクトを生成 # "/"には分割エンドポイントの設定はしない app = Blueprint('root', __name__) # 以下「いつもの」 @app.route("/") def root(): return render_template('root.html')
- 23. ルートに階層を持たせたい ~/api~ api.py ~ ~ ~ ~ ~ from flask import render_template, Blueprint # 'api'という名前のBlueprintオブジェクトを生成 app = Blueprint('api', __name__) # 以下「いつもの」のエンドポイントについて、"/api"の後ろにまだ続くので、末尾に/を入れる @app.route("/api/") def root(): return render_template('api.html')
- 24. ルートに階層を持たせたい ~/func1 /func2~ func1.py（func2は割愛） ~ ~ ~ ~ ~ from flask import render_template, Blueprint # 'func1'という名前のBlueprintオブジェクトを生成 # "/func1"では'/api'の上に置くため分割エンドポイントを指定 app = Blueprint('func1', __name__, url_prefix='/api') # 以下「いつもの」 @app.route("/func1") def hello(): return render_template('func1.html')
- 25. ルートに階層を持たせたい ~HTML表記 上から下~ rootからapi <a href="./api">rootからapi</a> <a href="/api">rootからapi</a> apiからfunc1 <a href="./func1">apiからfunc1</a> <a href="/api/func1">apiからfunc1</a> rootからfunc1 <a href="./api/func1">rootからfunc1</a> <a href="/api/func1">rootからfunc1</a> func1からfunc2 <a href="./func2">func1からfunc2</a> <a href="/api/func2">func1からfunc2</a>
- 26. ルートに階層を持たせたい ~HTML表記 下から上~ func1からapi <a href="./">func1からapi</a> <a href="/api">func1からapi</a> apiからroot <a href="/">apiからroot</a> ❌<a href="./">apiからroot</a>はできない → "/"と同じ階層エンドポイントへの遷移では相対パスが使えない func1からroot <a href="../">func1からroot</a> <a href="/">func1からroot</a>
- 27. まとめ • FlaskはPythonのWebフレームワークであり、 軽量なので簡単なREST APIの作成に適切 • テンプレートエンジン（jinja2）を利用すると、 PythonとHTML間で値の受け渡しが容易 • 神社 ＝ 寺 • Blueprintで階層構造化&メンテナンス性向上
- 28. 参考資料 • Frequently Asked Questions — Jinja Documentation (2.10.x) • Flask を始めよう — Flask Handson 1 documentation.mhtml • [Python] Flask 入門 - ゾンビでもわかるPythonプログラミン グ • 【Flask入門】Python初心者でもわかるフレームワーク…｜ Udemy メディア • Flask入門 - Python学習講座
- 29. ご清聴 ありがとうございました