【函数】【可变关键字参数】【**kwargs】可变关键字参数的详细解释，包括代码

本文链接：https://blog.csdn.net/wq6qeg88/article/details/144765584

【函数】【可变关键字参数】【**kwargs】可变关键字参数的详细解释，包括代码

【函数】【可变关键字参数】【**kwargs】可变关键字参数的详细解释，包括代码

在 Python 中，可变关键字参数（variable keyword arguments）使用 **kwargs 来表示，它允许函数接收任意数量的关键字参数。

与可变位置参数 *args 相似，**kwargs 使得函数能够接受不定数量的关键字参数，这些参数会以字典的形式传递给函数。

详细解释

**kwargs 会把传入的所有关键字参数收集到一个字典中，字典的键是参数名，值是对应的参数值。
kwargs 是一个约定的名字，代表 "key word arguments"（关键字参数），你可以使用其他名字，但通常使用 kwargs 来保持代码的可读性。
**kwargs 允许你在函数定义中指定可接收的不定数量的关键字参数，使得你能够处理多个命名参数。

语法

def function_name(fixed_arg1, fixed_arg2, **kwargs):
    # function body

fixed_arg1 和 fixed_arg2 是普通的命名参数，而 **kwargs 会收集额外的关键字参数。

示例 1：基本用法

def print_info(**kwargs):
    for key, value in kwargs.items():
        print(f"{key}: {value}")

# 调用函数
print_info(name="Alice", age=30, job="Engineer")

输出：

name: Alice
age: 30
job: Engineer

在上面的例子中，**kwargs 接收传入的所有关键字参数，并将它们存储在字典 kwargs 中。通过 .items() 方法，我们遍历并打印了字典中的每一对键值。

示例 2：关键字参数与常规参数结合

**kwargs 可以与常规参数（位置参数和可变位置参数 *args）一起使用，但它必须位于位置参数和 *args 参数之后。

def introduce(name, *args, **kwargs):
    print(f"Name: {name}")
    print("Additional info:", args)
    print("Keywords info:", kwargs)

# 调用函数
introduce("Alice", 25, "USA", country="USA", job="Engineer")

输出：

Name: Alice
Additional info: (25, 'USA')
Keywords info: {'country': 'USA', 'job': 'Engineer'}

这里，name 是普通的命名参数，*args 捕获位置参数，**kwargs 捕获关键字参数。注意 *args 和 **kwargs 的顺序。

示例 3：关键字参数的默认值

我们还可以使用 **kwargs 为一些可选的参数设置默认值。

这可以在函数内部检查 kwargs 是否包含某些预期的关键字，如果没有提供相应的值，可以使用默认值。

def greet(**kwargs):
    name = kwargs.get("name", "Guest")  # 如果没有提供 name 参数，使用默认值
    age = kwargs.get("age", "Unknown")  # 如果没有提供 age 参数，使用默认值
    print(f"Hello {name}, you are {age} years old.")

# 调用函数
greet(name="Alice", age=30)  # 输出 "Hello Alice, you are 30 years old."
greet(name="Bob")             # 输出 "Hello Bob, you are Unknown years old."
greet()                      # 输出 "Hello Guest, you are Unknown years old."

使用 kwargs.get() 方法可以安全地获取字典中的值。如果关键字参数不存在，则返回指定的默认值。

示例 4：与其他参数混合使用

**kwargs 可以和常规参数以及 *args 结合使用，但需要遵守一定的顺序：

常规参数
*args
**kwargs

def order_food(item, quantity=1, *extras, **special_requests):
    print(f"Item: {item}, Quantity: {quantity}")
    print("Extras:", extras)
    print("Special Requests:", special_requests)

# 调用函数
order_food("Pizza", 2, "Olives", "Cheese", size="Large", crust="Thin")

输出：

Item: Pizza, Quantity: 2
Extras: ('Olives', 'Cheese')
Special Requests: {'size': 'Large', 'crust': 'Thin'}

这里，item 是普通的命名参数，quantity 有一个默认值，*extras 捕获位置参数（例如额外的配料），**special_requests 捕获关键字参数（例如尺寸、外皮等）。

示例 5：没有关键字参数的情况

如果没有传递任何关键字参数，**kwargs 会是一个空字典。

def process_data(**kwargs):
    if not kwargs:
        print("No additional information provided.")
    else:
        print("Processing additional information:", kwargs)

# 调用函数
process_data()  # 输出 "No additional information provided."
process_data(name="Alice", age=30)  # 输出 "Processing additional information: {'name': 'Alice', 'age': 30}"

当没有传递任何关键字参数时，kwargs 是一个空字典 {}，你可以在函数中进行检查并作出相应的处理。

示例 6：`**kwargs` 和函数重载

Python 本身不支持函数重载，但你可以通过 **kwargs 来模拟类似的功能，实现同一个函数在不同情况下的多种行为。

def create_profile(**kwargs):
    if "name" in kwargs and "age" in kwargs:
        print(f"Creating profile for {kwargs['name']}, age {kwargs['age']}.")
    elif "name" in kwargs:
        print(f"Creating profile for {kwargs['name']}.")
    else:
        print("Creating an anonymous profile.")

# 调用函数
create_profile(name="Alice", age=30)  # 输出 "Creating profile for Alice, age 30."
create_profile(name="Bob")             # 输出 "Creating profile for Bob."
create_profile()                       # 输出 "Creating an anonymous profile."

通过 **kwargs，我们能够根据传入的不同关键字参数来决定函数的行为。

总结

**kwargs 是一个非常强大的特性，它使得函数能够接收不定数量的关键字参数。
通过 **kwargs，你可以灵活地处理传入的关键字参数，适应不同的调用需求。
**kwargs 接收的是一个字典，其中的键是参数的名字，值是参数的值。你可以通过 kwargs.get() 获取参数值，也可以直接访问 kwargs 字典中的值。
**kwargs 可以与常规参数和 *args 一起使用，使得函数可以同时处理位置参数、可变位置参数和关键字参数。