Pythonライブラリの引数を確認する方法

Pythonのライブラリを使用する際、関数の引数や返り値がわからないときの対処法を紹介します。特に、numpyのようなパッケージの関数の使い方がわからないときに役立つテクニックです。

__doc__を表示する

Pythonのコードを書いていて、関数の使い方がわからないときの対処法です。具体的な使い方は、以下の通りです。

import numpy as np
print(np.dot.__doc__)

上記のコードを実行することで、ドキュメントを確認することができます。このようにして、関数の引数や返り値がわからないときは、簡単に確認することができます。

コマンドライン引数ライブラリ

Pythonのコマンドライン引数ライブラリの主なものを紹介します。現在は実質、argparseかdocoptの二択です。

argparse

argparseは、コマンドラインの引数を解析して受け取るための標準ライブラリです。以下に使用例を示します。

import argparse
parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+', help='an integer for the accumulator')
parser.add_argument('--sum', action='store_true', help='sum the integers (default: find the max)')
args = parser.parse_args()
if args.sum:
    print(sum(args.integers))
else:
    print(max(args.integers))

docopt

docoptは、ドキュメント文字列をパースして引数解釈の仕様を起こす感じのライブラリです。以下に使用例を示します。

\"\"\"Usage: docopt-test.py [-h] [--sum] N [N ...]
Process some integers.
Arguments: N           an integer for the accumulator
Options: -h, --help  show this help message and exit --sum       sum the integers (default: find the max) \"\"\"
from docopt import docopt
args = docopt(__doc__)
integers = map(int, args.get('N'))
if args.get('--sum'):
    print(sum(integers))
else:
    print(max(integers))

以上、Pythonライブラリの引数を確認する方法について紹介しました。これらのテクニックを活用して、Pythonコーディングをより効率的に行いましょう。