有没有办法将可选参数传递给函数?


132

Python中有没有一种方法可以在调用函数时将可选参数传递给函数,并且函数定义中的代码基于“仅当传递了可选参数时”

Answers:


114

Python 2中的文档,7.6。函数定义为您提供了两种方法来检测调用方是否提供了可选参数。

首先,您可以使用特殊的形式参数语法*。如果函数定义的形式参数前面带有single *,则Python会使用前形式参数(作为元组)不匹配的任何位置参数填充该参数。如果函数定义的正式参数以开头**,则Python会使用与先前正式参数不匹配的任何关键字参数(作为dict)来填充该参数。函数的实现可以检查这些参数的内容,以查找所需的任何“可选参数”。

例如,这是一个函数opt_fun,它需要两个位置参数x1x2,并寻找另一个名为“ optional”的关键字参数。

>>> def opt_fun(x1, x2, *positional_parameters, **keyword_parameters):
...     if ('optional' in keyword_parameters):
...         print 'optional parameter found, it is ', keyword_parameters['optional']
...     else:
...         print 'no optional parameter, sorry'
... 
>>> opt_fun(1, 2)
no optional parameter, sorry
>>> opt_fun(1,2, optional="yes")
optional parameter found, it is  yes
>>> opt_fun(1,2, another="yes")
no optional parameter, sorry

第二,您可以提供某个值的默认参数值,None调用者将永远不会使用该值。如果参数具有此默认值,则说明调用者未指定参数。如果参数具有非默认值,则说明它来自调用方。


7
positional_parameters是一个元组和keyword_parameters一本字典。
Cees Timmerman

python如何与a区分formal parameters preceded by * (这叫什么?)keyword parameter?据我了解,关键字参数是使用=函数调用中的运算符指定的(因此opt_fun(1,2, optional="yes")为预期但不一定需要参数的函数提供关键字参数“是” option)。
Minh Tran

另一方面,我理解formal parameters preceded by * 为“调用者提供的参数与在任何关键字参数之前的位置参数不对应”。例如,在opt_fun(1,2, "blah", 3.14, mykey="yes", myyear="2018")"blah"而且3.14forma arguments preceded by *因为它在这两个位置参数和使用该参数之间=的标志。生成的元组positional_parameter将是二元组:("blah", 3.14)。这样对吗?
Minh Tran

@MinhTran,注释中的问题不是在Stack Overflow中获得答案的最佳方法。最好单击蓝色的“问问题”按钮,然后将您的请求写为“问题”,其他人可以“回答”。但是为了帮助您,a)注意我为“ parameter” 写了“ ”而不是parameterspreceded by *”。该语言仅允许*identifier参数列表中的一种。b)阅读docs.python.org/2/reference/…,c)阅读docs.python.org/2/reference/expressions.html#calls。抱歉,此注释中的字符已用完。
吉姆·德拉汉

81
def my_func(mandatory_arg, optional_arg=100):
    print(mandatory_arg, optional_arg)

http://docs.python.org/2/tutorial/controlflow.html#default-argument-values

我发现这比使用更具可读性**kwargs

为了确定是否传递了一个参数,我使用一个自定义实用程序对象作为默认值:

MISSING = object()

def func(arg=MISSING):
    if arg is MISSING:
        ...

-谢谢,有没有一种方法可以将此参数的默认值指定为代码中的另一个变量?
user1795998

是。default_value=100; def my_func(mandatory_argument, optional_argument_with_default_value=default_value): ...
warvariuc

这似乎显示出如何使用可选参数,而不是如何测试是否通过了可选参数,这就是OP的要求。
Mawg说恢复莫妮卡

4
在大多数情况下,这是比Jim更为简单,直接的解决方案。如果将默认值设置为None,则可以检查是否传递了参数。Jim的解决方案更好的唯一情况是,区分将None作为参数传递与根本不传递参数之间的区别是否很重要。
Arnon Axelrod'9

19
def op(a=4,b=6):
    add = a+b
    print add

i)op() [o/p: will be (4+6)=10]
ii)op(99) [o/p: will be (99+6)=105]
iii)op(1,1) [o/p: will be (1+1)=2]
Note:
 If none or one parameter is passed the default passed parameter will be considered for the function. 

1
有没有办法只传递第二个参数(b)而不传递第一个参数(a)?
Djidiouf

4
@Djidiouf是的,有op(b=2)
于尔格·梅林斯巴克

7

如果要为参数提供一些默认值,请在()中分配值。像(x = 10)。但重要的是,首先应强制参数,然后默认值。

例如。

(y,x = 10)

(x = 10,y)是错误的


谢谢,有没有一种方法可以将此参数的默认值指定为代码中的另一个变量?
user1795998 2012年

是的,您可以使用称为*arg **karg函数参数的东西。在谷歌搜索。
2012年

这似乎显示出如何使用可选参数,而不是如何测试是否通过了可选参数,这就是OP的要求。
Mawg说恢复莫妮卡

2

您可以为可选参数指定一个默认值,该值将不会传递给该函数,并使用is运算符进行检查:

class _NO_DEFAULT:
    def __repr__(self):return "<no default>"
_NO_DEFAULT = _NO_DEFAULT()

def func(optional= _NO_DEFAULT):
    if optional is _NO_DEFAULT:
        print("the optional argument was not passed")
    else:
        print("the optional argument was:",optional)

那么只要您不这样做func(_NO_DEFAULT),就可以准确地检测出是否传递了参数,并且与接受的答案不同,您不必担心**表示法的副作用:

# these two work the same as using **
func()
func(optional=1)

# the optional argument can be positional or keyword unlike using **
func(1) 

#this correctly raises an error where as it would need to be explicitly checked when using **
func(invalid_arg=7)

做吧_NO_DEFAULT = object()
阿兰·菲

2条额外的行来进行更好的自省是值得的。如果运行此命令,则可以help(func)更清楚地了解如果未显式传递参数,则如何解释该参数。
塔德麦当劳-詹森
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.