Можете ли вы перечислить аргументы ключевых слов, которые получает функция?

104

У меня есть словарь, в котором мне нужно передать ключи / значения в качестве аргументов ключевого слова .. Например ..

d_args = {'kw1': 'value1', 'kw2': 'value2'}
example(**d_args)

Это работает нормально, но если в d_args dict есть значения, которые не принимаются exampleфункцией, очевидно, что она умирает .. Скажем, если функция-пример определена какdef example(kw2):

Это проблема, поскольку я не контролирую ни генерацию d_args, ни exampleфункцию .. Они оба исходят из внешних модулей и exampleпринимают только некоторые ключевые аргументы из dict ..

В идеале я бы просто сделал

parsed_kwargs = feedparser.parse(the_url)
valid_kwargs = get_valid_kwargs(parsed_kwargs, valid_for = PyRSS2Gen.RSS2)
PyRSS2Gen.RSS2(**valid_kwargs)

Я, вероятно, просто отфильтрую dict из списка допустимых аргументов ключевых слов, но мне было интересно: есть ли способ программно перечислить аргументы ключевых слов, которые принимает конкретная функция?

dbr
источник

Ответы:

150

Немного лучше, чем непосредственно проверять объект кода и определять переменные, - это использовать модуль проверки.

>>> import inspect
>>> def func(a,b,c=42, *args, **kwargs): pass
>>> inspect.getargspec(func)
(['a', 'b', 'c'], 'args', 'kwargs', (42,))

Если вы хотите знать, может ли он быть вызван с определенным набором аргументов, вам нужны аргументы без уже указанного по умолчанию. Их можно получить:

def getRequiredArgs(func):
    args, varargs, varkw, defaults = inspect.getargspec(func)
    if defaults:
        args = args[:-len(defaults)]
    return args   # *args and **kwargs are not required, so ignore them.

Тогда функция, чтобы сказать, чего вам не хватает в вашем конкретном dict:

def missingArgs(func, argdict):
    return set(getRequiredArgs(func)).difference(argdict)

Точно так же, чтобы проверить недопустимые аргументы, используйте:

def invalidArgs(func, argdict):
    args, varargs, varkw, defaults = inspect.getargspec(func)
    if varkw: return set()  # All accepted
    return set(argdict) - set(args)

Итак, полный тест на возможность вызова:

def isCallableWithArgs(func, argdict):
    return not missingArgs(func, argdict) and not invalidArgs(func, argdict)

(Это хорошо только в том, что касается синтаксического анализа аргументов python. Очевидно, что любая проверка времени выполнения на недопустимые значения в kwargs не может быть обнаружена.)

Брайан
источник
Ницца! Я не знал этой функции!
DzinX
1
Учитывая, что метод, использующий объекты кода, более или менее идентичен, есть ли польза от необходимости импортировать еще один модуль ...?
jmetz
@jmets - определенно - практически всегда лучше использовать библиотечный модуль, чем накатывать свой собственный. Кроме того, атрибуты объекта кода являются более внутренними и могут быть изменены (например, обратите внимание, что это перемещено в код в pyhon3). Использование модуля в качестве интерфейса дает вам дополнительную защиту на случай, если некоторые из этих внутренних компонентов когда-либо изменятся. Он также будет делать то, о чем вы, возможно, даже не думали, например, выдает ошибку соответствующего типа для функций, которые вы не можете проверить (например, функции C).
Брайан
13
inspect.getargspec(f)устарело, начиная с Python 3.0; современный метод есть inspect.signature(f).
gerrit
К вашему сведению, если вы хотите поддерживать Cython и Python, этот метод не работает с функцией Cython'd. Этот co_varnamesвариант, с другой стороны, работает в обоих случаях.
partofthething
32

Это напечатает имена всех допустимых аргументов, ключевых и не ключевых:

def func(one, two="value"):
    y = one, two
    return y
print func.func_code.co_varnames[:func.func_code.co_argcount]

Это потому, что сначала co_varnamesвсегда параметры (затем идут локальные переменные, как yв примере выше).

Итак, теперь у вас может быть функция:

def getValidArgs(func, argsDict):
    '''Return dictionary without invalid function arguments.'''
    validArgs = func.func_code.co_varnames[:func.func_code.co_argcount]
    return dict((key, value) for key, value in argsDict.iteritems() 
                if key in validArgs)

Который затем можно было бы использовать так:

>>> func(**getValidArgs(func, args))

EDIT : небольшое дополнение: если вам действительно нужны только ключевые аргументы функции, вы можете использовать func_defaultsатрибут для их извлечения:

def getValidKwargs(func, argsDict):
    validArgs = func.func_code.co_varnames[:func.func_code.co_argcount]
    kwargsLen = len(func.func_defaults) # number of keyword arguments
    validKwargs = validArgs[-kwargsLen:] # because kwargs are last
    return dict((key, value) for key, value in argsDict.iteritems() 
                if key in validKwargs)

Теперь вы можете вызывать свою функцию с известными аргументами, но извлекать kwargs, например:

func(param1, param2, **getValidKwargs(func, kwargsDict))

Это предполагает, что в его подписи funcне используется магия *argsили нет **kwargs.

DzinX
источник
что, если я хочу распечатать только «ключевые слова» аргументы «ключи»?
Цзя
7

В Python 3.0:

>>> import inspect
>>> import fileinput
>>> print(inspect.getfullargspec(fileinput.input))
FullArgSpec(args=['files', 'inplace', 'backup', 'bufsize', 'mode', 'openhook'],
varargs=None, varkw=None, defaults=(None, 0, '', 0, 'r', None), kwonlyargs=[], 
kwdefaults=None, annotations={})
jfs
источник
7

Для решения Python 3 вы можете использовать inspect.signatureи фильтровать в соответствии с типом параметров, о которых вы хотите знать.

Возьмем пример функции с параметрами positional или keyword, keyword-only, var positional и var keyword:

def spam(a, b=1, *args, c=2, **kwargs):
    print(a, b, args, c, kwargs)

Вы можете создать для него объект подписи:

from inspect import signature
sig =  signature(spam)

а затем отфильтруйте с пониманием списка, чтобы узнать нужные детали:

>>> # positional or keyword
>>> [p.name for p in sig.parameters.values() if p.kind == p.POSITIONAL_OR_KEYWORD]
['a', 'b']
>>> # keyword only
>>> [p.name for p in sig.parameters.values() if p.kind == p.KEYWORD_ONLY]
['c']

и, аналогично, для позиционных переменных используется p.VAR_POSITIONALключевое слово var with VAR_KEYWORD.

Кроме того, вы можете добавить предложение в if, чтобы проверить, существует ли значение по умолчанию, проверив, p.defaultравно ли p.empty.

Димитрис Фасаракис Хиллиард
источник
3

Расширение ответа DzinX:

argnames = example.func_code.co_varnames[:func.func_code.co_argcount]
args = dict((key, val) for key,val in d_args.iteritems() if key in argnames)
example(**args)
Клаудиу
источник