Pythonで関数の引数（パラメータ）名のリストを取得する方法

Pythonでは、関数やメソッドが受け取る引数の「数」と「名前」をプログラムから取得できます。たとえば、("arg1", "arg2") のような形式で引数名の一覧を取り出したい場合には、標準ライブラリの inspect モジュール を使用します。

以下のコードでは、inspectモジュールを使って、aMethod と foo という2つの関数内のパラメータ情報を取得しています。

サンプルコード

import inspect

def aMethod(arg1, arg2):
    pass

print(inspect.getargspec(aMethod))

def foo(a, b, c=4, *arglist, **keywords):
    pass

print(inspect.getargspec(foo))

実行結果

ArgSpec(args=['arg1', 'arg2'], varargs=None, keywords=None, defaults=None)
ArgSpec(args=['a', 'b', 'c'], varargs='arglist', keywords='keywords', defaults=(4,))

出力内容の見方

getargspec() の戻り値は、次の要素を持つオブジェクトです。

• args: 位置引数の名前のリスト
• varargs: 可変長位置引数（*args）の変数名。なければ None
• keywords: 可変長キーワード引数（**kwargs）の変数名。なければ None
• defaults: デフォルト値のタプル。デフォルト値がなければ None

この例では、foo の場合、通常の引数として a、b、c が検出され、*arglist と **keywords もそれぞれ認識されていることがわかります。

注意：getargspecは非推奨

inspect.getargspec() は古いAPIであり、Python 3系では非推奨とされ、Python 3.11で削除されました。現在のPythonでは、代わりに inspect.signature() を使うのが推奨されます。

import inspect

def foo(a, b, c=4, *arglist, **keywords):
    pass

sig = inspect.signature(foo)

# 引数名だけをリストで取得
param_names = list(sig.parameters.keys())
print(param_names)

# 各パラメータの詳細を表示
for name, param in sig.parameters.items():
    print(name, param.kind, param.default)

実行結果

['a', 'b', 'c', 'arglist', 'keywords']
a POSITIONAL_OR_KEYWORD <class 'inspect._empty'>
b POSITIONAL_OR_KEYWORD <class 'inspect._empty'>
c POSITIONAL_OR_KEYWORD 4
arglist VAR_POSITIONAL <class 'inspect._empty'>
keywords VAR_KEYWORD <class 'inspect._empty'>

inspect.signature() を使えば、引数名だけでなく、各パラメータの種類（位置引数・キーワード引数など）やデフォルト値も柔軟に取得でき、アノテーション付きの関数にも対応しています。新しいコードではこちらの方法を採用しましょう。