python可变参数类型 a,*args,**kwargs

时间：2024-06-28 11:06:02

a - int

*args --tuple

**kwargs -- dict

*args是非关键字参数，用于元组，**kw是关键字参数，用于字典

python可变参数类型 a,*args,**kwargs

可变参数

在Python函数中，还可以定义可变参数。顾名思义，可变参数就是传入的参数个数是可变的，可以是1个、2个到任意个，还可以是0个。

我们以数学题为例子，给定一组数字a，b，c……，请计算a2 + b2 + c2 + ……。

要定义出这个函数，我们必须确定输入的参数。由于参数个数不确定，我们首先想到可以把a，b，c……作为一个list或tuple传进来，这样，函数可以定义如下：

  1. def calc(numbers):
  2. sum = 0
  3. for n in numbers:
  4. sum = sum + n * n
  5. return sum

但是调用的时候，需要先组装出一个list或tuple：

  1. >>> calc([1, 2, 3])
  2. 14
  3. >>> calc((1, 3, 5, 7))
  4. 84

如果利用可变参数，调用函数的方式可以简化成这样：

  1. >>> calc(1, 2, 3)
  2. 14
  3. >>> calc(1, 3, 5, 7)
  4. 84

所以，我们把函数的参数改为可变参数：

  1. def calc(*numbers):
  2. sum = 0
  3. for n in numbers:
  4. sum = sum + n * n
  5. return sum

定义可变参数和定义一个list或tuple参数相比，仅仅在参数前面加了一个*号。在函数内部，参数numbers接收到的是一个tuple，因此，函数代码完全不变。但是，调用该函数时，可以传入任意个参数，包括0个参数：

  1. >>> calc(1, 2)
  2. 5
  3. >>> calc()
  4. 0

如果已经有一个list或者tuple，要调用一个可变参数怎么办？可以这样做：

  1. >>> nums = [1, 2, 3]
  2. >>> calc(nums[0], nums[1], nums[2])
  3. 14

这种写法当然是可行的，问题是太繁琐，所以Python允许你在list或tuple前面加一个*号，把list或tuple的元素变成可变参数传进去：

  1. >>> nums = [1, 2, 3]
  2. >>> calc(*nums)
  3. 14

*nums表示把nums这个list的所有元素作为可变参数传进去。这种写法相当有用，而且很常见。

关键字参数

可变参数允许你传入0个或任意个参数，这些可变参数在函数调用时自动组装为一个tuple,而关键字参数允许你传入0个或任意个含参数名的参数，这些关键字参数在函数内部自动组装为一个dict。请看示例：

  1. def person(name, age, **kw):
  2. print('name:', name, 'age:', age, 'other:', kw)

函数person除了必选参数name和age外，还接受关键字参数kw。在调用该函数时，可以只传入必选参数：

  1. >>> person('Michael', 30)
  2. name: Michael age: 30 other: {}

也可以传入任意个数的关键字参数：

  1. >>> person('Bob', 35, city='Beijing')
  2. name: Bob age: 35 other: {'city': 'Beijing'}
  3. >>> person('Adam', 45, gender='M', job='Engineer')
  4. name: Adam age: 45 other: {'gender': 'M', 'job': 'Engineer'}

关键字参数有什么用？它可以扩展函数的功能。比如，在person函数里，我们保证能接收到name和age这两个参数，但是，如果调用者愿意提供更多的参数，我们也能收到。试想你正在做一个用户注册的功能，除了用户名和年龄是必填项外，其他都是可选项，利用关键字参数来定义这个函数就能满足注册的需求。

和可变参数类似，也可以先组装出一个dict，然后，把该dict转换为关键字参数传进去：

  1. >>> extra = {'city': 'Beijing', 'job': 'Engineer'}
  2. >>> person('Jack', 24, city=extra['city'], job=extra['job'])
  3. name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}

当然，上面复杂的调用可以用简化的写法：

  1. >>> extra = {'city': 'Beijing', 'job': 'Engineer'}
  2. >>> person('Jack', 24, **extra)
  3. name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}

**extra表示把extra这个dict的所有key-value用关键字参数传入到函数的**kw参数，kw将获得一个dict，注意kw获得的dict是extra的一份拷贝，对kw的改动不会影响到函数外的extra。

命名关键字参数

对于关键字参数，函数的调用者可以传入任意不受限制的关键字参数。至于到底传入了哪些，就需要在函数内部通过kw检查。

仍以person()函数为例，我们希望检查是否有city和job参数：

  1. def person(name, age, **kw):
  2. if 'city' in kw:
  3. # 有city参数
  4. pass
  5. if 'job' in kw:
  6. # 有job参数
  7. pass
  8. print('name:', name, 'age:', age, 'other:', kw)

