菜鸟阅读 Flask ソースコードシリーズ（1）：Flaskのルーター初探

文章来源：itsCoder の WeeklyBolg プロジェクト

itsCoder ホームページ：http://itscoder.com/

作者：コードを書く香港の記者

审阅者：Brucezz

前言#

完全なオープンソースプロジェクトの読解経験がないプログラマーは不合格なプログラマーです。以前に Redis などのプロジェクトのソースコードを部分的に読んだことはありますが、完全なオープンソースプロジェクトの読解経験はありません。そのため、ある先輩の勧めを受けて、Flask をオープンソースソースコード読解の最初のプロジェクトとして選ぶことにしました。このシリーズの記事は、私自身の読書ノートとして、以前あまり重視していなかった Python の多くの詳細を強化するためのものです。

Flask について#

Flask の背景知識については、あまり説明する必要はありません。インターネット上にはすでに多くの資料があります。Flask を使用する際、私たちはしばしば次のような方法でカスタムルートを設定します：

##Flask公式Exampleのflaskrプロジェクトの一部コード
app = Flask(__name__)

@app.route('/')
def show_entries():
    db = get_db()
    cur = db.execute('select title, text from entries order by id desc')
    entries = cur.fetchall()
    return render_template('show_entries.html', entries=entries)


@app.route('/add', methods=['POST'])
def add_entry():
    if not session.get('logged_in'):
        abort(401)
    db = get_db()
    db.execute('insert into entries (title, text) values (?, ?)',
                 [request.form['title'], request.form['text']])
    db.commit()
    flash('新しいエントリーが正常に投稿されました')
    return redirect(url_for('show_entries'))


@app.route('/login', methods=['GET', 'POST'])
def login():
    error = None
    if request.method == 'POST':
        if request.form['username'] != app.config['USERNAME']:
            error = '無効なユーザー名'
        elif request.form['password'] != app.config['PASSWORD']:
            error = '無効なパスワード'
        else:
            session['logged_in'] = True
            flash('ログインしました')
            return redirect(url_for('show_entries'))
    return render_template('login.html', error=error)

さて、問題です。上記の例では、app.route('xxxx',methods=['xxx']) が対応するメソッドと対応する URL の関連付けを設定することがわかりますが、このような方法はどのように機能するのでしょうか？

Flask ソースコード読解#

最初のルーターはどのようなものか見てみましょう#

まず、Flask から Flask のソースコードを取得し、バージョン番号を最初の 0.1 バージョン（git tag は 8605cc310d260c3b08160881b09da26c2cc95f8d）に切り替えます。

小さなヒント：オープンソースプロジェクトを読む際、現在のバージョンが複雑すぎる場合は、プロジェクトの最初にリリースされたバージョンに切り替え、各プロジェクトバージョンのリリースノートに従って進めてください。

flask.py ファイルの中で、次のような構造を見ることができます。

正直なところ、この時点で Flask の route のコアコードを見ることができます。

def route(self, rule, **options):
    def decorator(f):
        self.add_url_rule(rule, f.__name__, **options)
        self.view_functions[f.__name__] = f
        return f
    return decorator

以前のコードの app.route('/') は本質的にデコレーターを呼び出して、対応するメソッドとリクエストを関連付けていることが明確にわかります。route メソッドがトリガーされると、さらに add_url_rule を呼び出して設定した URL を登録します。

def add_url_rule(self, rule, endpoint, **options):
    options['endpoint'] = endpoint
    options.setdefault('methods', ('GET',))
    self.url_map.add(Rule(rule, **options))

最初のバージョンの Flask では、Router の実装は非常にシンプルです。

デコレーターに関する 2 つの知識ポイント#

最初のポイント：多くの人が疑問に思うでしょう。以前のコードでは、関連するメソッドを呼び出していないのに、デコレーターはなぜトリガーされるのでしょうか？

答え：まず、デコレーターの役割は何かを大声で教えてください。明らかに、元のコードを変更せずに関数をラップし、元のメソッドに特別な機能を追加することです。抽象的に感じますか？では、例を見てみましょう。

def testDe1(func):
    def de(a, b, c):
        func(a, b, c)
        print('1')
    print('2')
    return de

@testDe1
def test2(a, b, c):
    print(a+b+c)
if __name__ == '__main__':
    test2(1,2,3)

さて、このコードの出力は何でしょうか？答えは 2,6,1 です。ここまで来ると、何かを理解した気がしませんか？そうです、上の例は実際には次のように等価です。

def testDe1(func):
    def de(a, b, c):
        func(a, b, c)
        print('1')
    print('2')
    return de

def test2(a, b, c):
    print(a+b+c)

if __name__ == '__main__':
    testDe1(test2)(1,2,3)

では、別の例を見てみましょう。

def testDe1(func):
    def de(a, b, c):
        func(a, b, c)
        print('1')
    print('2')
    return de

@testDe1
def test2(a, b, c):
    print(a+b+c)
if __name__ == '__main__':
    pass

このコードの出力は何でしょうか？そうです、このコードの出力は 2 です。ここまで来ると、さらに理解が深まった気がしませんか？はい、Python では、関数デコレーターを使用する際、デコレータ関数が一度呼び出されることになります。具体的には、デコレーターを使用すると、デコレーターはデコレートされた関数で置き換えられ、何も行わない場合、次のような呼び出しが発生します test2=testDe1(test2)。次に、__main__ に test2(1,2,3) のコードを追加すると、これは testDe1(test2)(1,2,3) と等価になります。ここまで来ると、完全に理解できましたか？

では、前の例を復習しましょう。


@app.route('/')
def show_entries():
    db = get_db()
    cur = db.execute('select title, text from entries order by id desc')
    entries = cur.fetchall()
    return render_template('show_entries.html', entries=entries)

上記のコードでは何が起こっているのでしょうか？show_entries=app.route('/')(show_entries) という呼び出しがあるのではないでしょうか？ここまで来ると、非常に明確になりましたね。

2 つ目のポイントは、最初の小さなヒントに基づいて、デコレーターの引数に関する問題を説明します。
多くの人がデコレーターの引数の使用状況を理解していないかもしれません。まず、前述のように、デコレーターの根本的な役割は

元のコードを変更せずに関数をラップし、元のメソッドに特別な機能を追加することです。

今、関数の実行時間を出力する必要があると仮定します。この場合、どうすればよいでしょうか？

def testTime(func):
    def dec(*args,**kwargs):
        flag=time.time()
        func(*args,**kwargs)
        print(time.time()-flag)
    return dec

def func():
    pass

if __name__=='__main__':
    func()

前述のように、このコードは test(func)() と等価です。この時、時間出力を特定の単位でフォーマットしたい場合、上記のデコレーターコードを次のように変更します。

def testtime(time=None):
    def dec1(func):
        def dec2(*args,**kwargs):
            flag=time.time()
            func(*args,**kwagrs)
            flag2=time.time()
            if time is not None:
                print((flag2-flag)/time)
            else:
                print(flag2-flag)
        return dec2
    return dec1

ここまで書くと、引数付きデコレーターの使用状況が理解できたのではないでしょうか？

後記#

Flask のルーティングシステムは比較的シンプルで、本質的には引数付きデコレーターを利用して対応するルートを記録し、デコレーターのラッピング特性を利用して、対応する処理関数をラップし、ルートテーブルに追加します。一度登録したルートがトリガーされると、対応する処理関数を呼び出すことができます。