デコレータについて

お前、誰よ（承前）

我が名はにっきー。アニメ大好き🥰この夏はアニメ映画がアツい！！
竜とそばかすの姫🐉、サイダーのように言葉が湧き上がる🥤、映画大好きポンポさん🎦、かくしごと👩‍🎨、きんモザ and so on！
しかしここ数日都内は感染者数3000人突破。外出しづらい。めっちゃ見たい！けどリスクとるか悩む。ぐおおお🤨

— nikkie 📣PyCon JP 2021 スタッフ募集中！ (@ftnext) July 31, 2021

デコレータ

• 語弊を恐れずに言えば、 関数を返す関数

• 「関数が関数を返すってどういうこと？」🤨

• 👉 関数の基本から見ていきましょう

お品書き：デコレータについて

• Pythonの関数

• デコレータ

• より便利なデコレータを書くために

お品書き：デコレータについて

• Pythonの関数

• デコレータ

• より便利なデコレータを書くために

@skip (寄り道) 関数のtips

• 返り値として複数の式を返せる（タプル）

• yield によるジェネレータ（ vol.1のスライド 参照）

• calculate_bmi(height_m=1.58, weight_kg=46) とも呼び出せる

  • Python 3.8~ 位置のみ・キーワードのみ引数

優先ソート実装：関数の中に関数

def sort_priority(values, group):
    def helper(x):
        if x in group:
            return (0, x)
        return (1, x)
    values.sort(key=helper)

https://github.com/bslatkin/effectivepython/blob/master/example_code/item_21.py#L50

sort_priority(values, {2, 3, 5})

• values = [1, 4, 3, 5, 2]

• helper の返り値

  • group については (0, 2), (0, 3), (0, 5)

  • group にないもの (1, 1), (1, 4)

• key: (1, 1), (1, 4), (0, 3), (0, 5), (0, 2) で並べ替えた

(再掲)優先ソート実装

def sort_priority(values, group):
    def helper(x):  # クロージャ
        if x in group:
            return (0, x)
        return (1, x)
    values.sort(key=helper)  # ファーストクラスオブジェクト

クロージャ

• functions that refer to variables from the scope in which they were defined （『Effective Python second edition』Item 21 p.84）

• ＝自身が定義されたスコープから（外側のスコープの）変数を参照する関数（訳の案）

• 優先ソートの helper 関数

  • sort_priority の引数 group を 参照 している

ファーストクラスオブジェクト

• 関数を 「直接参照でき、変数に代入したり、他の関数の引数として渡したり、式の中やif文の中で比較」 できる（『Effective Python 第2版』項目21 p.80）

• 優先ソートの values.sort(key=helper)

  • sort メソッドの key 引数に関数を渡し ている

例：ある身長の人のBMIを算出する関数を返す

def bmi_calculator_with_height(height_m):
    def calculate_bmi_wrapper(weight_kg):
        return weight_kg / height_m / height_m
    return calculate_bmi_wrapper

ある身長の人のBMIの変化を求める

>>> calculate_her_bmi = bmi_calculator_with_height(1.58)
>>> calculate_her_bmi(46)
18.426534209261334
>>> calculate_her_bmi(42)
16.824226886716872
>>> calculate_her_bmi(50)
20.0288415318058

お品書き：デコレータについて

• Pythonの関数

• デコレータ

• より便利なデコレータを書くために

デコレータの例（Django）

from django.contrib.auth.decorators import login_required

@login_required
def post_new(request):  # デコレータをつけることで、ログイン必須にできる
    ...

https://tutorial-extensions.djangogirls.org/ja/authentication_authorization#nono

デコレータ

• 「ラップする関数への呼び出しの前後で追加コードを実行することができます」 （『Effective Python 第2版』項目26 p.97）

• Djangoの login_required は post_new 関数の前に、ログインを検証するコードを実行した

@ はシンタックスシュガー

以下の2つは同じ

def f(...):
    ...

f = awesome_decorator(f)

@awesome_decorator
def f(...):
    ...

関数の開始と終了を示すデコレータ

def show_start_end(func):
    def wrapper(*args, **kwargs):
        print(func.__name__, "Start")
        returned = func(*args, **kwargs)
        print(func.__name__, "End")
        return returned
    return wrapper

関数の開始と終了を示すデコレータを使う

@show_start_end
def calculate_bmi(height_m, weight_kg):
    return weight_kg / height_m / height_m

>>> calculate_bmi(1.58, 46)
calculate_bmi Start
calculate_bmi End
18.426534209261334

例：関数定義の *args・ **kwargs

def f(*args, **kwargs):
    print(args)
    print(kwargs)

>>> f(1, 2, c=3)
(1, 2)
{'c': 3}

例：関数定義の *args・ **kwargs 実行例

>>> # 位置引数のみ渡した時、kwargsは空の辞書
>>> f(1, 2, 3)
(1, 2, 3)
{}
>>> # キーワード引数のみ渡した時、argsは空のタプル
>>> f(a=1, b=2, c=3)
()
{'a': 1, 'b': 2, 'c': 3}

