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

CKTIS / Python

Parâmetros posicionais variádicos: `*args`

Na definição de uma função, `*args` recolhe os argumentos posicionais excedentes num tuplo. Numa chamada, `*` desempacota um iterável em argumentos posicionais.

Versão: Python 3.12

Sintaxe

def f(required, *args, option=False):
    ...

Em Python 3.12, na definição def f(required, *args, option=False):, *args recolhe, pela ordem em que foram passados, os argumentos posicionais que não foram associados aos parâmetros anteriores. No corpo da função, args é um tuplo, ou () se não houver excedentes.

O nome args é convencional; o prefixo * indica que o parâmetro recolhe argumentos posicionais. Como option vem depois de *args, só pode ser passado por nome, por exemplo com option=True. Um * isolado também introduz parâmetros que só podem ser passados por nome, mas não recolhe argumentos posicionais.

Numa definição, um só asterisco recolhe argumentos posicionais; numa chamada como func(*args, **kwargs), desempacota um iterável em argumentos posicionais. A função envolvente usa um mecanismo distinto para encaminhar argumentos nomeados: na definição, **kwargs recolhe num dicionário os argumentos nomeados não associados; na chamada, ** desempacota um mapeamento com chaves do tipo cadeia de caracteres em argumentos nomeados. A assinatura da função de destino continua a aplicar-se: a falta de um argumento obrigatório ou a passagem de dois valores para o mesmo parâmetro provoca um TypeError.

Uma função envolvente de auditoria pode contar os argumentos, encaminhá-los sem alterações e devolver o resultado da função de destino. functools.wraps preserva metadados como o nome da função original. Evita registar os valores dos argumentos tal como foram recebidos em registos de auditoria reais: podem conter palavras-passe ou outros dados sensíveis.

Exemplos

from functools import wraps


def audit(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print(f"audit: positional={len(args)}, keyword={len(kwargs)}")
        return func(*args, **kwargs)

    return wrapper


@audit
def total(base=0, *increments, scale=1):
    return (base + sum(increments)) * scale


print(total(10, 2, 3, scale=2))
print(total())

Resultado

audit: positional=3, keyword=1
30
audit: positional=0, keyword=0
0

Na primeira chamada, a função envolvente conta três argumentos posicionais e um nomeado. Após o encaminhamento, `total` associa `10` a `base`, `(2, 3)` a `increments` e `2` a `scale`, devolvendo `30`. A segunda chamada mostra ambas as coleções vazias (`()` e `{}`); os valores predefinidos dão `0`.

Lições relacionadas

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

Fontes