A armadilha do padrão mutável

O bug clássico, ao vivo

Este é, talvez, o erro mais famoso de quem passa do básico para o intermediário em Python. A intenção é boa: você quer uma função que receba uma lista, e, se ninguém passar, comece com uma lista vazia. Parece natural escrever lista=[] como padrão. O problema é sutil e cruel: esse [] é avaliado uma única vez, no momento em que a função é definida, e o mesmo objeto vazio passa a ser reaproveitado em toda chamada que não informar a lista. Como listas são mutáveis, o que uma chamada acrescenta fica lá para a próxima.

# Errado: lista mutavel como valor padrao
def adicionar(item, lista=[]):
    lista.append(item)
    return lista

print(adicionar("a"))  # ['a']
print(adicionar("b"))  # ['a', 'b']  <- deveria ser so ['b']!
print(adicionar("c"))  # ['a', 'b', 'c']  <- o lixo se acumula
# A mesma lista e reaproveitada entre chamadas: bug silencioso.

O padrão [] é criado uma vez e compartilhado: cada chamada herda o que a anterior deixou.

Leia a saída com atenção. A segunda chamada deveria devolver apenas a letra b, porque não passamos nenhuma lista. Em vez disso, ela devolve a e b, porque reaproveitou a mesma lista da primeira chamada. Na terceira, o acúmulo continua. O código não deu erro nenhum; ele simplesmente fez algo diferente do que você imaginou. Esse tipo de bug silencioso é o pior, porque passa nos testes rápidos e explode mais tarde, em produção, com dados estranhos que ninguém entende de onde vieram.

Por que isso acontece

A raiz do problema é uma regra do Python que você viu na primeira aula deste módulo: o valor padrão é calculado uma única vez, quando a definição da função é lida, e não a cada chamada. Para um número ou um texto isso não faz diferença, porque eles são imutáveis: ninguém consegue alterar o número 5 ou o texto vazio por dentro. Já uma lista é mutável. O append muda o próprio objeto, e como esse objeto é sempre o mesmo padrão criado lá no começo, a mudança persiste entre chamadas.

A solução: None como sentinela

A correção é simples e vira reflexo com o tempo. Em vez de usar a lista vazia como padrão, use None, que é imutável e serve de sinal de que nada foi passado. Dentro da função, um if verifica: se o argumento é None, crie uma lista nova ali mesmo. Como a criação passa a acontecer a cada chamada, cada uma ganha a sua própria lista, e o vazamento acaba. Esse padrão, chamado de sentinela None, funciona para listas, dicionários, conjuntos e qualquer outro objeto mutável.

# Certo: None como padrao, cria a lista dentro
def adicionar(item, lista=None):
    if lista is None:
        lista = []
    lista.append(item)
    return lista

print(adicionar("a"))  # ['a']
print(adicionar("b"))  # ['b']  <- isolado, como esperado
print(adicionar("c"))  # ['c']  <- cada chamada tem sua lista

Com None e o if, cada chamada cria a própria lista. O bug desaparece.

Compare as duas saídas lado a lado: agora cada chamada devolve só o seu item, sem herdar nada da anterior. A diferença é uma linha, o if lista is None, mas ela muda tudo. Use is None, com o operador is, e não == None: é a forma idiomática de comparar com None em Python. Guardando esse padrãozinho, você atravessa toda a carreira sem cair na armadilha mais clássica da linguagem, aquela que quase todo programador Python já encontrou pelo menos uma vez.