如何在 Python 函数中获取参数名称列表？

2025 年 1 月 5 日 | 阅读 9 分钟

Python 函数简介

定义与作用

在 Python 中，函数是封装一组活动或计算的关键代码单元。它们充当组织和组合代码的构建块，具有通用性和可重用性。函数允许开发人员将逻辑封装到可重用的块中，从而促进更清晰的代码设计和更易于维护。

语法与结构

在 Python 中定义函数的语言结构包括使用 def 关键字，后跟函数名和包含可选参数的括号。基本结构是：

def function_name(parameter1, parameter2, ...):
    # Function body - Code block to perform explicit errands
    # Explanations and calculations go here
    return esteem # Alternatively return a worth

示例

def greet(name):
    return f"Hello, {name}!"
result = greet("Alice")
print(result) # Here, the result will be: Hello, Alice!

函数参数

参数是函数用于执行其定义任务的输入。它们允许函数动态地接收数据。在 Python 中，函数参数有多种类型：

位置参数：在函数签名中定义，并通过其顺序与参数匹配。
关键字参数：通过其名称进行标识，并分配默认值或在函数调用期间显式设置。
默认参数：具有预定义默认值的参数，允许使用更少的参数调用函数。
任意参数列表 (*args 和 **kwargs)：用于可变数量的参数，使函数能够接受任意数量的位置参数或关键字参数。

理解函数参数

位置参数

位置参数在函数签名中定义，并根据其各自的位置或顺序与参数匹配。它们的重要性在于传递的参数顺序与函数内定义的参数之间的严格对应关系。它们是函数调用的核心，其顺序对于精确的函数执行至关重要。

示例

def greet_user(name, age):
    return f"Hello, {name}! You are {age} years old."
# Here, we are calling the function with positional contentions
result = greet_user("Alice", 30)
print(result) # Here, the result will be: Hello, Alice! You are 30 years of age.

关键字参数

关键字参数在函数调用期间通过其名称进行标识。它们提供了以任何顺序传递参数的灵活性，通过使用它们的名称显式地将值分配给参数。这种方法提高了代码的可读性，并允许在为特定参数提供显式值时跳过默认参数。

示例

def greet_user(name, age):
    return f"Hello, {name}! You are {age} years old."
# Here, we are calling the function with watchword contentions
result = greet_user(age=30, name="Alice")
print(result) # Here, the result will be: Hello, Alice! You are 30 years of age.

默认参数

默认参数是在函数中具有预定义值的参数。在函数调用期间未显式提供相应参数时，将使用这些值。它们通过允许使用更少的参数进行调用，在未指定某些参数时提供默认行为，从而增强了函数的灵活性。

示例

def greet_user(name, greeting="Hello"):
    return f"{greeting}, {name}!"
# Here, we are calling the function without giving 'hello'
result = greet_user("Alice")
print(result) # Here, the result will be: Hello, Alice!
# Here, we are calling the function with 'hello' unequivocally gave
result_custom = greet_user("Alice", "Hey")
print(result_custom) # Here, the result will be: Hello, Alice!

任意参数列表 (*args 和 **kwargs)

任意参数列表（*args 和 **kwargs）允许函数分别接受可变数量的位置参数或关键字参数。它们提供了极大的灵活性，使函数能够处理任意数量的参数，而无需显式命名它们。当传递给函数的参数数量未知或可变时，这特别有用。

示例

def process_data(*args, **kwargs):
    # Here, the 'args' will be a tuple containing positional contentions
    # 'kwargs' will be a word reference containing catchphrase contentions
    print("Positional contentions:", args)
    print("Keyword contentions:", kwargs)
# Here, we are calling the function with inconsistent contentions
process_data(1, 2, 3, name="Alice", age=30)
# Yield:
# Positional contentions: (1, 2, 3)
# Keyword contentions: {'name': 'Alice', 'age': 30}

inspect 模块概述

Python 的 inspect 模块是用于自省的宝贵资源，它允许开发人员在运行时提取有关函数、类和其他对象的信息。它提供了各种函数，可以动态访问对象的属性，包括它们的签名、参数等等。

方法 1：使用 inspect.signature()

inspect.signature() 函数对于检索函数的签名至关重要，该签名封装了有关其参数的详细信息。它返回一个 Signature 对象，其中包含参数名称到 Parameter 对象的映射。这些 Parameter 对象传达了重要的元数据，如名称、默认值、类型和种类。

示例

import inspect     # Here, we are importing the inspect module
def my_function(a, b, c=10, *args, **kwargs):
    pass
parameters = inspect.signature(my_function).parameters
parameter_names = list(parameters.keys())
print("Getting the list of parameters Using the inspect.signature():", parameter_names)

输出

Getting the list of parameters Using the inspect.signature(): ['a', 'b', 'c', 'args', 'kwargs']

此方法允许对函数的参数进行彻底检查，从而能够动态分析和自省其预期的输入和行为。它是自动理解和操作函数接口的基础。

说明

