Conteúdo do curso Lição 68 de 148 · APIs que ninguém pode usar de forma errada
APIs que ninguém pode usar de forma errada

Torne os estados explícitos

Por que isso importa Objetos com um ciclo de vida (conexões, arquivos, transações, pagamentos) são onde o "funcionou na minha máquina" vive. Uma chamada na ordem errada deve falhar ali mesmo, não corromper algo depois.

Você está criando um wrapper para um transporte de rede para o resto da equipe. O transporte em si é de baixo nível: connect(), write(data), disconnect(), e ele faz o que lhe é mandado. Um postmortem do último trimestre encontrou um trabalho que enviou dados após o fechamento e se reconectou silenciosamente ao servidor errado. Seu wrapper deve tornar isso impossível.

Máquina de estados: um pequeno conjunto de estados (new, open, closed) e as chamadas permitidas em cada um. Qualquer outra coisa é recusada.

c = Connection(transport)
c.open()
c.send(b"hello")
c.close()

with Connection(transport) as c:   # opens, and always closes
    c.send(b"hello")
Sua vez

Escreva class Connection com suporte a __init__(self, transport), open(), send(data), close() e with (abrir na entrada, fechar na saída mesmo se o bloco lançar erro). Eles chamam o connect(), write(data) e disconnect() do transport.

Scripts de uso indevido ocultos tentarão cada um destes. Cada um deve gerar erro na chamada errada, antes que qualquer coisa chegue ao transporte:

  • RuntimeError (ou uma subclasse): enviar ou fechar antes de abrir; abrir duas vezes; enviar, fechar ou abrir novamente após fechar (uma conexão fechada terminou; faça uma nova); enviar após um bloco with;
  • TypeError: envie qualquer coisa que não seja bytes-like (bytes ou bytearray). Não codifique strings para o chamador.

Viu um problema nesta lição? Reporte-o · Pergunte sobre esta lição

Este exercício abre em breve

Termine a lição anterior para que esta seja desbloqueada. O curso inteiro é gratuito, não precisa de conta, e você pode ler esta lição agora mesmo.