理解 Python 中的关键字参数

当您使用 python 编程时，了解如何向函数传递参数是编写清晰、灵活且易于维护的代码的关键。

python 提供的一项强大功能是使用关键字参数。这些使您能够以简洁、可读且可自定义的方式调用函数。

本文将解释什么是关键字参数、如何使用它们、它们的好处、实际示例和高级功能。

什么是关键字参数？

在 python 中，函数可以通过两种主要方式接受参数：

立即学习“Python免费学习笔记（深入）”；

关键字参数

这些允许您在调用函数时显式指定参数名称，因此您不必担心顺序。
例如：

def greet(name, message):    print(f"{message}, {name}!")greet(name="alice", message="hello")

登录后复制

使用关键字参数时还可以切换参数的顺序：

greet(message="hello", name="alice")

登录后复制

两个示例都会输出：

hello, alice!

登录后复制

位置参数

它们根据它们在函数调用中的位置传递给函数。例如：

def greet(name, message):    print(f"{message}, {name}!")greet("alice", "hello")

登录后复制

这里，“alice”作为名称传递，“hello”根据他们的位置作为消息传递。

您是否厌倦了编写相同的旧 python 代码？想要将您的编程技能提升到一个新的水平吗？别再犹豫了！本书是初学者和经验丰富的 python 开发人员的终极资源。

获取“python 的神奇方法 – 超越 init 和 str”

魔术方法不仅仅是语法糖，它们是可以显着提高代码功能和性能的强大工具。通过本书，您将学习如何正确使用这些工具并释放 python 的全部潜力。

关键字参数的语法

关键字参数的语法简单直观。

调用函数时，您指定参数的名称，后跟等号 (=)，然后是要分配给该参数的值。

例如：

def order_coffee(size="medium", type="latte", syrup=none):    print(f"order: {size} {type} with {syrup if syrup else 'no'} syrup.")# calling the function with keyword argumentsorder_coffee(size="large", type="cappuccino", syrup="vanilla")# output# order: large cappuccino with vanilla syrup.

登录后复制

在此示例中，函数 order_coffee 的每个参数都有默认值，但通过使用关键字参数，您可以使用特定值覆盖这些默认值。

使用关键字参数的好处

减少错误

使用关键字参数可以帮助防止您意外地以错误的顺序传递参数时可能发生的错误。

这在大型代码库或处理具有许多参数的复杂函数时特别有用。

考虑一个处理交易的函数：

def process_transaction(amount, currency="usd", discount=0, tax=0.05):    total = amount - discount + (amount * tax)    print(f"processing {currency} transaction: total is {total:.2f}")

登录后复制

如果您使用位置参数错误地以错误的顺序传递参数，则可能会导致错误的计算。

但是，使用关键字参数可以消除这种风险：

process_transaction(amount=100, discount=10, tax=0.08)# output:# processing usd transaction: total is 98.00

登录后复制

默认值

python 函数可以为某些参数定义默认值，使它们在函数调用中可选。

这通常与关键字参数结合使用，以在不牺牲清晰度的情况下提供灵活性。

例如：

def greet(name, message="hello"):    print(f"{message}, {name}!")greet(name="alice")# output:# hello, alice!

登录后复制

在这种情况下，如果您不提供消息，则默认为“hello”，允许简单而灵活的函数调用。

灵活性

关键字参数提供了以任何顺序传递参数的灵活性。

这在具有许多参数的函数中特别有用，因为记住确切的顺序可能很麻烦。

例如，考虑一个处理用户注册的函数：

def register_user(username, email, password, age=none, newsletter=false):    print("username:", username)    print("email:", email)    print("password:", password)    print("age:", age)    print("newsletter:", newsletter)

登录后复制

使用关键字参数，您可以按如下方式调用此函数：

register_user(username="johndoe", password="securepassword", email="johndoe@example.com")# output:# username: johndoe# email: johndoe@example.com# password: securepassword# age: none# newsletter: false

登录后复制

在这个例子中，参数的顺序并不重要，使得函数调用更加灵活，更容易管理。

清晰度和可读性

关键字参数的最大优点之一是它们给代码带来的清晰度。

当您在函数调用中显式命名参数时，每个值代表的含义立即变得清晰。

