関数

[Python] 引数付きデコレータを定義して、引数を渡す方法

デコレータに引数を渡すには、デコレータ自体を関数でラップする必要があります。

外側の関数で引数を受け取り、内側で実際のデコレータを定義します。

具体的には、外側の関数がデコレータを生成し、そのデコレータが元の関数をラップします。

これにより、デコレータに動的な設定を渡すことが可能になります。

目次から探す

引数付きデコレータの仕組み

デコレータは、Pythonの関数やメソッドに機能を追加するための強力なツールです。

引数付きデコレータは、デコレータに引数を渡すことができる特別な形式です。

これにより、デコレータの動作を柔軟にカスタマイズできます。

以下に、引数付きデコレータの基本的な仕組みを説明します。

デコレータの基本

デコレータは、関数を引数として受け取り、別の関数を返す関数です。

通常のデコレータは、以下のように定義されます。

def my_decorator(func):
    def wrapper():
        print("何か処理をする前")
        func()
        print("何か処理をした後")
    return wrapper
@my_decorator
def say_hello():
    print("こんにちは！")
say_hello()

このコードを実行すると、次のような出力が得られます。

何か処理をする前
こんにちは！
何か処理をした後

引数付きデコレータの定義

引数付きデコレータは、デコレータ自体が引数を受け取るように設計されています。

これを実現するためには、デコレータを二重に定義する必要があります。

以下のように、外側の関数が引数を受け取り、内側の関数がデコレートする関数を受け取ります。

def repeat(num_times):
    def decorator_repeat(func):
        def wrapper(*args, **kwargs):
            for _ in range(num_times):
                func(*args, **kwargs)
        return wrapper
    return decorator_repeat
@repeat(3)
def greet(name):
    print(f"こんにちは、{name}さん！")
greet("太郎")

このコードを実行すると、次のような出力が得られます。

こんにちは、太郎さん！
こんにちは、太郎さん！
こんにちは、太郎さん！

仕組みの解説

外側の関数 repeat(num_times) は、デコレータに渡す引数を受け取ります。
内側の関数 decorator_repeat(func) は、デコレートする関数を受け取ります。
ラッパー関数 wrapper(*args, **kwargs) は、元の関数を呼び出す前後に処理を追加します。
最後に、wrapper 関数が返され、デコレータとして機能します。

このように、引数付きデコレータを使用することで、関数の動作を柔軟に変更することができます。

引数付きデコレータの実装方法

引数付きデコレータを実装するためには、デコレータを二重に定義する必要があります。

外側の関数が引数を受け取り、内側の関数がデコレートする関数を受け取ります。

以下に、具体的な実装方法を示します。

基本的な構造

引数付きデコレータの基本的な構造は以下の通りです。

def outer_function(arg1, arg2):
    def inner_function(func):
        def wrapper(*args, **kwargs):
            # 何らかの処理
            return func(*args, **kwargs)
        return wrapper
    return inner_function

この構造を使って、引数付きデコレータを実装することができます。

サンプルコード：実行時間を計測するデコレータ

以下の例では、関数の実行時間を計測する引数付きデコレータを実装します。

引数として、計測結果を表示するかどうかを指定します。

import time
def time_it(show_time=True):
    def decorator_time_it(func):
        def wrapper(*args, **kwargs):
            start_time = time.time()  # 開始時間を記録
            result = func(*args, **kwargs)  # 元の関数を実行
            end_time = time.time()  # 終了時間を記録
            if show_time:
                print(f"{func.__name__}の実行時間: {end_time - start_time:.4f}秒")
            return result
        return wrapper
    return decorator_time_it
@time_it(show_time=True)
def example_function():
    time.sleep(1)  # 1秒待機
example_function()

このコードを実行すると、次のような出力が得られます。

example_functionの実行時間: 1.0001秒

実装のポイント

引数の受け取り: 外側の関数で引数を受け取り、内側の関数に渡します。
ラッパー関数: 内側の関数でラッパー関数を定義し、元の関数を呼び出す前後に処理を追加します。
可変引数: *args と **kwargs を使用することで、元の関数の引数をそのまま受け取ることができます。

このようにして、引数付きデコレータを実装することができます。

