Python argparseモジュール set_defaultsメソッド

Question

Python初心者でございます。

公式ドキュメントを読んだり、Google検索でいろいろ調べましたがどうしても詰まってしまいご質問させていただきました。

標準ライブラリのargparseモジュールの挙動に関してわからない部分があります。
下記は自分でテスト用に書いたものです。

#test_argparse.py

import argparse


#サブコマンドで呼び出したい関数を定義
def hoge(args):
    print("hoge")


#メイン関数
def main():
    #ArgumentParserオブジェクトを生成
    parser = argparse.ArgumentParser()
    #サブコマンドを実行するための特殊オブジェクトの生成
    sub_parsers = parser.add_subparsers()

    #add_parserでArgumentParserオブジェクトを返す
    hoge_parser = sub_parsers.add_parser("hoge")
    #ArgumentParserオブジェクトのset_defaultsメソッド
    hoge_parser.set_defaults(func=hoge)

    #parse_args()でArgumentParserオブジェクトを解析。Namespaceオブジェクトが返る。
    args = parser.parse_args()
    #ここの挙動がわかりません・・・
    args.func(args)

if __name__ == "__main__":
    main()

コマンドラインに"python test_argparse.py hoge"と入力すると関数hogeが呼ばれてhogeと返ってきます。公式ドキュメントを読みながら、どのようにコードが進行するか調べたのですが、最後の**args.func(args)の挙動がわかりません。。。最終的にこの部分はhoge()**となっているんだと思うんですが、どのように変化したのかわかりません。

初歩的な質問かと思いますが、お助けいただけると助かります。よろしくお願いいたします。

Answer 1

こんな感じでしょうか。

args = parser.parse_args()

1. コマンドライン引数をパースする
2. サブコマンドとしてhogeが指定されているので、hoge_parserにパースを委託する
3. それ以降は特にコマンドが指定されていないので、funcの値はデフォルト値になる
4. 結果が返ってきて、argsに保管される

args.func(args)

1. argsには各属性が結び付いているので、args.funcはhoge
2. 引数にargsを指定しているのは現時点では無意味だと思う

args.func is hogeの真偽を見れば、二つが同一のオブジェクトを指していることが分かります。

コメントを受けて

『結び付ける』処理自体は簡単に書けます。

class MyClass:
    def set_default(self, **kwargs):
        for key, value in kwargs.items():
            setattr(self, key, value)

def spam():
    print('spam')

def ham():
    print('ham')

def egg():
    print('egg')

obj = MyClass()
obj.set_default(f_spam=spam, f_ham=ham, f_egg=egg)

obj.f_spam()
obj.f_ham()
obj.f_egg()

実行結果 Wandbox

spam
ham
egg

こんな風にset_defaultを用いて属性を結び付けているのかと。
実際にはもっともっと複雑でしょうが、動作自体に違和感はありません。

Comments

[GoMaGo]

早速回答いただきまして、ありがとうございます。
>argsには各属性が結び付いている
argsはパースした結果のNamespaceオブジェクトだと理解しているのですが、
このオブジェクトにSetdefaultで定義したfuncという属性が結びついているという理解でいいのでしょうか？

[GoMaGo]

自己レスですみません。
dirでargsの中身を確認しましたら、下記のようになりました。
['__class__', '__contains__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_get_args', '_get_kwargs', 'func']

最後のfuncはset.defaultでhogeと結び付けているので,args属性のfunc=hogeを呼んだという理解でいいのでしょうか？

[LouiS0616]

その理解で正しいかと。

[GoMaGo]

LoiS0616さん、おかげさまで大変よく理解できました！本当にありがとうございます。

さらに分かったのは、setdefaultはキーワード限定引数になっていて、キーワードと一緒に文字列を渡さないと、 "takes 1 positional argument but 2 were given"となってエラーになることがわかりました。

おかげさまで解決しました！！！ありがとうございます。