文章归档

置顶文章

Web安全

Web安全基础

PHP相关

Writeups

靶机系列

HackTheBox

VulnHub

代码审计

PHP代码审计

流量分析

机器学习

基础学习

Python

Python编程

Java

Java编程

算法

Leetcode

随笔

经验

技术

 2019-09-14   2k

Python函数的参数

关于Python的参数,在各种代码中看到最多的可能就是def func(*args, **kw)这种参数组合,这篇文章就来讨论我们是如何一步一步来得到这样的参数组合。

概述

Python的函数定义非常简单,但灵活度却非常大。除了正常定义的必选参数外,还可以使用默认参数、可变参数和关键字参数,使得函数定义出来的接口,不但能处理复杂的参数,还可以简化调用者的代码。

位置参数

位置参数是我们最常见的函数参数,例如下面完成幂运算的pow函数:

1
2
3
4
5
6
def pow(x, n):
s = 1
while n > 0:
n = n - 1
s = s * x
return s

pow(x, n)函数有两个参数:xn,这两个参数都是位置参数,调用函数时,传入的两个值按照位置顺序依次赋值给参数xn

默认参数

由于我们经常计算x^2,所以,完全可以把第二个参数n的默认值设定为2

1
2
3
4
5
6
def pow(x, n=2):
s = 1
while n > 0:
n = n - 1
s = s * x
return s

这样,我们在调用pow(5)时,相当于调用pow(5, 2)

1
2
3
4
>>> power(5)
25
>>> power(5, 2)
25

设置默认参数时,有几点需要注意:

  • 必选参数在前,默认参数在后,否则Python编译器会报错;
  • 当函数有多个参数时,把变化大的参数放前面,变化小的参数放后面。变化小的参数就可以作为默认参数。
  • 也可以不按顺序提供部分默认参数。当不按顺序提供部分默认参数时,需要把参数名写上。

默认参数有个最大的坑,如下:

1
2
3
4
5
6
7
8
9
10
>>> def add_end(L=[]):
... L.append('END')
... return L
...
>>> add_end()
['END']
>>> add_end()
['END', 'END']
>>> add_end()
['END', 'END', 'END']

我们发现,每次使用默认参数调用add_end()函数时,都会“记住“上一次调用的结果。

原因如下:

Python函数在定义的时候,默认参数L的值就被计算出来了,即[],因为默认参数L也是一个变量,它指向对象[],每次调用该函数,如果改变了L的内容,则下次调用时,默认参数的内容就变了,不再是函数定义时的[]了。

所以,默认参数必须指向不可变对象!!!

上面的例子修改如下:

1
2
3
4
5
def add_end(L=None):
if L == None:
L = []
L.append('END')
return L

可变参数

以数学题为例子,给定一组数字a,b,c……,请计算a^2 + b^2 + c^2 + ……,由于参数不确定,首先想到可以把a,b,c…作为一个list或者tuple传进来。

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

在传参时就需要先组装一个tuplelist

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

如果使用可变参数:

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

在函数内部,参数numbers接收到的是一个tuple,因此,函数代码完全不变。但是,调用该函数时,可以传入任意个参数,包括0个参数:

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

如果已经有一个listtuple,传参时可以使用*来对其进行解包操作:

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

*nums表示把nums这个list的所有元素作为可变参数传进去。

关键字参数

关键字参数允许你传入0个或任意个含参数名的参数,这些关键字参数在函数内部自动组装为一个dict。例如:

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

在调用该函数时,可以只传入必选参数:

1
2
3
>>> person('Colin', 24)
name: Colin age: 24 other: {}

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

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

关键字参数可以扩展函数功能,例如:正在做一个用户注册的功能,除了用户名和年龄是必填项外,其他都是可选项,利用关键字参数来定义这个函数就能满足注册的需求。

和可变参数类似,可以先组装出一个dict,再把该dict转换为关键字参数传进去:

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

可以简化为:

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

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

命令关键字参数

对于关键字参数,函数的调用者可以传入任意不受限制的关键字参数。如果要限制关键字参数的名字,可以用命名关键字参数。例如只接收cityjob作为关键字参数:

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

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

调用方式如下:

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

如果参数中已经有一个可变参数,后面跟着的命令关键字参数就不需要分隔符*

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

命名关键字参数必须传入参数名,这和位置参数不同。

参数组合

参数定义的顺序必须是:必选参数、默认参数、可变参数、命名关键字参数和关键字参数。例如:

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

函数调用如下:

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

还可以用一个tupledict调用上述函数:

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

总结

  • *args是可变参数,args接收一个tuple
  • **kw是关键字参数,kw接收一个dict
  • 可变参数既可以直接传入:func(1, 2, 3),还可以组装成一个listtuple传入:func(*(1, 2, 3))
  • 关键字参数既可以直接传入:func(a=1, b=2),还可以组装成一个dict传入:func(**{'a': 1, 'b': 2})
  • 命名关键字参数是为了限制调用者可以传入的参数名,同时可以提供默认值;
Copyright © ca01h 2019-2020 | 本站总访问量