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

Question

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

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

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

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

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

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

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

Answer 1

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

>>> 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.

Тогда функция для определения того, чего вам не хватает в вашем конкретном слове:

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, очевидно, не может быть обнаружена.)

Answer 2

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

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))

---

РЕДАКТИРОВАТЬ : Небольшое дополнение: если вам действительно нужны только ключевые аргументы функции, вы можете использовать атрибут 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, например ::101023

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

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

Answer 3

В 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={})

Answer 4

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

Взятие образца функции с позиционными параметрами или ключевыми словами, ключевыми словами, переменными позиционными и переменными ключевыми словами.

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 с VAR_KEYWORD.

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

Answer 5

Расширение ответа 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)