decoratorのサンプルコードでのargsとkwargsの役割について

Question

このようなサンプルコードをよく見かけますが、出力が同じでargsとkwargsのある意味がわかりません。
なんとなく、雰囲気でみなさん書いているのか、もしくは僕の理解が間違っているのか気になるのでご確認させてください。
個人的には、argsとkwargsはなくていいと思っています。さらに、コード内で入れ子にして def wrapper():　を記載する必要があるのかも疑問です、意図が理解できる方はおしえていただけませんか？何の確認のために記載するかわかりませんが、仮になにか確認のためにdef wrapper():　を書いているとしたら、どんな時にこういうコードを実際の開発でかきますか？

argsとkwargsの理解は以下です。

*args: 複数の引数をタプルとして受け取る

def my_sum2(*args):
    print('args: ', args)
    print('type: ', type(args))
    print('sum : ', sum(args))

my_sum2(1, 2, 3, 4)
# args:  (1, 2, 3, 4)
# type:  <class 'tuple'>
# sum :  10

**kwargs: 複数のキーワード引数を辞書として受け取る
**をつけた引数を定義すると、任意の数のキーワード引数を指定することができる。関数の中では引数名がキーkey、値がvalueとなる辞書として受け取られる。

def func_kwargs(**kwargs):
    print('kwargs: ', kwargs)
    print('type: ', type(kwargs))

func_kwargs(key1=1, key2=2, key3=3)
# kwargs:  {'key1': 1, 'key2': 2, 'key3': 3}
# type:  <class 'dict'>

decoratorのサンプルコードでのargsとkwargs

argsとkwargs記載有りのコード

def deco(func):
    def wrapper(*args, **kwargs):
        print('--start--')
        func(*args, **kwargs)
        print('--end--')
    return wrapper

@deco
def test():
    print('Hello Decorator')

test()

## -- End pasted text --
--start--
Hello Decorator
--end--

argsとkwargs記載なしのコード

def deco(func):
    def wrapper():
        print('--start--')
        func()
        print('--end--')
    return wrapper

@deco
def test():
    print('Hello Decorator')

test()

## -- End pasted text --
--start--
Hello Decorator
--end--

この def wrapper()をデコレーターにすると(@wraps(func))どういうメリットがあるのでしょうか？
@wraps(func)
発展型の理解

from functools import wraps

def validation_objecs(func):
    @wraps(func)
    def wrapper(request):
    　　　 ....
     　　　....
     　　　....
        return func(request)
    return wrapper

....
....
....


@validation_objecs
def start_batch(request):
　　　　　　....
     　　　....
     　　　....

Answer 1

decorateする関数に引数がない場合は*argsと**kwargsはなくても問題ありませんが、引数を要求する関数をdecoratorでwrapするときには便利です。

def deco(func):
    def wrapper(*args, **kwargs):
        print('--start--')
        func(*args, **kwargs)
        print('--end--')
    return wrapper

@deco
def test(name):
    print(f'Hello Decorator - {name}')

test("master")
# --start--
# Hello Decorator - master
# --end--

---

@wrapsなしだと何をwrapしたのか分からなくなってしまう問題があります。

def deco(func):
    def wrapper(*args, **kwargs):
        print('--start--')
        func(*args, **kwargs)
        print('--end--')
    return wrapper

@deco
def test(name):
    """How to use"""
    print(f'Hello Decorator - {name}')

print(test.__doc__)
# None
print(test)
# <function deco.<locals>.wrapper at 0x102dc38c8>

@wrapsを使うと、もとのオブジェクトの属性を引き継ぐことができます。

def deco(func):
    @wraps
    def wrapper(*args, **kwargs):
        print('--start--')
        func(*args, **kwargs)
        print('--end--')
    return wrapper

@deco
def test(name):
    """How to use"""
    print(f'Hello Decorator - {name}')

print(test.__doc__)
# How to use
print(test)
# <function test at 0x102e98488>

Comments

[sequelanonymous]

つまり、 def wrapper(*args, **kwargs):の行が必要な理由は、decorateする関数に引数を追記し、それをデコレートされた関数を引数にとる関数の中で引数をうけとるために、入れ子で引数受け取る用の関数(def wrapper(*args, **kwargs):)を書く必要があるという理解であっていますでしょうか？

また、デコレーターの発展系だと思いますが、以下の様なコードの場合、@wrapperの役割はどうでしょうか？
```
from functools import wraps

def validation_objecs(func):
@wraps(func)
def wrapper(request):
....
....
....
return func(request)
return wrapper

@validation_objecs
def start_batch(request):
```

[sequelanonymous]

上記の@wrapperについては、上記の質問に追記しました。

[tachikoma]

その理解であっています。*args, **kwargsの仕組みを使っておくと、decoratorはwrapする関数がどんな引数を取るか知らなくて済みます。

functoolsのほうは少しお待ちを。単純にdecorateしてしまうと、もともとの関数に仕込んでいたdocstringなどの属性にアクセスできなくなってしまう問題があった気がします。

[sequelanonymous]

ありがとうございます。
> 単純にdecorateしてしまうと、もともとの関数に仕込んでいたdocstringなどの属性にアクセスできなくなってしまう問題があった気がします。

この点については、おっしゃる通りです。docstringなどの属性にアクセスできないです。しかし、@wrapsをかくことでどう処理の順番になるのか、困惑しています。
return wrapperがどこに正確には変えるのかが気になっています。

[tachikoma]

仕組みを全部理解しているわけではないので、詳細はとりあえずソースコードを追いかけてみてくだされ。もしくは他の回答を待つのでもいいと思います。
https://github.com/python/cpython/blob/3.7/Lib/functools.py

[sequelanonymous]

そうですよね、不毛な質問でした。ありがとうございます！

Answer 2

下記、コードは、start_batchが走る前に、start_batchの引数であるrequestオブジェクトを引数としてデコレーター(def validation_objecs(func):)におくり、def wrapper(request): を入れ子にして書くことでその引数を関数内にひきつぐようにしている。return func(request)で def wrapperの処理結果を出力し、その出力結果をreturn wrapperでまとめてデコレートされたstart_batchに値を渡す。

return func(request)は、デコレートされたメソッドを実行している。func = start_batch。

＊@wraps(func)はデコレートされたメソッド内の__docs__を引き継いてくれる。@wrapsがないと引き継がれない。
＊def wrapper(request):のwrapperとう命名は実際は何でもよいのだが、最後にreturnする名前と合わせる必要がある。

 1 def deco(func):
  2     @wraps(func)
  3     def w(*args, **kwargs):
  4         print('--start--')
  5         func(*args, **kwargs)
  6         print('--end--')
  7         print("w"+str(w))
  8
  9     return w
 10
 11 @deco
 12 def test(name):
 13     print(f'Hello Decorator - {name}')
 14
 15 test("master")
~

from functools import wraps

def validation_objecs(func):
    @wraps(func)
    def wrapper(request):
    　　　 ....
     　　　....
     　　　....
        return func(request)
    return wrapper

....
....
....


@validation_objecs
def start_batch(request):
　　　　　　....
     　　　....
     　　　....