Padrão Template Method

Parte da seção Programação Orientada a Objetos do Journey de Python da Coddy. Lição 52 de 64.

O Padrão Template Method define o esqueleto de um algoritmo em uma classe base, permitindo que as subclasses substituam etapas específicas sem alterar a estrutura do algoritmo.

Aqui está uma classe base com um método de modelo:

class DataProcessor:
    def process(self):
        """Método template que define a estrutura do algoritmo"""
        self.read_data()
        self.process_data()
        self.save_data()
    
    def read_data(self):
        print("Reading data...")
    
    def process_data(self):
        raise NotImplementedError("Subclasses must implement this")
    
    def save_data(self):
        print("Saving data...")

O método de modelo process() define as etapas do algoritmo, enquanto process_data() fica para ser implementado pelas subclasses.

Crie classes concretas que implementem o método abstrato:

class CSVProcessor(DataProcessor):
    def process_data(self):
        print("Processing CSV data")

class JSONProcessor(DataProcessor):
    def process_data(self):
        print("Processing JSON data")

Cada classe concreta fornece sua própria implementação da etapa necessária.

Use o método de modelo:

csv_processor = CSVProcessor()
csv_processor.process()

print()  # Linha vazia

json_processor = JSONProcessor()
json_processor.process()

Crie outro exemplo com um modelo de jogo:

class Game:
    def play(self):
        """Método template para jogar um jogo"""
        self.start_game()
        self.play_game()
        self.end_game()
    
    def start_game(self):
        print("Game started!")
    
    def play_game(self):
        raise NotImplementedError("Define the game rules")
    
    def end_game(self):
        print("Game ended!")

class Chess(Game):
    def play_game(self):
        print("Playing chess - thinking strategically...")

class Soccer(Game):
    def play_game(self):
        print("Playing soccer - running and kicking...")

chess = Chess()
chess.play()

Saída:

Reading data...
Processing CSV data
Saving data...

Reading data...
Processing JSON data
Saving data...
Game started!
Playing chess - thinking strategically...
Game ended!

Ponto principal: o Padrão Template Method define uma estrutura de algoritmo comum na classe pai, permitindo que as subclasses personalizem etapas específicas. A classe pai controla o fluxo geral, mas as subclasses fornecem as implementações específicas. Isso garante uma estrutura consistente ao mesmo tempo que permite flexibilidade nas etapas individuais.

Desafio

Médio

Implemente o padrão Template Method em template.py. A classe abstrata Report possui o método template generate(), que sempre executa as mesmas três etapas na mesma ordem: header(), body(), footer().

header() é compartilhado por todos os relatórios e imprime === Report ===.
body() é abstrato: cada subclasse imprime seu próprio conteúdo.
footer() é um hook com um valor padrão, === End ===, que uma subclasse pode sobrescrever.

Em seguida, escreva os dois relatórios concretos:

SalesReport(total) armazena o total em self._total e imprime Total sales: {total} em seu corpo.
InventoryReport(items) armazena a lista em self._items, imprime Item: {item} para cada item em seu corpo e sobrescreve o rodapé para imprimir === {count} items ===.

driver.py está bloqueado: ele cria relatórios e chama generate() neles. Somente as etapas diferem entre as subclasses; a ordem das etapas fica uma única vez na classe-base.

Experimente você mesmo

from template import SalesReport, InventoryReport

# Manipulador de casos de teste (não altere)
test_case = input()

if test_case == "sales_test":
    SalesReport(1500).generate()
elif test_case == "inventory_test":
    InventoryReport(["Laptop", "Mouse"]).generate()
elif test_case == "both_test":
    for report in [SalesReport(200), InventoryReport(["Pen"])]:
        report.generate()