Python 3でメソッドのパラメータ名を取得する方法

Python 3では、関数やメソッドのパラメータ名を取得するための便利なモジュールが提供されています。特に、`inspect`モジュールは、Pythonコードのオブジェクトを調べるための強力なツールです。この記事では、`inspect`モジュールを使用してメソッドのパラメータ名を取得する方法について詳しく説明します。

inspectモジュールを使ったパラメータ名の取得

まずは、`inspect`モジュールを使用して関数のパラメータ名を取得する基本的な方法を見てみましょう。

import inspect

def sample_function(a, b, c=3):
    return a + b + c

# パラメータ名を取得
params = inspect.signature(sample_function).parameters
param_names = list(params.keys())

print(param_names)

このコードでは、`sample_function`という関数のパラメータ名を取得しています。`inspect.signature()`を使用して関数のシグネチャを取得し、その`parameters`属性からパラメータ名をリストとして抽出しています。出力は次のようになります。

['a', 'b', 'c']

クラスメソッドのパラメータ名を取得する

次に、クラス内のメソッドのパラメータ名を取得する方法を見てみましょう。

import inspect

class SampleClass:
    def method(self, x, y=5):
        return x * y

# クラスメソッドのパラメータ名を取得
params = inspect.signature(SampleClass.method).parameters
param_names = list(params.keys())

print(param_names)

この例では、`SampleClass`の`method`メソッドのパラメータ名を取得しています。出力は次のようになります。

['self', 'x', 'y']

デコレータを使用したパラメータ名の取得

デコレータを使用して関数のパラメータ名を取得することも可能です。以下の例では、デコレータを使って関数が呼び出された際にそのパラメータ名を表示します。

import inspect

def print_params(func):
    def wrapper(*args, **kwargs):
        params = inspect.signature(func).parameters
        param_names = list(params.keys())
        print(f"Parameters: {param_names}")
        return func(*args, **kwargs)
    return wrapper

@print_params
def another_function(d, e, f=6):
    return d * e + f

another_function(1, 2)

このデコレータは、`another_function`が呼び出された際にそのパラメータ名を表示します。出力は次のようになります。

Parameters: ['d', 'e', 'f']

まとめ

Python 3では、`inspect`モジュールを使用することで、関数やメソッドのパラメータ名を簡単に取得することができます。これは、コードの動的解析やデバッグに非常に役立ちます。この記事で紹介した方法を使って、あなたのプロジェクトでもパラメータ名を活用してみてください。

Python 3において、メソッドのパラメータ名を取得する方法は、`inspect` モジュールを使用することで実現できます。具体的には、`inspect` モジュールの `signature` 関数を使用して、メソッドのシグネチャを取得し、その中からパラメータ名を抽出することができます。

以下は、この方法の簡単な例です。

“`python
import inspect

def example_method(param1, param2):
pass

signature = inspect.signature(example_method)
parameters = signature.parameters

for param_name, param_info in parameters.items():
print(param_name)
“`

上記のコードでは、`example_method` メソッドのパラメータ名を取得し、それらを順に出力しています。このようにして、Python 3でメソッドのパラメータ名を取得することができます。

Python 3でメソッドのパラメータ名を取得する方法