Python函数 — 位置参数和关键字参数

1、参数分类

Python函数的参数可以分为默认参数，位置参数，关键字参数，可变参数。函数可以没有参数，也可以有多个参数。

形参：定义函数时的参数，如定义函数def func(a,b)的参数a,b是形参。
实参：调用函数时参数的值，如调用函数func(2,3)的参数2,3是实参。
默认参数：定义函数时，为形参提供默认值，默认参数必须在最右端。调用函数的时候如果没有传入实参，则取默认参数。如果传入实参，则取实参。
位置参数：调用函数时传入实际参数的数量和位置都必须和定义函数时保持一致。
关键字参数：调用函数的时候使用的是键值对的方式，key=values。混合传参时关键字参数必须在位置参数之后。
可变参数

2、形参和实参

形参是指定义函数的时候参数列表中的参数名，实参是指调用函数的时候给形参传递的参数值。

定义函数如下，其中参数param1,param2是形参。调用函数的时候，传入实参1,2给形参param1,param2。

def fun_parameters(param1, param2):return param1 + param2print(fun_parameters(1, 2))
-------------------------------------------------------------------------
3

3、默认参数

默认参数必须放在函数参数列表的最后，可以是一个默认参数也可以有多个默认参数。

调用函数时，默认参数如果不传入实参，则使用默认参数值。默认参数如果传入实参，则使用传入的实参值。

（1）定义一个函数，形参param1，默认参数 param2=2

def fun_default_parameters(param1, param2=2):return param1 + param2print(fun_default_parameters(1))
print(fun_default_parameters(1, 5))
----------------------------------------------------------------------------
3
6

分析结果可知，调用函数的时候如果没有传入实参，则取默认参数。如果传入实参，则取实参。

4、位置参数

位置参数不是一个出现在函数定义时的概念，而是一个出现在函数调用时的概念。
调用函数时传入的实际参数数量和位置都必须和定义函数时保持一致。
实参和形参数量必须一致，参数多或者少都会报错TypeError。
实参和形参位置必须一致，否则会产生不同的结果。

（1）位置参数正常调用，调用函数时传入实际参数的数量和位置都必须和定义函数时保持一致。

def fun_positional_parameters(param1, param2):return param1 - param2print(fun_positional_parameters(5, 2))
-------------------------------------------------------------------------------
3

（2）实参和形参数量必须一致，参数多或者少都会报错TypeError

def fun_positional_parameters(param1, param2):return param1 - param2print(fun_positional_parameters(5))
-----------------------------------------------------------------------------
TypeError: fun_positional_parameters() missing 1 required positional argument: 'param2'

同理，多传入参数也会报 TypeError错误。

（3）实参和形参位置必须一致，否则会产生不同的结果

def fun_positional_parameters(param1, param2):return param1 - param2print(fun_positional_parameters(5, 2))
print(fun_positional_parameters(2, 5))
-----------------------------------------------------------------------
3
-3

5、关键字参数

关键字参数不是一个出现在函数定义时的概念，而是一个出现在函数调用时的概念。
关键字参数是指使用键值对的形式key=values来确定输入的参数值。
关键字参数允许你以任何顺序传递参数，不再需要与形参的位置完全一致，只要将参数名写正确即可。
混合传参时关键字参数必须位于位置参数之后。
使用关键字参数，可以让参数传递更加明确，让调用方清楚的知道每个参数的传值情况。

（1）关键字参数的正常调用

def fun_keyword_parameters(param1, param2):return param1 - param2print(fun_keyword_parameters(param1=5, param2=2))
---------------------------------------------------------------------------
3

（2）关键字参数不按顺序传递

def fun_keyword_parameters(param1, param2):return param1 - param2print(fun_keyword_parameters(param2=2, param1=5))
--------------------------------------------------------------------------
3

对比运行结果可知，使用关键字参数调用函数不再需要与形参的位置完全一致，只要将参数名写正确即可。

（3）关键字参数和位置参数的混合使用

# 位置参数在前，关键字参数在后
print(fun_keyword_parameters(5, param2=2))
-------------------------------------------------------------------------
3

# 关键字参数在前，位置参数在后
print(fun_keyword_parameters(param1=1, 2))
--------------------------------------------------------------------------------
SyntaxError: positional argument follows keyword argument

上面的例子我们很容易得出结论，关键字参数可以和位置参数混合使用，但是关键字参数必须在位置参数之后，否则会报语法错误SyntaxError 。

6、限制参数类型

定义函数的时候，参数中可以使用 /和 *来限制参数类型，调用函数的时候，/前面只能是位置参数，*后面只能是关键字参数，不限制之间的参数类型。

定义函数如下：param1只能是位置参数，param2可以是位置参数和关键字参数，param3只能是关键字参数。

def fun(param1, /, param2, *, param3):"""param1:Positional onlyparam2:Positional or keywordparam3:Keyword only"""pass

（1）错误的调用方式

fun(1, 2, 3)
------------------------------------------------------------------------
TypeError: fun() takes 2 positional arguments but 3 were given

fun(param1=1, param2=2, param3=3)
------------------------------------------------------------------------
TypeError: fun() got some positional-only arguments passed as keyword arguments: 'param1'

（2）正确的调用方式

fun(1, 2, param3=3)
fun(1, param2=2, param3=3)

说明：

如果你希望形参名称对用户来说不可用，则使用仅限位置形参。这适用于形参名称没有实际意义，以及当你希望强制规定调用时的参数顺序，或是需要同时收受一些位置形参和任意关键字形参等情况。
当形参名称有实际意义，以及显式指定形参名称可使函数定义更易理解，或者当你想要防止用户过于依赖传入参数的位置时，则使用仅限关键字形参。
对于 API 来说，使用仅限位置形参可以防止形参名称在未来被修改时造成破坏性的 API 变动。

reference：

位置参数和关键字参数 — Python 3.8.16 文档

术语对照表 — Python 3.8.16 文档