例：関数呼び出しの *args・ **kwargs 実行例

>>> # シーケンスを * を使って渡す（argsがタプルとして受け取る）
>>> f(*[1,2,3])
(1, 2, 3)
{}
>>> # マッピングを ** を使って渡す（kwargsが辞書として受け取る）
>>> f(**{"a": 1, "b": 2, "c": 3})
()
{'a': 1, 'b': 2, 'c': 3}

再掲：関数の開始と終了を示すデコレータ

def show_start_end(func):
    def wrapper(*args, **kwargs):
        print(func.__name__, "Start")
        # wrapper に渡された位置引数、キーワード引数はfuncに渡されるということ
        returned = func(*args, **kwargs)
        print(func.__name__, "End")
        return returned
    return wrapper

落とし穴😱

@show_start_end
def fully_documented_bmi(height_m, weight_kg):
    """Calculate BMI (body mass index)."""
    return weight_kg / height_m / height_m

>>> fully_documented_bmi.__name__  # show_start_endが返す関数の名
'wrapper'
>>> print(fully_documented_bmi.__doc__)  # 失われたdocstring
None

💡解決策： functools.wraps

from functools import wraps
 
def show_start_end(func):
    @wraps(func)  # wrapperをデコレートする
    def wrapper(*args, **kwargs):
        print(func.__name__, "Start")
        returned = func(*args, **kwargs)
        print(func.__name__, "End")
        return returned
    return wrapper

functools.wraps で落とし穴回避🙌

@show_start_end
def fully_documented_bmi(height_m, weight_kg):
    """Calculate BMI (body mass index)."""
    return weight_kg / height_m / height_m

>>> fully_documented_bmi.__name__  # デコレータを付けた関数自体の名！
'fully_documented_bmi'
>>> print(fully_documented_bmi.__doc__)  # docstringが失われていない！
Calculate BMI (body mass index).

お品書き：デコレータについて

• Pythonの関数

• デコレータ

• より便利なデコレータを書くために

優先したかを返していない？🤨

>>> values = [1, 4, 3, 5, 2]
>>> # valuesを素数を優先して並び替えているが、返り値はFalse
>>> sort_priority(values, {2, 3, 5})
False
>>> values
[2, 3, 5, 1, 4]

なぜ優先したかを返さない？

• 変数の参照のスコープ解決順

• 代入のスコープ解決

例：クロージャ helper の group

def sort_priority(values, group):
    found = False
    def helper(x):
        if x in group:  # 外側のスコープのgroupを参照
            found = True
            return (0, x)
        return (1, x)
    values.sort(key=helper)
    return found

なぜ優先したかを返さなかったか？

def sort_priority(values, group):
    found = False
    def helper(x):
        if x in group:
            # 以下はhelperのスコープで変数foundを定義
            found = True  # 2行目のfoundとは無関係
            return (0, x)
        return (1, x)
    values.sort(key=helper)
    return found  # sort_priorityのスコープのfound

優先したかを返すように！🙌

>>> values = [1, 4, 3, 5, 2]
>>> sort_priority(values, {2, 3, 5})
True
>>> values
[2, 3, 5, 1, 4]

nonlocal を使ったデコレータ：呼び出しは1分に1回

def once_per_minute(func):
    last_ran_at = 0
 
    @wraps(func)
    def wrapper(*args, **kwargs):
        nonlocal last_ran_at
        current_time = time.time()
        if current_time - last_ran_at < 60:
            raise RunTooOftenError(
                f"Wait longer before running {func.__name__}"
            )
        last_ran_at = current_time
        value = func(*args, **kwargs)
        return value
 
    return wrapper

より便利なデコレータを書くために

• 参照と代入それぞれのスコープの扱い

• 引数を取るデコレータ

引数を取るデコレータはどう書く？

• 3つの関数 で実装する

def decorator_with_args(x, y):  # 引数を受け取りmiddleを返す
    def middle(func):  # 関数を受け取りwrapperを返す
        def wrapper(*args, **kwargs):
            ...
        return wrapper
    return middle

引数を渡してデコレート

@once_per_n_minutes(0)
def calculate_bmi2(height_m, weight_kg):
    return calculate_bmi(height_m, weight_kg)

@once_per_n_minutes(n=3)
def calculate_bmi3(height_m, weight_kg):
    return calculate_bmi(height_m, weight_kg)

引数を渡してデコレート 実行例

>>> calculate_bmi2(1.58, 46)
18.426534209261334
>>> calculate_bmi2(1.58, 46)
18.426534209261334
>>> calculate_bmi3(1.58, 46)
18.426534209261334
>>> # calculate_bmi3(1.58, 46)  # Raise RunTooOftenError

ご清聴ありがとうございました

Enjoy development with decorators!

References、Appendix が続きます（よろしければどうぞ！）

References 2/2

• The Global Dev Study #4 - FastAPI / Python

  • YouTube

  • Source code

• PyCon JP 2020 「詳解デコレータ」