但是调用者仍可以传入不受限制的关键字参数：

>>> person('Jack', 24, city='Beijing', addr='Chaoyang', zipcode=123456)

如果要限制关键字参数的名字，就可以用命名关键字参数，例如，只接收city和job作为关键字参数。这种方式定义的函数如下：

  1. def person(name, age, *, city, job):
  2. print(name, age, city, job)

和关键字参数**kw不同，命名关键字参数需要一个特殊分隔符，后面的参数被视为命名关键字参数。

调用方式如下：

  1. >>> person('Jack', 24, city='Beijing', job='Engineer')
  2. Jack 24 Beijing Engineer

命名关键字参数必须传入参数名，这和位置参数不同。如果没有传入参数名，调用将报错：

  1. >>> person('Jack', 24, 'Beijing', 'Engineer')
  2. Traceback (most recent call last):
  3. File "<stdin>", line 1, in <module>
  4. TypeError: person() takes 2 positional arguments but 4 were given

由于调用时缺少参数名city和job，Python解释器把这4个参数均视为位置参数，但person()函数仅接受2个位置参数。

命名关键字参数可以有缺省值，从而简化调用：

def person(name, age, *, city='Beijing', job):
print(name, age, city, job)

由于命名关键字参数city具有默认值，调用时，可不传入city参数：

  1. >>> person('Jack', 24, job='Engineer')
  2. Jack 24 Beijing Engineer

使用命名关键字参数时，要特别注意，不是参数，而是特殊分隔符。如果缺少，Python解释器将无法识别位置参数和命名关键字参数：

  1. def person(name, age, city, job):
  2. # 缺少 *，city和job被视为位置参数
  3. pass

参数组合

在Python中定义函数，可以用必选参数、默认参数、可变参数、关键字参数和命名关键字参数，这5种参数都可以组合使用，除了可变参数无法和命名关键字参数混合。但是请注意，参数定义的顺序必须是：必选参数、默认参数、可变参数/命名关键字参数和关键字参数。

比如定义一个函数，包含上述若干种参数：

  1. def f1(a, b, c=0, *args, **kw):
  2. print('a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw)
  4. def f2(a, b, c=0, *, d, **kw):
  5. print('a =', a, 'b =', b, 'c =', c, 'd =', d, 'kw =', kw)

在函数调用的时候，Python解释器自动按照参数位置和参数名把对应的参数传进去。

  1. >>> f1(1, 2)
  2. a = 1 b = 2 c = 0 args = () kw = {}
  3. >>> f1(1, 2, c=3)
  4. a = 1 b = 2 c = 3 args = () kw = {}
  5. >>> f1(1, 2, 3, 'a', 'b')
  6. a = 1 b = 2 c = 3 args = ('a', 'b') kw = {}
  7. >>> f1(1, 2, 3, 'a', 'b', x=99)
  8. a = 1 b = 2 c = 3 args = ('a', 'b') kw = {'x': 99}
  9. >>> f2(1, 2, d=99, ext=None)
  10. a = 1 b = 2 c = 0 d = 99 kw = {'ext': None}

最神奇的是通过一个tuple和dict，你也可以调用上述函数：

  1. >>> args = (1, 2, 3, 4)
  2. >>> kw = {'d': 99, 'x': '#'}
  3. >>> f1(*args, **kw)
  4. a = 1 b = 2 c = 3 args = () kw = {'d': 99, 'x': '#'}
  5. >>> args = (1, 2, 3)
  6. >>> kw = {'d': 88, 'x': '#'}
  7. >>> f2(*args, **kw)
  8. a = 1 b = 2 c = 3 d = 88 kw = {'x': '#'}

所以，对于任意函数，都可以通过类似func(*args, **kw)的形式调用它，无论它的参数是如何定义的。

小结

Python的函数具有非常灵活的参数形态，既可以实现简单的调用，又可以传入非常复杂的参数。

默认参数一定要用不可变对象，如果是可变对象，程序运行时会有逻辑错误！

要注意定义可变参数和关键字参数的语法：

*args是可变参数，args接收的是一个tuple；

**kw是关键字参数，kw接收的是一个dict。

以及调用函数时如何传入可变参数和关键字参数的语法：

可变参数既可以直接传入：func(1, 2, 3)，又可以先组装list或tuple，再通过*args传入：func(*(1, 2, 3))；

关键字参数既可以直接传入：func(a=1, b=2)，又可以先组装dict，再通过**kw传入：func(**{'a': 1, 'b': 2})。

使用*args和**kw是Python的习惯写法，当然也可以用其他参数名，但最好使用习惯用法。

命名的关键字参数是为了限制调用者可以传入的参数名，同时可以提供默认值。

定义命名的关键字参数不要忘了写分隔符*，否则定义的将是位置参数。

相关文章