デコレーター: Pythonの秘密兵器

Posted at 2025-02-19

Leapcell：次世代のPythonアプリホスティング用サーバレスプラットフォーム

Pythonデコレータの詳細説明

I. デコレータとは何か

Pythonにおいて、デコレータは基本的にPython関数です。それは独自の機能を持ち、元のコードを変更することなく他の関数に追加機能を追加することができます。デコレータの返り値も関数オブジェクトです。簡単に言えば、別の関数を返すように設計された関数です。

デコレータは、アスペクト指向の要件が存在する多くのシナリオで重要な役割を果たします。例えば：

ログの挿入：関数の実行プロセスと関連情報の記録を容易にし、デバッグとシステムモニタリングに役立ちます。
パフォーマンステスト：関数の実行時間を計算し、それによってそのパフォーマンスを評価することができます。
トランザクション処理：一連の操作がすべて成功するか、またはすべて失敗することを保証し、データの一貫性と整合性を保証します。
キャッシュ：計算コストの高い関数に対して、その計算結果をキャッシュします。次回同じ入力が発生したときには、キャッシュされた値を直接返し、効率を向上させます。
権限検証：関数を実行する前に、ユーザーが対応する権限を持っているかどうかをチェックし、システムのセキュリティを保証します。

デコレータはこのような問題を解決するための優れた設計ソリューションを提供します。デコレータを使用することで、関数のコア機能とは関係ないが繰り返し出現する大量のコードを抽出することができ、高度なコード再利用を実現します。

要するに、デコレータの核心機能は既存のオブジェクトに追加機能を追加することで、コード構造を明瞭にし、機能をより豊富で柔軟にすることです。

II. なぜデコレータが必要か

(I) 簡単な例

まず、簡単な関数を考えてみましょう：

def foo():
    print('i am foo')

この関数は単に i am foo という文字列を出力します。

(II) 要件の追加

今、関数の実行ログを記録するという新しい要件があります。そこで、コードにログ関連のコードを追加します：

def foo():
    print('i am foo')
    print("foo is running")

この時点で、foo 関数は元の機能に加えて、ログを出力する機能が追加されました。

(III) より多くの関数への要件

100個の関数にすべてこのようなログ記録の要件があり、将来的にはこれら100個の関数に対して実行前にログを出力するという要件が追加される可能性があると仮定しましょう。関数コードを1つ1つ修正すると、大量の重複コードが生成され、明らかに良い解決策ではありません。

重複コードの書き込みを減らすために、ログ関連の操作を専用に処理する関数を再定義することができます。ログ処理が完了した後、実際のビジネスコードを実行します。例は以下の通りです：

def use_logging(func):
    print("%s is running" % func.__name__)
    func()

def bar():
    print('i am bar')

use_logging(bar)

実行結果は：

bar is running
i am bar

この例では、use_logging 関数がデコレータです。それは実際のビジネスメソッドを実行する func を関数内にラップしています。形式的には、bar 関数が use_logging で装飾されているように見えます。関数の入力と出力時のログ記録操作はアスペクトと呼ばれ、このプログラミング方法はアスペクト指向プログラミングと呼ばれます。

この use_logging 関数を通じて、関数にロギング機能を成功裏に追加しました。将来的に、いくつの関数にロギング機能を追加する必要があっても、またはログ形式を変更する必要がある場合でも、use_logging 関数のみを修正し、use_logging(装飾される関数) を呼び出すことで目的の効果を達成することができます。例えば：

def use_logging(func):
    print("%s is running" % func.__name__)
    return func

@use_logging
def bar():
    print('i am bar')

bar()

III. 基本的なデコレータの紹介

(I) デコレータの構文シュガー

Pythonは @ 記号をデコレータの構文シュガーとして提供しており、これにより装飾関数の適用がより便利になります。ただし、構文シュガーを使用するには、装飾関数が関数オブジェクトを返す必要があります。そのため、通常は装飾する関数を内側の関数でラップし、この内側の関数を返します。

以下のコードを例に説明します。デコレータ use_logging は、まずこの関数を実行し、その後装飾された関数 bar を返すことと同等です。したがって、bar() が呼び出されるとき、実際には2つの関数が実行されることと同等で、直接 use_logging(bar)() を呼び出すことと同じです。

def use_logging(func):
    def _deco():
        print("%s is running" % func.__name__)
        func()
    return _deco

@use_logging
def bar():
    print('i am bar')

bar()

(II) パラメータを持つ関数の装飾

関数が2つのパラメータを受け取り、計算を行う必要がある場合、内側の関数を対応させて渡される2つのパラメータ a と b を受け取るように変更する必要があります。このとき、bar(1, 2) を呼び出すことは use_logging(bar)(1, 2) を呼び出すことと同等です。サンプルコードは以下の通りです：

def use_logging(func):
    def _deco(a, b):
        print("%s is running" % func.__name__)
        func(a, b)
    return _deco

@use_logging
def bar(a, b):
    print('i am bar:%s' % (a + b))

bar(1, 2)

ただし、実際のアプリケーションでは、装飾する関数のパラメータの数や型が異なる場合があります。毎回異なるパラメータの状況に応じてデコレータを修正するのは明らかに科学的ではありません。このパラメータの問題を解決するために、Pythonの可変長パラメータ *args と **kwargs を使用することができます。

(III) 関数パラメータの数が不定の場合

