Passando um dicionário para uma função como parâmetros de palavra-chave

346

Eu gostaria de chamar uma função em python usando um dicionário.

Aqui está um código:

d = dict(param='test')

def f(param):
    print(param)

f(d)

Isso imprime, {'param': 'test'}mas eu gostaria que fosse impresso test.

Eu gostaria que funcionasse da mesma forma para mais parâmetros:

d = dict(p1=1, p2=2)
def f2(p1, p2):
    print(p1, p2)
f2(d)

Isso é possível?

Dave Hillier
fonte

Respostas:

528

Descobri isso por mim mesmo no final. É simples, estava faltando o operador ** para descompactar o dicionário

Então, meu exemplo se torna:

d = dict(p1=1, p2=2)
def f2(p1,p2):
    print p1, p2
f2(**d)
Dave Hillier
fonte
57
se você iria querer isso para ajudar os outros, você deve reformular a sua pergunta: o problema não estava passando um dicionário, o que você queria era transformar um dicionário em parâmetros de palavra-chave
Javier
11
É importante notar que você também pode listas de descompactar a argumentos posicionais: F2 (* [1,2])
Matthew Trevor
10
"desreferência": o termo usual, neste contexto Python, é "descompactar". :)
mipadi
2
Isso é ótimo, basta usá-lo com argparse / __ dict__ para facilitar a análise de argumentos de linha de comando diretamente nas opções de um objeto de classe.
Horus
11
qual é a razão pela qual queremos descompactar um dicionário ao passá-lo como argumento para uma função?
Mona Jalal 30/05
128
In[1]: def myfunc(a=1, b=2):
In[2]:    print(a, b)

In[3]: mydict = {'a': 100, 'b': 200}

In[4]: myfunc(**mydict)
100 200

Alguns detalhes extras que podem ser úteis para você saber (perguntas que tive depois de ler isso e testá-lo):

  1. A função pode ter parâmetros que não estão incluídos no dicionário
  2. Você não pode substituir um parâmetro que já está no dicionário
  3. O dicionário não pode ter parâmetros que não estão na função.

Exemplos:

Número 1: A função pode ter parâmetros que não estão incluídos no dicionário

In[5]: mydict = {'a': 100}
In[6]: myfunc(**mydict)
100 2

Número 2: você não pode substituir um parâmetro que já está no dicionário

In[7]: mydict = {'a': 100, 'b': 200}
In[8]: myfunc(a=3, **mydict)

TypeError: myfunc() got multiple values for keyword argument 'a'

Número 3: o dicionário não pode ter parâmetros que não estão na função.

In[9]:  mydict = {'a': 100, 'b': 200, 'c': 300}
In[10]: myfunc(**mydict)

TypeError: myfunc() got an unexpected keyword argument 'c'

Conforme solicitado nos comentários, uma solução para o Número 3 é filtrar o dicionário com base nos argumentos de palavra-chave disponíveis na função:

In[11]: import inspect
In[12]: mydict = {'a': 100, 'b': 200, 'c': 300}
In[13]: filtered_mydict = {k: v for k, v in mydict.items() if k in [p.name for p in inspect.signature(myfunc).parameters.values()]}
In[14]: myfunc(**filtered_mydict)
100 200

Outra opção é aceitar (e ignorar) kwargs adicionais em sua função:

In[15]: def myfunc2(a=None, **kwargs):
In[16]:    print(a)

In[17]: mydict = {'a': 100, 'b': 200, 'c': 300}

In[18]: myfunc2(**mydict)
100

Observe além do que você pode usar argumentos posicionais, listas ou tuplas efetivamente da mesma maneira que kwargs, aqui está um exemplo mais avançado que incorpora argumentos posicionais e de palavras-chave:

In[19]: def myfunc3(a, *posargs, b=2, **kwargs):
In[20]:    print(a, b)
In[21]:    print(posargs)
In[22]:    print(kwargs)

In[23]: mylist = [10, 20, 30]
In[24]: mydict = {'b': 200, 'c': 300}

In[25]: myfunc3(*mylist, **mydict)
10 200
(20, 30)
{'c': 300}
David Parks
fonte
4
Usar a descompactação com print.format é particularmente útil. por exemplo:'hello {greeting} {name}'.format( **{'name': 'Andrew', 'greeting': 'Mr'})
Martlark 2/17/17
Pergunta antiga, mas ainda muito relevante. Obrigado pela resposta detalhada. Você conhece alguma maneira de solucionar o caso 3? Significado: mapear pythonicamente os itens do dicionário para os parâmetros de função, quando houver mais itens no dicionário do que parâmetros?
Spencer #
2
@spencer uma solução foi adicionada à resposta.
David Parks
33

Em python, isso é chamado de "descompactar" e você pode encontrar um pouco sobre isso no tutorial . A documentação dele é péssima, eu concordo, especialmente por causa de quão fantasticamente útil é.

llimllib
fonte
20
É melhor copiar o conteúdo relevante do link para a sua resposta, em vez de confiar no link existente até o final do tempo.
Richard
3
@ Richard, essa é uma opinião filosófica profunda sobre a web, com a qual eu não poderia discordar com mais entusiasmo! Infelizmente, me falta o espaço nesta margem aqui para compartilhar minha maravilhosa prova ...
llimllib
@llimllib, terei que perguntar ao Dr. Wiles então!
Richard
6

Aqui está - funciona qualquer outra iterável:

d = {'param' : 'test'}

def f(dictionary):
    for key in dictionary:
        print key

f(d)
Patrick Harrington
fonte
Parece que as pessoas estão votando contra isso, pois ele respondeu à pergunta original, não à pergunta reformulada. Sugiro apenas remover este post agora.
dotancohen
@dotancohen não, nunca foi correto, ele falha no segundo bloco de código que estava sempre com a pergunta. Tomou isso literalmente demais, a impressão era um exemplo.
Dave Hillier 26/02
Porém, ele responde à pergunta, mas não o faz através da descompactação de dicionário. Sua abordagem é perfeitamente válida com base na pergunta postada.
Natecat