Padrões de projeto em Python

Padrão de projeto Visitor em Python

Nesta lição, você vai usar o padrão Visitor para adicionar novas operações a um grupo de objetos sem alterar as suas classes.

  • Avançado
  • 3 min de leitura
  • 1 exemplo executável

Introdução

O problema

Você tem um conjunto estável de classes, como formas ou produtos, e vive adicionando operações novas: preço total, imposto, exportar para JSON. Adicionar cada operação como método em todas as classes espalha um recurso por muitos arquivos.

Pense assim

O padrão Visitor é como um fiscal visitando lojas diferentes. Cada loja só deixa o fiscal entrar e diz que tipo de loja é. O fiscal traz as regras para cada tipo de loja, então regras novas significam um fiscal novo, não mudanças em todas as lojas.

Do fiscal para o código
item.accept(visitor)🚪 A loja deixa o fiscal entrar
visitor.visit_book(self)🏷️ Ela diz que tipo de loja é
PriceVisitor🧾 O fiscal com as regras
15💰 O total de um livro e um filme
A operação fica no visitor, não nas classes dos elementos.
Em uma frase

O padrão Visitor tira uma operação de um grupo de classes de elementos e a coloca num objeto visitor separado; cada elemento chama o método do visitor que corresponde ao seu próprio tipo.

Pontos-chave

  1. Book.accept chama visitor.visit_book(self); Movie.accept chama visitor.visit_movie(self).
  2. PriceVisitor guarda as regras de preço dos dois tipos.
  3. sum(item.accept(visitor) for item in [Book(), Movie()]) soma 10 e 5.
  4. Uma operação nova, como imposto, seria uma nova classe visitor sem mudar Book nem Movie.

Quando usar?

  • Muitas operações sobre um conjunto estável de tipos: preços, exportação, desenho.
  • Percorrer estruturas como árvores sintáticas em compiladores.
  • Manter o código de um recurso num só lugar.

Quando não é preciso

  • Tipos de elementos novos aparecem com frequência: aí todo visitor precisa ser atualizado.
  • Código Python em que um dicionário de funções por tipo ou functools.singledispatch é mais simples.

Código de exemplo

Executar código →
main.py
class Book:
    # Visitor: move new operations outside stable element classes.
    def accept(self, visitor): return visitor.visit_book(self)


class Movie:
    def accept(self, visitor): return visitor.visit_movie(self)


class PriceVisitor:
    def visit_book(self, book): return 10
    def visit_movie(self, movie): return 5


# Each element dispatches to the matching visitor method.
visitor = PriceVisitor()
print(sum(item.accept(visitor) for item in [Book(), Movie()]))
Gerar um botão Run para este exemplo

Resultado da execução

15

Explicação do código

Cada elemento tem o método accept(), que chama o método correspondente do visitor: Book chama visit_book() e Movie chama visit_movie(). PriceVisitor concentra toda a lógica de preço, então as classes Book e Movie não precisam saber nada sobre preços. O total é 10 + 5 = 15.

Altere os valores e execute o programa no compilador Python online CodeUtility sem instalar Python.

Exercícios práticos

Tente modificar o código seguindo as sugestões abaixo. Mudar o código e observar o resultado ajuda você a entender muito mais do que só ler.

  1. Substitua o domínio do exemplo preservando a estrutura do padrão.
  2. Compare o padrão com uma implementação mais simples e explique as diferenças.
  3. Escreva testes para cada participante antes de adicionar outra implementação.
Executar no compilador Python →

Erros comuns

Chamar o método errado do visitor

Um elemento precisa chamar o método do seu próprio tipo, senão recebe as regras erradas.

Problema
class Movie:
    def accept(self, visitor): return visitor.visit_book(self)
Correção
class Movie:
    def accept(self, visitor): return visitor.visit_movie(self)

Terminou esta lição?

Marque como aprendida para acompanhar seu progresso.