デコレータを使うことで、関数の動作を柔軟に変更し、再利用性を高めることができます。

引数付きデコレータの活用例

引数付きデコレータは、さまざまな場面で活用できます。

ここでは、実用的な例をいくつか紹介します。

これにより、引数付きデコレータの使い方やその利点を理解することができます。

ログ出力デコレータ

関数の実行時にログを出力するデコレータを作成することができます。

引数としてログのレベルを指定し、異なるレベルのログを出力します。

def log(level="INFO"):
    def decorator_log(func):
        def wrapper(*args, **kwargs):
            print(f"[{level}] {func.__name__}を実行します。")
            return func(*args, **kwargs)
        return wrapper
    return decorator_log
@log(level="DEBUG")
def process_data(data):
    print(f"データ処理中: {data}")
process_data("サンプルデータ")

このコードを実行すると、次のような出力が得られます。

[DEBUG] process_dataを実行します。
データ処理中: サンプルデータ

繰り返し実行デコレータ

関数を指定した回数だけ繰り返し実行するデコレータを作成できます。

引数として繰り返し回数を指定します。

def repeat(num_times):
    def decorator_repeat(func):
        def wrapper(*args, **kwargs):
            for _ in range(num_times):
                func(*args, **kwargs)
        return wrapper
    return decorator_repeat
@repeat(2)
def say_hello(name):
    print(f"こんにちは、{name}さん！")
say_hello("花子")

このコードを実行すると、次のような出力が得られます。

こんにちは、花子さん！
こんにちは、花子さん！

引数のバリデーションデコレータ

関数の引数を検証するデコレータを作成することもできます。

引数として許可される値のリストを指定し、それに基づいて引数を検証します。

def validate_args(allowed_values):
    def decorator_validate(func):
        def wrapper(value):
            if value not in allowed_values:
                raise ValueError(f"引数は {allowed_values} のいずれかでなければなりません。")
            return func(value)
        return wrapper
    return decorator_validate
@validate_args(allowed_values=["apple", "banana", "orange"])
def print_fruit(fruit):
    print(f"選択された果物: {fruit}")
print_fruit("apple")  # 正常
# print_fruit("grape")  # ValueErrorが発生

このコードを実行すると、次のような出力が得られます。

選択された果物: apple

引数付きデコレータは、関数の動作を柔軟に変更するための強力なツールです。

ログ出力、繰り返し実行、引数のバリデーションなど、さまざまな用途に応じて活用できます。

これにより、コードの可読性や再利用性が向上し、開発効率が高まります。

注意点とベストプラクティス

引数付きデコレータを使用する際には、いくつかの注意点とベストプラクティスがあります。

これらを理解し、適切に実装することで、より効果的にデコレータを活用できます。

デコレータのネストに注意

引数付きデコレータは、デコレータを二重に定義するため、ネストが深くなることがあります。

これにより、コードが複雑になり、可読性が低下する可能性があります。

デコレータの数が多くなる場合は、適切にコメントを追加し、構造を明確にすることが重要です。

元の関数のメタデータを保持

デコレータを使用すると、元の関数のメタデータ(名前やドキュメンテーション文字列など)が失われることがあります。

これを防ぐために、functools.wrapsを使用して、元の関数の情報をラッパー関数にコピーすることが推奨されます。

import functools
def my_decorator(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        # 何らかの処理
        return func(*args, **kwargs)
    return wrapper

引数の型を明示する

引数付きデコレータを定義する際には、引数の型を明示することが重要です。

これにより、デコレータを使用する際の意図が明確になり、誤った引数を渡すリスクが減ります。

def repeat(num_times: int):
    # デコレータの実装

エラーハンドリングを考慮する

デコレータ内でエラーが発生する可能性があるため、適切なエラーハンドリングを行うことが重要です。

これにより、デコレータを使用する関数が予期しない動作をすることを防ぎます。

def safe_divide(divisor: float):
    def decorator_safe(func):
        def wrapper(*args, **kwargs):
            if divisor == 0:
                raise ValueError("ゼロで割ることはできません。")
            return func(*args, **kwargs) / divisor
        return wrapper
    return decorator_safe