Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Python

`*args` e `**kwargs`: recolher e encaminhar argumentos

Numa definição, `*args` recolhe argumentos posicionais adicionais e `**kwargs` recolhe argumentos adicionais por nome. Numa chamada, os mesmos asteriscos desempacotam valores.

Versão: Python 3.12

Sintaxe

def wrapper(*args, **kwargs):
    return target(*args, **kwargs)

def dispatch(handler, /, *args, label="items"):
    return handler(*args, label=label)

Numa definição de função em Python 3.12, *args recolhe num tuplo os argumentos posicionais não associados a outros parâmetros, pela ordem em que foram passados. **kwargs recolhe os argumentos por nome restantes num novo dict. Se não houver nada a recolher, recebem () e {}, respetivamente. Os nomes args e kwargs são convencionais: são os asteriscos que determinam o comportamento.

Um parâmetro normal declarado depois de *args, como label, só pode ser passado por nome. Um * isolado indica o início desses parâmetros sem recolher nada. Os parâmetros antes de /, como handler no exemplo, são exclusivamente posicionais. Se existir, **kwargs é o último parâmetro.

Numa chamada como target(*args, **kwargs), a operação é inversa: * desempacota um iterável em argumentos posicionais separados e ** desempacota um mapeamento com chaves do tipo cadeia de caracteres em argumentos por nome. Escrever explicitamente duas vezes o mesmo nome de argumento numa chamada provoca um SyntaxError durante a compilação. Se o desempacotamento com ** introduzir um nome de argumento duplicado, ou se um argumento posicional e um argumento por nome fornecerem ambos um valor para o mesmo parâmetro, a chamada provoca um TypeError em tempo de execução.

A função envolvente wrapper recolhe e encaminha argumentos dos dois tipos. A função de despacho dispatch recolhe apenas argumentos posicionais adicionais, recebe label separadamente e chama handler. Se dispatch não aceitar um argumento por nome, a chamada encaminhada provoca TypeError, mesmo que wrapper o aceite.

Exemplos

def render(*values, label):
    return f"{label}: {values}"


def dispatch(handler, /, *args, label="items"):
    return handler(*args, label=label)


def wrapper(*args, **kwargs):
    return dispatch(render, *args, **kwargs)


print(wrapper(3, 5, label="points"))
print(wrapper())

Resultado

points: (3, 5)
items: ()

Na primeira chamada, `dispatch` associa `label="points"` a `label` e recolhe `3` e `5` em `args`. Na segunda, `wrapper` não tem nada a recolher, pelo que `dispatch` usa o seu valor predefinido `"items"`.

Lições relacionadas

  • Python · Lição 44 · Avançado · Versão: 5

Fontes