在python中获取方法参数名称
鉴于python函数:
def aMethod(arg1, arg2): pass
我怎样才能提取参数的数量和名称。 IE浏览器。 考虑到我有一个函数的引用,我想func。[something]返回(“arg1”,“arg2”)
这种使用场景是我有一个装饰器,我希望使用方法参数的顺序,他们出现的实际function作为一个关键。 IE浏览器。 当我调用aMethod(“a”,“b”)时,装饰器将如何显示“a,b”
看看检查模块 – 这将为您检查各种代码对象属性。
>>> inspect.getargspec(aMethod) (['arg1', 'arg2'], None, None, None)
其他结果是* args和** kwargsvariables的名称,以及提供的默认值。 即。
>>> def foo(a,b,c=4, *arglist, **keywords): pass >>> inspect.getargspec(foo) (['a', 'b', 'c'], 'arglist', 'keywords', (4,))
在CPython中,参数的数量是
aMethod.func_code.co_argcount
他们的名字是在一开始
aMethod.func_code.co_varnames
这些是CPython的实现细节,所以这可能不适用于Python的其他实现,比如IronPython和Jython。
允许“传递”参数的一种可移植的方式是用签名func(*args, **kwargs)
来定义你的函数。 这在matplotlib中使用了很多,其中外部API层将大量关键字parameter passing给较低级别的API。
在装饰器方法中,可以用这种方法列出原始方法的参数:
import inspect, itertools def my_decorator(): def decorator(f): def wrapper(*args, **kwargs): # if you want arguments names as a list: args_name = inspect.getargspec(f)[0] print(args_name) # if you want names and values as a dictionary: args_dict = dict(itertools.izip(args_name, args)) print(args_dict) # if you want values as a list: args_values = args_dict.values() print(args_values)
如果**kwargs
对你来说很重要,那么它会有点复杂:
def wrapper(*args, **kwargs): args_name = list(OrderedDict.fromkeys(inspect.getargspec(f)[0] + kwargs.keys())) args_dict = OrderedDict(list(itertools.izip(args_name, args)) + list(kwargs.iteritems())) args_values = args_dict.values()
例:
@my_decorator() def my_function(x, y, z=3): pass my_function(1, y=2, z=3, w=0) # prints: # ['x', 'y', 'z', 'w'] # {'y': 2, 'x': 1, 'z': 3, 'w': 0} # [1, 2, 3, 0]
这里是我认为将使用装饰器为你想要的东西。
class LogWrappedFunction(object): def __init__(self, function): self.function = function def logAndCall(self, *arguments, **namedArguments): print "Calling %s with arguments %s and named arguments %s" %\ (self.function.func_name, arguments, namedArguments) self.function.__call__(*arguments, **namedArguments) def logwrap(function): return LogWrappedFunction(function).logAndCall @logwrap def doSomething(spam, eggs, foo, bar): print "Doing something totally awesome with %s and %s." % (spam, eggs) doSomething("beans","rice", foo="wiggity", bar="wack")
运行它,它会产生以下输出:
C:\scripts>python decoratorExample.py Calling doSomething with arguments ('beans', 'rice') and named arguments {'foo': 'wiggity', 'bar': 'wack'} Doing something totally awesome with beans and rice.
我想你要找的是当地人的方法 –
In [6]: def test(a, b):print locals() ...: In [7]: test(1,2) {'a': 1, 'b': 2}
由于答案是有点老,不得不做一些修改,使其适用于Python3,我添加我的版本:
def _get_args_dict(fn, args, kwargs): args_names = fn.__code__.co_varnames[:fn.__code__.co_argcount] return {**dict(zip(args_names, args)), **kwargs}
该方法返回一个包含args和kwargs的字典。
返回参数名称列表,负责部分和常规函数:
def get_func_args(f): if hasattr(f, 'args'): return f.args else: return list(inspect.signature(f).parameters)
Python 3.5+
DeprecationWarning:inspect.getargspec()已弃用,请改用inspect.signature()
所以之前:
func_args = inspect.getargspec(function).args
现在:
func_args = list(inspect.signature(function).parameters.keys())
去testing:
'arg' in list(inspect.signature(function).parameters.keys())
鉴于我们有函数“函数”,它需要参数“arg”,这将评估为True,否则为False。
来自python控制台的例子:
Python 3.6.0 (v3.6.0:41df79263a11, Dec 23 2016, 07:18:10) [MSC v.1900 32 bit (Intel)] on win32 >>> import inspect >>> 'iterable' in list(inspect.signature(sum).parameters.keys()) True
在具有Signature
对象的python 3. +中,使用Signature的bind()
方法获得args名称与值之间的映射是一种简单的方法!
例如这里是一个打印地图的装饰器:
import inspect def decorator(f): def wrapper(*args, **kwargs): bound_args = inspect.signature(f).bind(*args, **kwargs) bound_args.apply_defaults() print(dict(bound_args.arguments)) return f(*args, **kwargs) return wrapper @decorator def foo(x, y, param_with_default="bars", **kwargs): pass foo(1, 2, extra="baz") # This wil print: {'kwargs': {'extra': 'baz'}, 'param_with_default': 'bars', 'y': 2, 'x': 1}
那么dir()
和vars()
现在呢?
似乎正在做什么被超级简单地问…
(从函数/方法里面)
更新Brian的答案。 如果Python 3中的函数只有关键字参数,则需要使用inspect.getfullargspec
:
def yay(a, b=10, *, c=20, d=30): pass inspect.getfullargspec(yay)
产生这个:
FullArgSpec(args=['a', 'b'], varargs=None, varkw=None, defaults=(10,), kwonlyargs=['c', 'd'], kwonlydefaults={'c': 20, 'd': 30}, annotations={})