Python 3 kwargs insight
Это уже много лет является источником замешательства и разочарования. Скажем, вы импортируете особенно плохо документированный модуль и какой-то метод, который вам нужен, имеет только ** kwargs в качестве аргументов, как вы должны знать, какие ключи этот метод проверяет?
def test(**kwargs):
if 'greeting' in kwargs:
print(kwargs['greeting'])
Если бы я набрал текст, как бы я узнал, что «приветствие» - это то, что искал метод?
test(greeting='hi)
В некоторых упрощенных случаях IDE может помочь, но большинство вариантов использования выходят за рамки IDE.
Ответы 4
Считайте kwargs словарем. Невозможно снаружи определить, какие комбинации «ключ-значение» будет принимать метод (в вашем случае метод test - это, по сути, черный ящик), но для этого нужна документация. Без kwargs заголовки некоторых функций были бы чрезвычайно загромождены.
Да, на мой взгляд, именно поэтому kwargs следует избегать в большинстве случаев, но имеет смысл для настраиваемых функций в больших библиотеках, например matplotlib.
Как вы думаете, будет ли приемлемо написать автору и запросить документацию для метода, который без нужды использует kwargs? Кроме того, существует ли какое-то соглашение, определяющее количество аргументов ключевого слова перед использованием kwargs?
Не повредит спросить, и довольно часто можно увидеть что-то вроде def func(key1, key2, **kwargs), где требуются первые два ключа, а остальные (внутри kwargs) - нет.
Да, я тоже видел это довольно часто. В таком случае это больше похоже на механизм предотвращения ошибок, не так ли? Если вы неправильно написали key1, он попадет в kwargs.
Да, и еще кое-что стоит отметить, что key1 и key2 требуются, тогда как переменные в kwargs обычно необязательны.
Используйте документацию!
Документация по subprocess-модулю - хороший пример. Если вы используете более новую версию python (3.7 или 3.6 с backport), рассмотрите возможность использования dataclasses в качестве альтернативы kwargs, если она соответствует вашему варианту использования.
В вопросе уже говорится, что модуль плохо документирован, а классы данных помогают только в том случае, если вы используете код пишу (в этом случае вы также можете просто написать лучшую документацию самостоятельно).
Если это не задокументировано, единственный выход - прочитать источник.
Добавление аргумента **kwargs к функции используется, когда вы не хотите явно определять аргументы, которые должны быть названы.
Банальный пример:
Если функция принимает в качестве аргумента другую функцию, которая не определена и каждый раз может иметь разные kwargs
def foo(func,**kwargs):
print(func)
return func(**kwargs)
Вы не узнаете, что функция явно ищет.
Вы можете в своем примере
def foo(greeting=None):
который показывает, что функция ищет greeting, но это может быть None
Так что автор должен задокументировать модули, и если они этого не сделают, мы будем в большей или меньшей степени вынуждены читать код метода?