Python 3におけるfunctools.wrapsの役割は何ですか？

Python 3におけるfunctools.wrapsの役割

Python 3のfunctools.wrapsは、デコレータを使って関数を修飾する際に、オリジナルの関数の情報（名前、ドキュメンテーション文字列、引数リストなど）を保持するためのヘルパー関数です。通常、デコレータを使用すると、オリジナルの関数の情報が失われることがありますが、functools.wrapsを使うことでその情報を保持することができます。

関連する知識

functools.wrapsを使用することで、デコレータを作成する際に以下のようなメリットがあります。

• デコレートされた関数の名前やドキュメンテーション文字列が保持される。
• オリジナルの関数の引数リストがデコレートされた関数に反映される。
• デコレートされた関数が呼び出されたときのスタックトレースがよりわかりやすくなる。

明確な例と結果

以下に、functools.wrapsを使用しない場合と使用した場合の比較例を示します。

import functools

def my_decorator(func):
    def wrapper():
        print('Calling decorated function')
        return func()
    return wrapper

@my_decorator
def example():
    """Docstring of example function"""
    print('Called example function')

print(example.__name__)  # Output: wrapper
print(example.__doc__)   # Output: None

上記の例では、functools.wrapsを使用せずにデコレータを適用した場合、オリジナルの関数の情報が失われてしまいます。

import functools

def my_decorator(func):
    @functools.wraps(func)
    def wrapper():
        print('Calling decorated function')
        return func()
    return wrapper

@my_decorator
def example():
    """Docstring of example function"""
    print('Called example function')

print(example.__name__)  # Output: example
print(example.__doc__)   # Output: Docstring of example function

functools.wrapsを使用することで、デコレートされた関数にはオリジナルの関数の情報が保持されるため、より使いやすくなります。

以上が、Python 3におけるfunctools.wrapsの役割に関する説明と具体的な例です。このモジュールを適切に活用することで、デコレータをより効果的に利用することができます。