导入 inspect 模块，它提供了在运行时检查函数、类等对象的自省能力。
定义了一个示例函数 my_function，它具有不同类型的参数，包括位置参数（a、b、c）、可变位置参数（*args）和可变关键字参数（**kwargs）。
inspect.signature() 函数检索并表示 my_function 的签名，捕获有关其参数的详细信息。parameters 变量保存了参数名称到 Parameter 对象的映射。
通过将 Parameter 对象字典转换为键列表（参数名称），parameter_names 变量包含与 my_function 的参数对应的名称列表。
最后的 print 语句输出了使用 inspect.signature() 获取的参数名称列表。

方法 2：inspect.getfullargspec()

尽管在较新的 Python 版本中已被弃用，inspect.getfullargspec() 仍可提供有关函数参数的信息，包括参数名称、可变参数（*args）、关键字参数（**kwargs）和默认值。虽然仍然有用，但建议迁移到 inspect.signature()，因为它具有更好的表示和与现代 Python 实践的一致性。

示例

import inspect     # Here, we are importing the inspect module
def my_function(a, b, c=10, *args, **kwargs):
    pass
argspec = inspect.getfullargspec(my_function)
parameter_names_deprecated = argspec.args
print("Using inspect.getfullargspec():", parameter_names_deprecated)

输出

Getting the list of parameters Using the inspect.getfullargspec(): ['a', 'b', 'c', 'args', 'kwargs']

说明

代码导入 inspect 模块，从而能够在 Python 中实现自省功能。
定义了一个示例函数 my_function，它具有不同类型的参数，包括位置参数（a、b、c）、可变位置参数（*args）和可变关键字参数（**kwargs）。
使用 inspect.getfullargspec() 函数来检索有关 my_function 接受的参数的信息。此函数返回一个 FullArgSpec 对象，其中包含有关函数参数的详细信息，包括位置参数、可变参数（*args）、可变关键字参数（**kwargs）和默认值。
从 inspect.getfullargspec() 中检索到的 argspec.args 属性包含 my_function 中位置参数的名称。
print 语句输出了使用 inspect.getfullargspec() 获取的位置参数名称列表。

方法 3：访问 func.code.co_varnames

直接访问函数的 __code__.co_varnames 属性允许检索存储在函数代码对象内的变量名。虽然这提供了局部变量和参数的名称，但它缺乏通过其他自省方法获得的详细参数信息。它的范围更有限，但仍然可以满足基本的自省需求。

示例

def my_function(a, b, c=10, *args, **kwargs):
    pass
parameter_names_co_varnames = my_function.__code__.co_varnames
print("Using func.__code__.co_varnames:", parameter_names_co_varnames[:my_function.__code__.co_argcount])

输出

Getting the list of parameters Using the func.__code__.co_varnames: ['a', 'b', 'c', 'args', 'kwargs']

说明

这段代码定义了一个名为 my_function 的函数，它具有不同类型的参数，包括位置参数（a、b、c）、可变位置参数（*args）和可变关键字参数（**kwargs）。
代码访问 my_function 的 __code__ 属性，其中包含与函数相关的代码对象。代码对象内的 co_varnames 属性包含一个变量名元组，包括参数名和局部变量。
parameter_names_co_varnames 捕获代码对象中的变量名。通过切片 [:my_function.__code__.co_argcount] 来检索参数名，直到参数计数（co_argcount）为止，不包括局部变量。
print 语句输出了使用 my_function.__code__.co_varnames 获取的参数名称列表。

方法 4：inspect.getargspec()

inspect.getargspec() 以前用于检索参数信息，但由于其局限性和冗余，在较新的 Python 版本中已被弃用并删除。它提供了与 inspect.signature() 类似的功能，但灵活性和全面性较差。

示例

import inspect      # Here, we are importing the inspect module
def my_function(a, b, c=10, *args, **kwargs):
    pass
argspec_deprecated = inspect.getargspec(my_function)
parameter_names_deprecated_2 = argspec_deprecated.args
print("Using inspect.getargspec():", parameter_names_deprecated_2)

输出

Getting the list of parameters Using the inspect.getargspec(): ['a', 'b', 'c', 'args', 'kwargs']

说明

代码导入 inspect 模块，从而能够在 Python 中实现自省功能。
定义了一个示例函数 my_function，它具有不同类型的参数，包括位置参数（a、b、c）、可变位置参数（*args）和可变关键字参数（**kwargs）。
使用已弃用的 inspect.getargspec() 方法来检索有关 my_function 接受的参数的信息。此方法返回一个 ArgSpec 对象，其中包含有关函数参数的信息，包括位置参数的名称。
从 inspect.getargspec() 中检索到的 argspec_deprecated.args 属性包含 my_function 中位置参数的名称。
print 语句输出了使用 inspect.getargspec() 获取的位置参数名称列表。

方法 5：使用 inspect.signature() 和循环

