如果我有这样的python函数:
def some_func(arg1, arg2, arg3=1, arg4=2):
有没有办法确定哪些参数是通过关键字从函数内部传递的?
编辑
对于那些问我为什么需要这个的人,我没有真正的理由,它出现在一次谈话中,好奇心让我变得更好。
不,没有办法在具有此签名的Python代码中执行此操作 - 如果您需要此信息,则需要更改函数的签名。
如果你看一下Python C API,你会发现参数传递给普通Python函数的实际方式总是作为一个元组加一个字典 - 即直接反映*args, **kwargs
签名的方式。然后将该元组和字典解析为特定的位置args和在签名中命名的那些,即使它们是通过名称传递的,并且*a
和**kw
(如果存在)仅从该解析中获取“溢出”,如果有的话 - 只有在这一点上你的Python代码才能获得控制权,到那时你要求的信息(各种args如何通过)不再存在。
因此,为了获得您所要求的信息,请将签名更改为*a, **kw
并进行自己的解析/验证 - 这是“从鸡蛋到煎蛋”,即一定量的工作,但肯定是可行的,而你是什么寻找将“从煎蛋回到鸡蛋”......根本不可行;-)。
这是我通过装饰器的解决方案:
def showargs(function):
def inner(*args, **kwargs):
return function((args, kwargs), *args, **kwargs)
return inner
@showargs
def some_func(info, arg1, arg2, arg3=1, arg4=2):
print arg1,arg2,arg3,arg4
return info
In [226]: some_func(1,2,3, arg4=4)
1 2 3 4
Out[226]: ((1, 2, 3), {'arg4': 4})
可能有一种方法可以进一步清理它,但这似乎对我的干扰最小,并且不需要更改调用代码。
编辑:要实际测试是否通过关键字传递了特定的args,然后在some_func中执行以下操作:
args, kwargs = info
if 'arg4' in kwargs:
print "arg4 passed as keyword argument"
免责声明:你应该考虑一下你是否真的关心如何传递论据。整个方法可能是不必要的。
你几乎要重新定义你的功能:
def some_func(*args, **kwargs):
并自己做编组。没有办法区分pass-by-position,pass-by-keyword和default。
就这样做:
def some_func ( arg1, arg2, arg3=None, arg4=None ):
if arg3 is None:
arg3 = 1 # default value
if arg4 is None:
arg4 = 2 # default value
# do something
通过这种方式,您可以看到设置了什么,并且您还可以使用更复杂的默认结构(如列表),而不会遇到如下问题:
>>> def test( arg=[] ):
arg.append( 1 )
print( arg )
>>> test()
[1]
>>> test()
[1, 1]
你想知道arg3
是1
是因为它是从外面传递还是因为它是默认值?据我所知,没有办法做到这一点。我怀疑,主要原因是没有必要这样的知识。通常做的是以下内容:
>>> def func(a, b=None):
if b is None:
# here we know that function was called as:
# func('spam') or func('spam', None) or func('spam', b=None) or func(a='spam', b=None)
b = 42
有没有办法确定哪些参数是通过关键字从函数内部传递的?
在尝试评估关键字参数的默认值时,有以下选项:
码
选项1 - locals()
def f(a, b=1, c="1"):
print(locals())
f(0)
# {'c': '1', 'b': 1, 'a': 0}
选项2 - 部分类型提示*
def g(a, b:int=1, c:float="1"):
pass
keys = g.__annotations__
values = g.__defaults__
dict(zip(keys, values))
# {'b': 1, 'c': '1'}
选项3 - 完整类型提示*
def h(a:float, b:int=1, c:str="1") -> int:
return 0
keys = reversed(list(filter(lambda x: x != "return", h.__annotations__)))
values = reversed(h.__defaults__)
{k: v for k, v in zip(keys, values) if k != "return"}
# {'c': '1', 'b': 1}
注意:这些选项都不是Pythonic,但它们具有潜力。
细节
locals()
取决于函数调用。结果应该是默认值,但它们会随着传入调用的值而变化,例如f(0)
对阵f(0 2, 3)
"return"
注释是可选的,我们在迭代期间对其进行过滤。*这些选项取决于类型提示和密钥插入顺序保留(Python 3.6+)。它们仅提供默认值,不随函数调用值更改。类型提示现在在Python中是可选的,因此在生产代码中应谨慎使用。
建议
我只会使用后面的方法来调试或快速检查函数的签名。实际上,只给出了关键字参数,可以使用inspect.getargspec()
来捕获kwonlydefaults
dict。
def f(a, *, b=1, c="1"):
pass
spec = inspect.getfullargspec(f)
spec
# FullArgSpec(args=['a'], varargs=None, varkw=None, defaults=None,
# kwonlyargs=['b', 'c'], kwonlydefaults={'b': 1, 'c': '1'},
# annotations={})
spec.kwonlydefaults
# {'b': 1, 'c': '1'}
否则,将一些技术与args
的defaults
和FullArgSpec
属性结合起来:
def get_keywords(func):
"""Return a dict of (reversed) keyword arguments from a function."""
spec = inspect.getfullargspec(func)
keys = reversed(spec.args)
values = reversed(spec.defaults)
return {k: v for k, v in zip(keys, values)}
get_keywords(f)
# {'c': '1', 'b': 1}