基本上我正在编写一个函数,它依赖于数字输入 x,一个介于 0 和 1 之间的数字。我希望 x 的默认值是,比方说,x=0.5。但是,我还想为用户提供一个选项,允许他们让程序使用某种算法为他们选择 x。有没有一种优雅的方法可以通过一个函数参数来处理该选择?
我是这样想的:
def foo(x=0.5):
if x == "pick for me":
return complicated_algorithm_that_picks_x()
else:
return x
def complicated_algorithm_that_picks_x():
print "Thinking hard..."
return 0.1234567
会返回:
>>> foo()
0.5
>>> foo(0.3)
0.3
>>> foo("pick for me")
Thinking hard...
0.1234567
但这看起来真的很不雅观,因为用户必须知道要传递什么魔法字符串才能调用选择算法。我有什么想法可以更干净地处理这个问题吗?
我在想有一个额外的 bool 参数叫做 pick(默认为 False),当它为 True 时将调用 x picking 函数。但随后用户可能同时传递 x=0.3 和 pass=True,在这种情况下我不得不任意忽略其中一个选择。又显得笨拙了。
请您参考如下方法:
您可能会考虑三件事:
- 将一个功能分成两个。
- 使用类。
- 多个默认参数。
这里有,排名不分先后:
将一个函数拆分为两个
如果你想在一个函数中做两件不同的事情,而你在设计一个自然界面时遇到了麻烦,这可能是一个信号应该变成两个:
def foo_picked_for_me():
x = pick_x()
return foo(x)
def foo(x):
# do foo
pass
我不知道这对您有何影响,但它简单明了,这意味着它通常更受欢迎。
使用类
默认参数很好,但是函数的接口(interface)只会变得如此复杂,然后才能开始更有意义地处理类的选项设置:
class Foo:
def __init__(self):
self.x = 0.5
def pick_x_for_me(self):
self.x = pick_x()
def foo(self):
# do foo with self.x
正如 EOL 在下面建议的那样,让 x “暴露”并允许用户更改它是完全符合 pythonic 的。不过,您说 x 必须介于 0 和 1 之间,因此使用 x 的 setter 进行一些边界检查可能是有意义的:
class Foo(object):
def __init__(self):
self._x = 0.5
@property
def x(self):
return self._x
@x.setter
def x(self, value):
if 0 <= value <= 1:
self._x = value
else:
raise ValueError("x must be between 0 and 1")
def pick_x_for_me(self):
self._x = pick_x()
def foo(self):
pass
# do foo with self._x
多个默认参数
最后一个选项类似于其他发帖者给出的选项:使用两个参数,如果用户做了一些自相矛盾的事情则抛出异常。我会考虑允许三种形式的调用:
# x gets its default value of 0.5
foo()
# x gets the specified value
foo(x=.42)
# x is picked for me
foo(pick_for_me=True)
此外,如果我写:
foo(x=.42, pick_for_me=True)
我会抛出一个异常。实现这一点的一些代码如下:
def foo(x=None, pick_for_me=None):
if x is None and pick_for_me is None:
x = 0.5
elif pick_for_me and x:
raise RuntimeError("You can't set both!")
elif pick_for_me:
x = picking_algorithm()
# else x was set, so leave it be
这有点复杂,我不确定我是否喜欢这个 API。只要确保您足够好地记录行为,以便用户知道如何使用它。