这对于具有多个参数的函数或在代码可读性至关重要的团队中工作时特别有用。

比较以下两个函数调用：

# using positional argumentsorder_coffee("large", "cappuccino", "vanilla")# using keyword argumentsorder_coffee(size="large", type="cappuccino", syrup="vanilla")

登录后复制

第二个调用使用关键字参数，一目了然更容易理解。

结合位置参数和关键字参数

调用函数时可以混合使用位置参数和关键字参数。

但是，请务必注意，所有位置参数都必须位于函数调用中的任何关键字参数之前。

这是一个例子：

def describe_pet(animal_type, pet_name):    print(f"i have a {animal_type} named {pet_name}.")describe_pet("dog", pet_name="buddy")# output:# i have a dog named buddy.

登录后复制

在这种情况下，“dog”作为位置参数传递给animal_type，“buddy”作为关键字参数传递给pet_name。

尝试在关键字参数后面放置位置参数会导致语法错误。

混合位置参数和关键字参数的示例

考虑一个更复杂的示例：

def schedule_meeting(date, time, topic="general meeting", duration=1):    print(f"meeting on {topic} scheduled for {date} at {time} for {duration} hour(s).")# using both positional and keyword argumentsschedule_meeting("2024-09-25", "10:00 am", duration=2, topic="project kickoff")# output:# meeting on project kickoff scheduled for 2024-09-25 at 10:00 am for 2 hour(s).

登录后复制

在此示例中，日期和时间作为位置参数提供，而持续时间和主题作为关键字参数提供。

这种组合可以实现灵活性，同时保持函数调用的清晰度。

使用 **kwargs 处理任意关键字参数

在某些情况下，您可能想要创建接受任意数量的关键字参数的函数。

python 提供了一种使用 **kwargs 来做到这一点的方法。 kwargs 参数是一个字典，它捕获传递给函数的所有未显式定义的关键字参数。

当您想要允许额外的自定义或处理不同的参数集时，此功能特别有用。

这是一个实际示例：

def build_profile(first, last, **user_info):    profile = {        'first_name': first,        'last_name': last,    }    profile.update(user_info)    return profileuser_profile = build_profile('john', 'doe', location='new york', field='engineering', hobby='photography')print(user_profile)# output: {'first_name': 'john', 'last_name': 'doe', 'location': 'new york', 'field': 'engineering', 'hobby': 'photography'}

登录后复制

在此示例中，**user_info 捕获任何其他关键字参数并将它们添加到配置文件字典中。

这使得该函数高度灵活，允许用户传入各种属性，而无需修改函数的定义。

何时使用 **kwargs

**kwargs 功能在以下情况下特别有用：

您正在创建 api 或库，希望为未来的增强提供灵活性。您正在使用的函数可能需要接受可变数量的配置选项。您想要传递并不总是需要的附加元数据或参数。

然而，虽然 **kwargs 提供了很大的灵活性，但明智地使用它是至关重要的。

过度使用可能会导致函数难以理解和调试，因为可能无法立即清楚预期或支持哪些参数。

高级用例

覆盖函数中的默认值

在更高级的场景中，您可能希望动态覆盖函数中的默认值。

这可以使用关键字参数结合 **kwargs 模式来实现。

def generate_report(data, format="pdf", **options):    if 'format' in options:        format = options.pop('format')    print(f"generating {format} report with options: {options}")generate_report(data=[1, 2, 3], format="html", title="monthly report", author="john doe")# output:# generating html report with options: {'title': 'monthly report', 'author': 'john doe'}

登录后复制

这允许函数根据 **kwargs 中传递的关键字参数覆盖默认值，从而提供更大的灵活性。

仅关键字参数

python 3 引入了仅关键字参数的概念，这些参数必须作为关键字参数传递。

当您想要加强清晰度并防止某些参数作为位置参数传递时，这非常有用。

def calculate_total(amount, *, tax=0.05, discount=0):    total = amount + (amount * tax) - discount    return total# Correct usageprint(calculate_total(100, tax=0.08, discount=5))# Incorrect usage (will raise an error)print(calculate_total(100, 0.08, 5))

登录后复制

在此示例中，必须将税收和折扣作为关键字参数提供，以确保其意图始终清晰。