将 inspect.signature() 与循环结合使用，通过循环遍历参数，提供了一种访问和检查单个参数属性的全面方法。通过迭代 Parameter 对象，可以提取特定详细信息，如默认值、参数类型等，从而提供细粒度的自省能力。

示例

import inspect      # Here, we are importing the inspect module
def my_function(a, b, c=10, *args, **kwargs):
    pass
sig = inspect.signature(my_function)
for param in sig.parameters.values():
    print(param.name, ":", param.kind)

输出

a: POSITIONAL_OR_KEYWORD
b: POSITIONAL_OR_KEYWORD
c: POSITIONAL_OR_KEYWORD
args: VAR_POSITIONAL
kwargs: VAR_KEYWORD

说明

代码导入 inspect 模块，从而能够在 Python 中实现自省功能。
定义了一个示例函数 my_function，它具有不同类型的参数，包括位置参数（a、b、c）、可变位置参数（*args）和可变关键字参数（**kwargs）。
inspect.signature() 函数检索并表示 my_function 的签名。它返回一个 Signature 对象，该对象封装了有关函数参数的详细信息。
使用 for 循环来迭代 sig.parameters 的值，其中包含参数名称到 Parameter 对象的映射。
在循环内部，param.name 访问每个参数的名称，而 param.kind 访问参数的类型（例如，POSITIONAL_OR_KEYWORD、VAR_POSITIONAL、VAR_KEYWORD）。
print 语句输出了每个参数的名称和类型，展示了使用 inspect.signature() 访问和显示函数参数信息的能力。

参数处理最佳实践

清晰且具有描述性的名称

为参数使用有意义的名称，以传达它们在函数中的目的和用法。清晰的命名可以提高可读性和理解性。

参数顺序一致性

保持位置参数的顺序一致，将它们正确组织起来，以便于理解和使用。

可选参数的默认值

使用默认参数值来为可选参数提供合理的默认值，从而减少不必要函数重载的需求。

避免过多的参数

限制参数数量，以保持函数的简洁和专注。考虑将相关参数分组到对象中，或使用配置字典来简化接口。

文档和注解

使用 docstrings 和类型注解来记录参数、它们的类型和预期的用法，以帮助开发人员和静态分析器等工具。

实际用例

API 开发

在 API 设计中，理解函数参数对于定义端点和请求处理至关重要。参数检索有助于处理各种 API 调用和处理用户输入。

框架使用

在 Django 或 Flask 等框架中，理解参数有助于路由、中间件应用和视图处理。它有助于框架内的定制和集成。

库开发

在构建库或模块时，清晰的参数和它们的检索使用户能够与提供的功能进行无缝交互。适当的参数处理可以提高库的可用性。

数据处理管道

在数据处理管道中，参数检索有助于配置处理步骤，处理数据变体，并根据用户定义的设置改变行为。

优化和性能考量

参数开销

过多的参数，尤其是在性能关键区域，可能会影响执行时间和内存使用。限制不必要的参数可以优化函数调用。

默认参数的影响

虽然默认参数增强了灵活性，但过多的默认值可能会使函数行为变得复杂。注意可能对性能产生负面影响的复杂默认值。

参数解包与直接访问

对于性能关键组件，考虑解包 *args 或 **kwargs 与直接访问已知参数之间的权衡。直接访问可能比解包大型参数列表更有效。

动态参数处理的影响

像 inspect.signature() 这样的动态参数检索技术可能会因自省而带来轻微的开销。在性能关键场景中广泛使用这些技术时，请评估性能影响。

下一个主题如何在 Matplotlib 中绘制平滑曲线

如何在 Python 函数中获取参数名称列表？

Python 函数简介

定义与作用

语法与结构

示例

理解函数参数

位置参数

关键字参数

默认参数

任意参数列表 (*args 和 **kwargs)

inspect 模块概述

方法 1：使用 inspect.signature()

方法 2：inspect.getfullargspec()

方法 3：访问 func.code.co_varnames

方法 4：inspect.getargspec()

方法 5：使用 inspect.signature() 和循环

参数处理最佳实践

实际用例

优化和性能考量

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

其他

如何在 Python 函数中获取参数名称列表？

Python 函数简介

定义与作用

语法与结构

示例

理解函数参数

位置参数

关键字参数

默认参数

任意参数列表 (*args 和 **kwargs)

inspect 模块概述

方法 1：使用 inspect.signature()

方法 2：inspect.getfullargspec()

方法 3：访问 func.__code__.co_varnames

方法 4：inspect.getargspec()

方法 5：使用 inspect.signature() 和循环

参数处理最佳实践

实际用例

优化和性能考量

相关帖子

Python中的sys.stdout.write

使用Python检测未知语言

如何在Matplotlib中绘制对数坐标轴

Python tempfile模块

Python用于网格和点云可视化的库

Python中星号*的5种语法应用

诊断和修复Python中的内存泄漏

Python 包

Python wheel是什么

使用Matplotlib在Python中绘制100%堆叠条形图和柱状图

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器

方法 3：访问 func.code.co_varnames