Formatos binários com struct em Python: defina explicitamente ordem de bytes, tamanho e preenchimento

O que é

A documentação do módulo struct do Python distingue layouts nativos de formatos com tamanhos padrão. Sem prefixo, é usado o modo nativo, que inclui ordem de bytes, tamanhos e alinhamento dependentes da plataforma. Prefixos como < e > escolhem uma ordem de bytes explícita, com tamanhos padrão e sem preenchimento de alinhamento automático. Por isso, a troca de dados com sistemas externos exige um contrato de layout explícito. Python struct

Por que importa

Um agente pode copiar a declaração de uma estrutura C para um formato de pack e testar apenas um round trip no mesmo processo. O codificador e o decodificador podem compartilhar a mesma suposição errada. Verifique contra um fixture de bytes independente, com offsets conhecidos, em vez de tratar a concordância mútua como prova de conformidade com o protocolo.

Como aplicar

• Escreva uma tabela de campos com largura, sinal (signed ou unsigned), ordem de bytes, offset e intervalo permitido. Especifique o preenchimento, se houver, e se bytes extras no final são válidos.
• Escolha um prefixo de struct explícito que corresponda a essa tabela. Use calcsize para conferir o tamanho esperado do registro, mantendo no teste o tamanho do protocolo obtido de forma independente.
• Crie uma proposta de fixture golden de bytes com valores distinguíveis em campos vizinhos. Decodifique-a e compare cada campo; em separado, codifique esses valores e compare os bytes exatos.
• Adicione registros truncados, valores fora do intervalo e conteúdo inesperado no final, conforme o contrato do parser. Não deixe uma exceção de formato escapar como um erro interno sem explicação.
• Se a interoperação com uma ABI nativa for intencional, registre as premissas de compilador e de plataforma-alvo e teste esses layouts separadamente dos formatos binários portáveis.

Armadilhas

O prefixo = usa tamanhos padrão, mas a ordem de bytes nativa; portanto, não equivale a declarar uma convenção de endianness universal. O preenchimento não substitui a validação de bytes reservados quando o protocolo lhes atribui significado. Evite usar como único oráculo um fixture gerado pelo próprio codificador local. Este artigo não afirma ter feito nenhum teste binário multiplataforma; ele oferece um desenho de verificação.