python 如何查看一个函数的参数

python 如何查看一个函数的参数？使用inspect模块！

---

在Python中，您可以使用inspect模块来查看一个函数的参数信息。inspect模块提供了许多用于检查对象的工具函数，其中包括用于获取函数参数信息的函数。

以下是一个示例，展示了如何使用inspect模块来查看函数的参数：

import inspect

def my_function(arg1, arg2, *, kwarg1="default", kwarg2="default"):
    pass

# 使用inspect.signature获取函数的签名对象
sig = inspect.signature(my_function)

# 打印函数的参数信息
for name, param in sig.parameters.items():
    print(f"Parameter: {name}")
    print(f"  Default value: {param.default}")
    print(f"  Annotation: {param.annotation}")
    print(f"  Kind: {param.kind}")
    print(f"  Required: {param.default == param.empty}")
    print()

在上述示例中，我们定义了一个名为my_function的函数，它具有多个参数，包括位置参数、关键字参数和默认值参数。

我们使用inspect.signature函数来获取函数的签名对象sig。然后，我们遍历签名对象的parameters属性，该属性包含了函数的参数信息。

在循环中，我们打印每个参数的名称、默认值、注释、类型以及是否为必需参数等信息。

请注意，函数的参数信息包含在参数对象中，可以通过param.name、param.default、param.annotation等属性进行访问。param.kind表示参数的种类，例如POSITIONAL_OR_KEYWORD表示位置或关键字参数，KEYWORD_ONLY表示仅关键字参数等。

---

Q：如果传递给 inspect.signature 的是一个 class，读取的是 class 的 __init__ 吗

A: 是的，如果您将一个类（class）作为参数传递给inspect.signature函数，它将读取类的__init__方法的签名信息。

在Python中，__init__方法是类的构造函数，用于初始化类的实例。因此，__init__方法定义了类的参数列表和默认值。inspect.signature函数用于获取函数的签名对象，其中包括参数信息。

以下是一个示例，展示了如何使用inspect.signature来读取类的__init__方法的参数信息：

import inspect

class MyClass:
    def __init__(self, arg1, arg2="default", *, kwarg1="default", kwarg2="default"):
        pass

# 使用inspect.signature获取类的__init__方法的签名对象
sig = inspect.signature(MyClass.__init__)

# 打印类的__init__方法的参数信息
for name, param in sig.parameters.items():
    print(f"Parameter: {name}")
    print(f"  Default value: {param.default}")
    print(f"  Annotation: {param.annotation}")
    print(f"  Kind: {param.kind}")
    print(f"  Required: {param.default == param.empty}")
    print()

在上述示例中，我们定义了一个名为MyClass的类，并在其__init__方法中定义了多个参数，包括位置参数、关键字参数和默认值参数。

我们将MyClass.__init__作为参数传递给inspect.signature函数，获取__init__方法的签名对象sig。

然后，我们遍历签名对象的parameters属性，打印每个参数的名称、默认值、注释、类型以及是否为必需参数等信息。

这样，您可以使用inspect.signature函数读取类的__init__方法的参数信息，以便在运行时了解类的构造函数参数。

---

Q: 如果传递给 inspect.signature 的是一个 class instance，读取的是什么？

A:如果将一个类的实例（class instance）作为参数传递给inspect.signature函数，它将读取实例对应类的__call__方法的签名信息。

在Python中，当类实现了__call__方法时，该类的实例可以被调用，就像调用函数一样。因此，__call__方法定义了类实例可调用时的行为，并包含参数列表和默认值。inspect.signature函数用于获取函数的签名对象，其中包括参数信息。

以下是一个示例，展示了如何使用inspect.signature来读取类实例的__call__方法的参数信息：

import inspect

class MyClass:
    def __call__(self, arg1, arg2="default", *, kwarg1="default", kwarg2="default"):
        pass

# 创建MyClass的实例
obj = MyClass()

# 使用inspect.signature获取实例的__call__方法的签名对象
sig = inspect.signature(obj.__call__)

# 打印实例的__call__方法的参数信息
for name, param in sig.parameters.items():
    print(f"Parameter: {name}")
    print(f"  Default value: {param.default}")
    print(f"  Annotation: {param.annotation}")
    print(f"  Kind: {param.kind}")
    print(f"  Required: {param.default == param.empty}")
    print()

在上述示例中，我们定义了一个名为MyClass的类，并在其__call__方法中定义了多个参数，包括位置参数、关键字参数和默认值参数。

然后，我们创建了MyClass的一个实例obj。我们将obj.__call__作为参数传递给inspect.signature函数，获取__call__方法的签名对象sig。

最后，我们遍历签名对象的parameters属性，打印每个参数的名称、默认值、注释、类型以及是否为必需参数等信息。

这样，您可以使用inspect.signature函数读取类实例的__call__方法的参数信息，以便在运行时了解类实例可调用时的参数。