以下はパラメータを持たないデコレータのバージョンで、この形式はパラメータを持たない関数の装飾に適しています。*args と **kwargs を使用することで、デコレータはすでに様々な長さと型のパラメータに対応できるようになりました。つまり、このバージョンのデコレータはどんなタイプのパラメータなし関数でも装飾できます。サンプルコードは以下の通りです：

def use_logging(func):
    def _deco(*args, **kwargs):
        print("%s is running" % func.__name__)
        func(*args, **kwargs)
    return _deco

@use_logging
def bar(a, b):
    print('i am bar:%s' % (a + b))


@use_logging
def foo(a, b, c):
    print('i am bar:%s' % (a + b + c))


bar(1, 2)
foo(1, 2, 3)

(IV) パラメータを持つデコレータ

場合によっては、デコレータがパラメータを取る必要があります。これには、デコレータを返す高階関数を書く必要があり、実装が比較的複雑になります。例えば：

#! /usr/bin/env python
# -*- coding:utf-8 -*-
# __author__ = "TKQ"

def use_logging(level):
    def _deco(func):
        def __deco(*args, **kwargs):
            if level == "warn":
                print "%s is running" % func.__name__
            return func(*args, **kwargs)
        return __deco
    return _deco


@use_logging(level="warn")
def bar(a, b):
    print('i am bar:%s' % (a + b))


bar(1, 3)
# これは use_logging(level="warn")(bar)(1, 3) と同等です

(V) functools.wraps

デコレータを使用することでコードの再利用が大幅に向上しますが、元の関数のメタ情報が失われるという欠点があります。例えば、関数の docstring、__name__、パラメータリストなどの情報です。まず、以下の例を見てみましょう：

def use_logging(func):
    def _deco(*args, **kwargs):
        print("%s is running" % func.__name__)
        func(*args, **kwargs)
    return _deco


@use_logging
def bar():
    print('i am bar')
    print(bar.__name__)


bar()
# 出力結果は：
# bar is running
# i am bar
# _deco

関数名が元の bar ではなく _deco になっていることがわかります。リフレクション機能を使用するとき、この状況は問題を引き起こす可能性があります。この問題を解決するために、functools.wraps を導入することができます。functools.wraps を使用したサンプルコードは以下の通りです：

import functools


def use_logging(func):
    @functools.wraps(func)
    def _deco(*args, **kwargs):
        print("%s is running" % func.__name__)
        func(*args, **kwargs)
    return _deco


@use_logging
def bar():
    print('i am bar')
    print(bar.__name__)


bar()
# 出力結果は：
# bar is running
# i am bar
# bar

上記の結果からわかるように、functools.wraps を使用した後、期待される結果が得られ、元の関数の名前が正常に保持されました。

(VI) パラメータを持つデコレータと持たないデコレータの両方に対応する実現

import functools


def use_logging(arg):
    if callable(arg):  # 渡されたパラメータが関数かどうかを判断。パラメータを持たないデコレータはこの分岐を呼び出す。
        @functools.wraps(arg)
        def _deco(*args, **kwargs):
            print("%s is running" % arg.__name__)
            arg(*args, **kwargs)
        return _deco
    else:  # パラメータを持つデコレータはこの分岐を呼び出す。
        def _deco(func):
            @functools.wraps(func)
            def __deco(*args, **kwargs):
                if arg == "warn":
                    print "warn%s is running" % func.__name__
                return func(*args, **kwargs)
            return __deco
        return _deco


@use_logging("warn")
# @use_logging
def bar():
    print('i am bar')
    print(bar.__name__)


bar()

IV. クラスデコレータ

クラスデコレータを使用すると、パラメータを持つデコレータの効果を実現できるだけでなく、実装方法もよりエレガントで簡潔になります。同時に、継承を通じて柔軟に拡張することができます。

(I) クラスデコレータ

class loging(object):
    def __init__(self, level="warn"):
        self.level = level

    def __call__(self, func):
        @functools.wraps(func)
        def _deco(*args, **kwargs):
            if self.level == "warn":
                self.notify(func)
            return func(*args, **kwargs)
        return _deco

    def notify(self, func):
        # logit only logs and does nothing else
        print("%s is running" % func.__name__)


@loging(level="warn")  # 実行 __call__ メソッド
def bar(a, b):
    print('i am bar:%s' % (a + b))


bar(1, 3)

クラスlogingは、__init__メソッドで初期化レベルを設定します。__call__メソッドは、デコレート対象の関数を受け取り、内部関数_decoを返します。_deco関数では、指定されたレベルが「warn」の場合にnotifyメソッドを呼び出し、その後元の関数を実行します。notifyメソッドでは、単に関数名をログ出力します。

(II) クラスデコレータの継承と拡張

class email_loging(Loging):
    '''
    関数が呼び出されたときに管理者にメールを送信できるLogingの実装バージョン
    '''
    def __init__(self, email='admin@myproject.com', *args, **kwargs):
        self.email = email
        super(email_loging, self).__init__(*args, **kwargs)

    def notify(self, func):
        # Send an email to self.email
        print("%s is running" % func.__name__)
        print("sending email to %s" % self.email)


@email_loging(level="warn")
def bar(a, b):
    print('i am bar:%s' % (a + b))


bar(1, 3)

上記のコードでは、email_logingクラスがLogingクラスを継承しています。この継承関係を通じて、元のクラスのコアロジックを変更することなく、新しい機能を追加することができます。例えば、関数が呼び出されたときに管理者にメールを送信する機能です。これは、クラスデコレータがコードの拡張と再利用において持つ利点を十分に表しています。