武富士の亡霊に取り憑かれた弁護士【しくじり企業L】～東京ミネルヴァ～
主に「事業」という観点からの感想です。
「Head First Python 第2版」を進めていった中で考えたことの記録です。
Head First Python 第2版 ―頭とからだで覚えるPythonの基本
from flask import Flask, render_template, request, redirect from vsearch import search4letters app = Flask(__name__) @app.route('/') def hello() -> '302': return redirect('/entry') @app.route('/entry') def entry_page() -> str: return render_template( 'entry.html', the_title='Web版のsearch4lettersにようこそ！' ) app.run()
上記コードをpyコマンドで実行した上で、http://127.0.0.1:5000にアクセスすると、実行されているWebアプリケーションは以下のようなログを返します。
127.0.0.1 - - [23/Feb/2021 09:53:34] "GET / HTTP/1.1" 302 - 127.0.0.1 - - [23/Feb/2021 09:53:35] "GET /entry HTTP/1.1" 200 -
HTTPステータスコードの300番台はリダイレクトを表します。この例では、Webアプリケーションは以下のような動作をしているわけです。
/にGETメソッドでアクセスされると、/entryへのリダイレクトを返す/entryへのGETリクエストが送出される/entryへのGETリクエストが正常に処理されるentry.htmlの内容が返されるFlaskにおいてリダイレクトを行わせるには、flaskライブラリに含まれるredirect関数を使用します。当然ながら、redirect関数のインポートという操作が必要になります。以下は、redirectを含むflaskライブラリの関数・クラス群をインポートするimport文の例です。
from flask import Flask, render_template, request, redirect
Flaskでは、複数のWebページのロケーションに同一の関数を割り付けることも可能です。下記コードは、「entry_page関数を、/と/entryという2つのリソースに割り付ける」というPythonコードの例です。
from flask import Flask, render_template, request from vsearch import search4letters app = Flask(__name__) @app.route('/') @app.route('/entry') def entry_page() -> str: return render_template( 'entry.html', the_title='Web版のsearch4lettersにようこそ！' ) app.run()
上記コードをpyコマンドで実行した上で、http://127.0.0.1:5000にアクセスすると、実行されているWebアプリケーションは以下のようなログを返します。
127.0.0.1 - - [23/Feb/2021 09:55:47] "GET / HTTP/1.1" 200 - 127.0.0.1 - - [23/Feb/2021 10:11:17] "GET /entry HTTP/1.1" 200 -
この例では、Webアプリケーションは以下のような動作をしています。
/ではなく/entryに直接アクセスした場合も同様の動作となります。
「entry_page関数を、/と/entryという2つのリソースに割り付ける」という記述は、Pythonコード側における以下の記述が対応しています。
@app.route('/') @app.route('/entry') def entry_page() -> str:
単純に@app.routeデコレータをentry_page関数の定義の前に2つ書いているだけですね。このように記述しておけば、あとはFlaskが良い感じに処理してくれます。
「Head First Python 第2版」を進めていった中で考えたことの記録です。
Head First Python 第2版 ―頭とからだで覚えるPythonの基本
from flask import Flask, render_template, request from vsearch import search4letters # ...略... @app.route('/search4', methods=['POST']) def do_search() -> str: phrase = request.form['phrase'] letters = request.form['letters'] return str(search4letters(phrase, letters))
上記は、Flaskを用いて構築した、POSTリクエストを受け付けるWebアプリケーションの例となります。
from flask import Flask, render_template, request
flaskライブラリに含まれる関数・クラスのうち、Flaskクラスとrender_template関数は、これまでに実装してきた機能を使うために必要であった関数・クラスです。
今回新たに、requestという組み込みオブジェクトをflaskライブラリからインポートしています。requestオブジェクトは、HTTPのリクエストデータをWebアプリケーションで扱うために必要となる関数です。
phrase = request.form['phrase'] letters = request.form['letters']
flaskライブラリのrequestオブジェクトには、ポストされてきたHTTPリクエストに含まれるHTMLフォームのデータにアクセスするための辞書属性formが含まれます。request.formの内容はPythonの辞書で、各要素のキーはHTMLフォームの各name属性の値となります。例えば、name属性の値がphraseであるinput要素の内容にWebアプリケーション側からアクセスするためには、request.form['phrase']という属性にアクセスすればよいということになるわけです。
<form method='POST' action='/search4'> <p>このフォームを使って検索リクエストを送ってください。</p> <table> <tr><td>フレーズ:</td><td><input name='phrase' type='TEXT' width='60'></td></tr> <tr><td>文字:</td><td><input name='letters' type='TEXT' value='aeiou'></td></tr> </table> <p>準備ができたら、以下のボタンを押してください。</p> <p><input value='実行！' type='SUBMIT'></p> </form>
上述HTMLマークアップは、上述Pythonコードで処理するための入力データを生成するHTMLフォームの例です。このHTMLフォームのSUBMIT処理を実行すると、上述Pythonコードは以下の動作を行います。
name属性の値がphraseであるinput要素に入力された文字列を変数phraseに代入するname属性の値がlettersであるinput要素に入力された文字列を変数lettersに代入するcurlコマンド等を用い、当該HTMLフォームにより生成されるリクエストと同等のPOSTリクエストを直接投入することも可能です。当該リクエストの必要条件は以下となります。
return str(search4letters(phrase, letters))
このreturn文に対応する関数do_searchは、「/search4というURLを持つリソースに対するPOSTリクエスト」に割り付けられたものです。前項で内容を定義したphraseおよびletters両変数を引数として、search4letters関数を呼び出しています。結果、当該search4letters関数の戻り値は、POSTリクエストの結果としてWebアプリケーションからWebブラウザに返されることとなるわけです。
WindowsでHTTPのPOSTリクエストを直接投げるためには、curl.exeを用いるのが手っ取り早い方法です。
-X POSTというオプション指定で、POSTリクエストを投げるようにする-F 'パラメータ名=パラメータ値'というオプションを付ける
-Fオプションを必要な数だけ列挙する事前に対象となるWebアプリケーションを起動した上で、http://127.0.0.1:5000/search4にphraseパラメータとlettersパラメータを含むPOSTリクエストを送出するコマンドを送出してみます。実行結果は、例えば以下のようになります。
PS C:\webapp> curl.exe -X POST -F 'phrase=hogehoge' -F 'letters=aeiou' http://127.0.0.1:5000/search4
{'o', 'e'}
「Head First Python 第2版」を進めていった中で考えたことの記録です。
Head First Python 第2版 ―頭とからだで覚えるPythonの基本
from flask import Flask, render_template from vsearch import search4letters app = Flask(__name__) # ...略... @app.route('/entry') def entry_page() -> str: return render_template('entry.html', the_title='Web版のsearch4lettersにようこそ！') app.run()
from flask import Flask, render_template
FlaskによるWebアプリケーションでテンプレートエンジンを使う操作は、flaskライブラリのrender_template関数1に定義されています。Webアプリケーションに「テンプレートに基づいたHTMLを返す」という動作を実装するためには、同関数をインポートする必要があります。
というわけで、flaskライブラリからインポートする関数として、render_templateを新たに追加しています。Flaskクラスのほうは、基本的なWebアプリケーションを定義する段階で既にインポートしていたものです。
@app.route('/entry') def entry_page() -> str: return render_template('entry.html', the_title='Web版のsearch4lettersにようこそ！')
先程importしたflaskライブラリのrender_template関数を用いて、/entryというURLにアクセスした際に返されるHTMLの内容を定義しています。Webブラウザの利用者側から見た全体動作としては、「第1引数で与えたテンプレートの内容を元にして、内部でJinja2テンプレートエンジンを用い、キーワード引数の内容も含めたHTTPレスポンスボディ内容を返す2」という動作をします。
render_templateの第1引数であるentry.htmlの内容については、下記記事のうち、項「入力フォーム」に記載しています。ベーステンプレートであるbase.htmlは、entry.htmlの内部で呼び出されています。
render_templateのキーワード引数the_titleは、テンプレート中の以下の記述に対応するものです。
<title>{{ the_title }}</title>
↑ベーステンプレートbase.html中のtitle要素の中身
<h2>{{ the_title }}</h2>
↑入力フォームテンプレートentry.html中のh2要素の中身
キーワード引数the_titleが存在することにより、実際に生成されるHTMLのうち、上記2つの要素の内容には「Web版のsearch4lettersにようこそ！」という文字列が設定されることになります。
「Head First Python 第2版」を進めていった中で考えたことの記録です。
Head First Python 第2版 ―頭とからだで覚えるPythonの基本
↑入力フォームのイメージ
↑処理結果のイメージ
上述表示内容のWebページを得るために、以下3つのJinja2テンプレートを定義します。
Flaskで用いられるテンプレートエンジンです。Flaskにおいては、以下の目的でJinja2テンプレートエンジンを用いています。
<!DOCTYPE html>
<html>
<head>
<title>{{ the_title }}</title>
<link rel="stylesheet" href="static/hf.css">
</head>
<body>
{% block body %}
{% endblock %}
</body>
</html>
他のHTMLファイルの内容をインポートして使うためのテンプレートです。解説は以下の通りです。
static/hf.cssというファイルの内容が用いられる
body要素以下の内容は、他のHTMLファイルをインポートすることを前提とする
{% block body %}から{% endblock %}までの間が置き換えられて埋め込まれる{% extends 'base.html' %}
{% block body %}
<h2>{{ the_title }}</h2>
<form method='POST' action='/search4'>
<table>
<p>このフォームを使って検索リクエストを送ってください。</p>
<tr><td>フレーズ:</td><td><input name='phrase' type='TEXT' width='60'></td></tr>
<tr><td>文字:</td><td><input name='letters' type='TEXT' value='aeiou'></td></tr>
</table>
<p>準備ができたら、以下のボタンを押してください。</p>
<p><input value='実行！' type='SUBMIT'></p>
</form>
{% endblock %}
入力フォームのHTMLマークアップの内容です。解説は以下の通りです。
base.htmlを継承し、その中にインポートされる
{% block_body %}から{% endblock %}までの間が、entry.htmlの同内容に置き換えられるthe_titleというキーワード引数が必要となるPOSTメソッドによって/search4というリソースに渡されるphraseという属性名で、文字列を内容とする属性を渡すlettersという属性名で、文字列を内容とする属性を渡す/search4に割り付けられるアプリケーションには、以下の処理を行う機能が必要となる
POSTメソッドのリクエストを受け付ける機能phraseで、内容が文字列である属性を処理する機能lettersで、内容が文字列である属性を処理する機能{% extends 'base.html' %}
{% block body %}
<h2>{{ the_title }}</h2>
<p>以下のデータを送信しました。</p>
<table>
<tr><td>フレーズ:</td><td>{{ the_phrase }}</td></tr>
<tr><td>文字:</td><td>{{ the_letters }}</td></tr>
</table>
<p>「{{ the_phrase }}から{{ the_letters }}」を検索すると、次の結果を返します。</p>
<h3>{{ the_results }}</h3>
{% endblock %}
base.htmlを継承し、その中にインポートされる
{% block_body %}から{% endblock %}までの間が、entry.htmlの同内容に置き換えられるthe_titleというキーワード引数が必要となるthe_phrasethe_lettersthe_results「Head First Python 第2版」を進めていった中で考えたことの記録です。
Head First Python 第2版 ―頭とからだで覚えるPythonの基本
この記事では、「Pythonで書いた既存関数の機能を、Flaskを用いてWebに公開する」という内容について解説しています。
def search4letters(phrase: str, letters: str = 'aeiou') -> set: """phrase内のlettersの集合を返す。""" return set(letters).intersection(set(phrase))
上記内容のモジュールが、vsearchとしてsite-packages1にインストールされていることを前提とします。
from flask import Flask from vsearch import search4letters app = Flask(__name__) @app.route('/') def hello() -> str: return 'Hello world from Flask!' @app.route('/search4') def do_search() -> str: return str(search4letters( phrase='life, the universe, and everything!', letters='eiru!' )) app.run()
実際のWebアプリケーションのPythonコードは上記となります。動作の解説は以下です。
/search4というパスに対し、do_search()関数の結果を出力するdo_search()関数の中で、search4letters()関数を呼び出している
search4letters()関数を呼び出すために、vsearchモジュールからsearch4letters関数をインポートしているsearch4letters()関数の結果は、str()メソッドを用いて明示的に文字列に変換している
search4letters()関数の結果は、そのままだとPythonの集合形式となるため上記内容のコードを、任意の場所にhello_flask.pyとして保存します。
前述のhello_flask.pyを実行し、Webサーバーを起動します。
Webサーバーの起動後にWebブラウザでhttp://127.0.0.1:5000/search4にアクセスすると、ブラウザ画面に「{'e', 'i', '!', 'u', 'r'}」と出力されます2。
また、Flaskアプリケーションが実行されているコンソールに以下のメッセージが表示されます。
127.0.0.1 - - [09/Feb/2021 06:15:41] "GET / HTTP/1.1" 200 -
なお、現時点でリソース/に割り付けられているのは上述hello()関数であるため、http://127.0.0.1:5000/にアクセスすると、"Hello world from Flask!"というメッセージが表示されます。
「Head First Python 第2版」を進めていった中で考えたことの記録です。
Head First Python 第2版 ―頭とからだで覚えるPythonの基本
今回は、「最も基本的なWebアプリケーション」の各行の動作についての解説です。
from flask import Flask app = Flask(__name__) @app.route('/') def hello() -> str: return 'Hello world from Flask!' app.run()
上記は、「Flaskを用いてWebアプリケーションを定義し、実際にWebサーバーを起動する」という動作をする最も基本的なコードです。具体的には以下の動作をします。
flaskモジュールからFlaskクラスをインポートするFlaskクラスのインスタンスappを生成するFlaskクラスのインポートfrom flask import Flask
flaskモジュールからFlaskクラスをインポートします。
Flaskクラスは、「Webサーバーを稼働させるために必要なデータと関数をひとかたまりとした設計図」といえるFlaskクラスのインスタンスの生成app = Flask(__name__)
Flaskクラスのインスタンスを生成し、新たな変数appに代入します。
__name__は、「アクティブなモジュールの名前」を意味するPythonの特殊キーワードである
@app.route('/')
Pythonのデコレータ機能を用いて、関数をURLに割り付けます。ここでは@app.route('/')というデコレータを定義しています。
@で始まる文がデコレータ構文@app.route('/')というデコレータ構文の意味
/」に割り付けられることを意味するrouteデコレータがいかなる意味を持つか」については、Flaskクラスにて定義されているdef hello() -> str: return 'Hello world from Flask!'
@app.route('/')というデコレータが適用される関数は、hello()関数です。hello()関数そのものは、一般的なPythonの関数です。
app.run()
Flaskクラスのインスタンスのrun()メソッドを実行すると、Webサーバが起動されます。
127.0.0.1である5000番である