Distinguir atributos de instância e de classe

Um atributo definido diretamente no corpo da classe pertence à classe. Ele é adequado quando o valor representa uma característica intencionalmente comum ao tipo.

Já os atributos definidos com self pertencem a cada instância. Eles representam o estado individual de cada objeto.

Nesta modelagem, todos os cadernos têm o formato A4, mas cada objeto mantém seu próprio título.

Em Caderno, formato foi declarado na classe porque representa uma característica comum a todos os cadernos desse tipo. titulo foi associado a self porque descreve cada caderno individualmente.

A decisão deve seguir o significado do dado, não apenas os valores encontrados agora.

O elemento superior representa a classe e sua característica comum. Os dois elementos inferiores representam instâncias distintas, cada uma com seu próprio título.

Ao consultar objeto.atributo, Python procura primeiro esse nome na própria instância. Se não o encontrar, procura na classe.

No exemplo, cada caderno possui seu próprio titulo. Já formato está na classe e pode ser consultado por qualquer instância.

Observe onde cada valor está armazenado.

Ao usar Caderno.formato, a consulta começa na própria classe e encontra "A5".

Já Caderno.titulo não procura o título de azul, de verde nem de qualquer outra instância. Como titulo não foi definido na classe, essa consulta causa AttributeError.

Nas classes simples deste tutorial, atribuir por objeto.atributo cria ou atualiza esse atributo somente naquela instância. Se a classe já tiver um atributo com o mesmo nome, o valor individual passa a ocultá-lo nas consultas feitas por esse objeto.

A mesma regra vale para uma atribuição como self.atributo = valor dentro de um método: self indica a instância que recebe o atributo.

A atribuição em caderno_1 não modifica a classe nem acrescenta o atributo a caderno_2.

Agora considere uma atribuição posterior: Caderno.formato = "Carta". Ela altera o atributo da classe.

caderno_1 continua mostrando "A4", pois já possui um atributo individual chamado formato. Já caderno_2, que não possui esse atributo próprio, passa a encontrar "Carta" na classe — mesmo tendo sido criado antes da alteração.

O diagrama acompanha o estado final: a classe guarda "Carta"; o primeiro objeto guarda seu próprio "A4"; o segundo não guarda um formato individual e continua consultando a classe.

Considere a sequência completa: primeiro caderno_1.formato = "A4"; depois Caderno.formato = "Carta". Complete o resultado de cada consulta.

Quando uma lista ou um dicionário é definido no corpo da classe, várias instâncias podem encontrar o mesmo objeto mutável. Se uma delas modificar essa coleção, a mudança também será observada pela outra.

Isso é acidental quando os dados deveriam representar o estado individual de cada objeto.

As duas instâncias encontram as mesmas coleções definidas em Caderno.

Nos dois casos, os caminhos iniciados pelas instâncias chegam às coleções armazenadas na classe.

caderno_a.notas.append(8.5) modifica a lista já encontrada. Isso não cria automaticamente um atributo notas em caderno_a.

Da mesma forma, caderno_a.marcadores["cor"] = "azul" modifica o dicionário encontrado. A atribuição acontece em uma chave do dicionário, não no atributo da instância.

Já caderno_a.notas = [...] e caderno_a.marcadores = {...} reatribuem os atributos em caderno_a. As novas coleções ocultam as coleções de mesmo nome existentes na classe.

Compare o que cada objeto consulta depois das operações.

Notas e marcadores representam o estado de um caderno específico. Por isso, devem ser atribuídos a self dentro de __init__.

Cada chamada de Caderno(...) executa __init__ novamente. Assim, os literais [] e {} criam novas coleções para aquela instância.

Somente formato, que é comum a todos os cadernos, permanece na classe.

Ao criar dois cadernos, cada execução de __init__ produz uma lista e um dicionário novos. Alterar as coleções de estudos não modifica as coleções de viagem.

Execute este trecho depois da definição corrigida da classe.

Este código parece mover os dados para a instância, mas reutiliza as coleções existentes.

O script abaixo define duas coleções na classe, embora elas representem dados individuais de cada caderno. Primeiro, preveja as três linhas de saída. Depois, copie o código para um arquivo no seu computador e execute-o com Python 3 para conferir.

Salve, por exemplo, como cadernos.py e execute com Python 3.

Mantenha formato na classe, pois ele representa um valor comum ao tipo. Mova notas e marcadores para init: os literais [] e {} serão avaliados novamente a cada inicialização, criando coleções diferentes para cada instância. Execute esta versão no seu computador.

Este script é completo e pode substituir a versão anterior.

O diagrama contrasta as coleções independentes com o formato compartilhado. A instância estudos também possui um formato próprio, que oculta o valor da classe somente para ela.