pythonのargparseのオプションと関数の引数の乖離を実際の処理を呼ばずに確認する方法を考えてみる
argparseをそのまま使うと以下の様な形になる。色々な書き方があるが、個人的にはflag部分はキーワード引数を使った関数定義にして、parse_args()で返ってきた値をそのまま使わずに**paramsで適用する形が好み。
def hello(*, name: str) -> None: print(f"hello {name}") def main() -> None: import argparse parser = argparse.ArgumentParser() parser.add_argument("--name", required=True) args = parser.parse_args() params = vars(args).copy() hello(**params) if __name__ == "__main__": main()
この方法の利点として、実行してみれば、関数の引数部分とargparseのオプション名の乖離に気づける様になる事が挙げられる。あとは暗黙的な属性名でのアクセス(e.g. args.name)などが存在しないのでどのような値に依存しているかがわかりやすくなる。
とはいえ、オプションの定義部分と関数の引数部分を別個に記述しなければいけないので、両者が揃った記述になるよう注意し続けなくてはいけない。 ここで、そこそこ高価なコマンドを作っているときなどには、このオプション名と引数部分の乖離を実際に関数を呼ぶ事なく調べたい。そのようなことができるか？というのが今回の課題。
関数を呼ばずに関数の引数の正当性をチェックしたい
pythonの型は動的なので実行によってチェックされる。例えば不適切な引数を渡したときには失敗によってそれに気づく。
# hello(nam="foo") TypeError: hello() got an unexpected keyword argument 'nam'
失敗するときにはこれで良いが、成功したときにも呼び出したくない。とはいえ個々の関数に以下のようなhookをつけていくのもバカバカしい。というか、どうかしている。
def hello(*, name: str) -> None: import os # FAKE_CALL=1 python main.py --name=foo などとして実行した場合には静かに終了したい if bool(os.getenv("FAKE_CALL")): sys.exit(0) print(f"hello {name}")
実はこういうsignatureに即しているかだけを確認したいときにはinspect.getcallargsが使える1。関数のsignatureなどをいい感じに見て、関数呼び出しを辞書に変換してくれる。
inspect.getcallargs(hello, name="foo") {'name': 'foo'}
これを上手く使うことで関数を呼ばずに正当性をチェックできる。
FAKE_CALL=1 でチェックだけして終了
そんなわけで functools.partial も使って以下の様に書くと望みの挙動になる
def hello(*, name: str) -> None: print(f"hello {name}") def main() -> None: import os import argparse parser = argparse.ArgumentParser() parser.add_argument("--name", required=True) args = parser.parse_args() params = vars(args).copy() fn = hello if bool(os.getenv("FAKE_CALL")): from inspect import getcallargs from functools import partial fn = partial(getcallargs, fn) fn(**params) if __name__ == "__main__": main()
実際に実行してみる。期待通りの挙動。
$ FAKE_CALL=1 python 01hello.py --name world $ python 01hello.py --name world hello world
別解
別解としてtyperなどを使うというのもありかもしれない。そもそも記述箇所が１つだけなら悩むこともない2。
import typer def hello(*, name: str = typer.Option("")) -> None: print(f"hello {name}") if __name__ == "__main__": typer.run(hello)
補完とちょっとしたmarkdownの生成もついてくるし、無限にネストしたサブコマンドも付いてくるし、便利なツールとして自分の道具箱の中に入れておくのはありだと思う3。
別解2
自作したhandsofcatsも同様の形で使えるが、知名度などを気にするならtyperに絞った方が多分良い4。
from handofcats import as_command @as_command def hello(*, name: str) -> None: print(f"hello {name}")
こういう事ができたりはする。
$ python 03*.py --expose --simple
def hello(*, name: str) -> None:
print(f"hello {name}")
def main(argv=None):
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--name', required=True, help='-')
args = parser.parse_args(argv)
params = vars(args).copy()
action = hello
return action(**params)
if __name__ == '__main__':
main()
元々の発端は、こうやってexposeしてargparseにバラした後は引数とオプションの整合性を自分で気をつける必要があるなー、と思ったところから。
例えば、CIなどで FAKE_CALL=1 python hello.py --name foo などと試すスクリプトを動かしておけば必ず実行可能なこと（関数のbodyまで到達すること）は保証できそう。
