极客教程如何在Python函数内获取参数名称列表
要从函数或函数[something]中提取参数的数量和名称以返回（“arg1”，“arg2”），我们使用inspect模块。
给定的代码使用inspect模块编写，以查找函数aMethod和foo内部的参数。
示例
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,))
要获取Python函数内的参数名称列表，您可以使用inspect模块。该模块具有许多功能，可让您检查Python对象的属性，包括函数。
以下是一个使用inspect模块获取参数名称列表的示例函数：
示例
import inspect
def get_parameter_names(func):
"""Returns a list of parameter names for the given function."""
signature = inspect.signature(func)
return [param.name for param in signature.parameters.values()]
# Example usage
def my_function(a, b, c=1, *args, **kwargs):
pass
parameter_names = get_parameter_names(my_function)
print(parameter_names)
输出
['a', 'b', 'c', 'args', 'kwargs']
在此示例中，get_parameter_names函数接受单个参数func，它是要检查的函数。
使用inspect.signature函数获取给定函数的签名对象。签名对象包含有关函数参数的信息，包括它们的名称和默认值。
parameters对象的values属性返回Parameter对象的有序字典，其中每个对象都对应于函数签名中的一个参数。然后，我们循环遍历这些Parameter对象，并使用name属性提取参数名称。
为了测试函数，我们定义了一个名为my_function的示例函数，该函数需要几个参数，包括一些具有默认值的位置和关键字参数。然后，我们使用my_function调用get_parameter_names，并返回参数名称列表：
此列表包括在my_function中定义的所有参数，包括位置参数a和b、关键字参数c以及变量长度参数列表args和kwargs。
请注意，get_parameter_names函数不包括实例方法的self参数，因为此参数是隐式的，不在函数签名中明确定义。
以下是另一个示例，演示如何使用此函数检查在不同模块中定义的函数对象：
示例
import module_name
parameter_names = get_parameter_names(module_name.function_name)
print(parameter_names)
在此示例中，我们假设有一个名为module_name的Python模块，该模块定义了一个名为function_name的函数。我们可以使用import语句导入模块，然后将函数对象module_name.function_name传递给get_parameter_names函数以获取其参数名称列表。
如果您正在处理跨多个模块定义的函数的复杂代码库，或者正在编写需要检查其他开发人员定义的函数的实用程序函数，则此技术可能很有用。
最后，请注意，get_parameter_names函数设计用于与Python 3一起使用。对于Python 2，可以使用inspect.getargspec函数实现类似的功能。但是，请注意inspect.signature函数已取代该函数，因为Python 3中不再支持这个函数。
以下是另一个示例，演示如何使用get_parameter_names函数实时生成函数文档：
示例
def my_function(a, b, c=1, *args, **kwargs):
"""
This is an example function.
Parameters:
----------
{}
Returns:
-------
None
"""
pass
parameter_names = get_parameter_names(my_function)
parameter_docs = "\n ".join(f"{name}: " for name in parameter_names)
docstring = my_function.__doc__.format(parameter_docs)
my_function.__doc__ = docstring
print(my_function.__doc__)
在此示例中，我们定义了一个名为my_function的示例函数，该函数需要几个参数，包括一些具有默认值的位置和关键字参数。函数的文档字符串具有解释函数作用及其参数是什么的文档字符串。
然后，我们使用get_parameter_names函数获取函数的参数名称列表。然后生成一个格式化的字符串，其中包含每个参数的空行，以及参数名称和冒号。
最后，我们使用函数的docstring的format方法将参数文档字符串替换为docstring。这会生成一个动态生成的docstring，其中包含每个参数的描述。
然后，我们可以打印docstring以验证它是否包含动态生成的参数文档。
如果您正在编写具有大量参数或希望确保函数的文档始终与函数签名保持最新的函数，则此技术可能很有用。
以下是另一个示例，显示如何使用get_parameter_names函数验证函数的输入参数：
示例
def my_function(a, b, c=1, *args, **kwargs):
"""
This is an example function.
Parameters
----------
a : int
An integer.
b : float
A float.
c : int, optional
An optional integer.
args : tuple
Variable-length argument list.
kwargs : dict
Arbitrary keyword arguments.
Returns
-------
float
A float value.
"""
if not isinstance(a, int):
raise TypeError("a must be an integer")
if not isinstance(b, float):
raise TypeError("b must be a float")
# ... more validation code ...
return a + b + c
def validate_input(func):
parameter_names = get_parameter_names(func)
def wrapper(*args, **kwargs):
signature = inspect.signature(func)
bound_arguments = signature.bind(*args, **kwargs)
bound_arguments.apply_defaults()
for name, value in bound_arguments.arguments.items():
parameter = signature.parameters[name]
if not isinstance(value, parameter.annotation):
raise TypeError(f"{name} must be {parameter.annotation}")
return func(*args, **kwargs)
return wrapper
my_function = validate_input(my_function)
result = my_function(1, 2.0, c=3)
print(result)
在此示例中，我们定义了一个名为my_function的示例函数，该函数需要几个参数，包括一些具有默认值的位置和关键字参数。函数的文档字符串具有解释函数作用及其参数是什么的文档字符串。
然后，我们定义了一个名为validate_input的装饰器函数，它以函数作为其参数。装饰器使用get_parameter_names函数获取函数的参数名称列表，然后定义一个新的wrapper函数，在调用原始函数之前执行输入验证。
wrapper函数首先使用signature函数获取原始函数的签名对象，然后使用bind方法将输入参数绑定到函数的参数上。我们然后为任何缺少的参数应用默认值。
接下来，我们循环遍历绑定参数中的每个参数名称及其对应的值，并根据参数的注释检查该值是否属于正确的类型。
如果任何输入参数未通过验证，则wrapper函数将引发带有参数名称及其预期类型的TypeError错误。
最后，我们返回调用原始函数与输入参数的结果。
要将装饰器应用于my_function，只需使用my_function作为其参数调用validate_input，然后将结果重新分配给my_function。然后我们可以使用参数调用my_function，并且在调用原始函数之前，装饰器将验证参数。
如果您正在编写需要严格输入验证以确保函数的行为对所有输入都定义良好的函数，则此技术可能很有用。