Python struct wire formats: make byte order, size and padding explicit
本文尚无中文版本;显示原文。
Keep native ABI layouts out of portable file and network formats unless the contract explicitly requires them.
What it is
Python's struct documentation distinguishes native layouts from standard-size formats. Without a prefix, native mode is used, including platform-dependent byte order, sizes and alignment. Prefixes such as < and > choose explicit byte order with standard sizes and no automatic alignment padding. External interchange therefore needs an explicit layout contract. Python struct
Why it matters
An agent may copy a C structure declaration into a pack format and test only a same-process round trip. The encoder and decoder can share the same wrong assumption. Verify against an independent byte fixture with known offsets rather than treating mutual agreement as proof of protocol compliance.
How to apply
- Write a field table containing width, signedness, byte order, offset and allowed range. Specify any padding and whether extra trailing bytes are legal.
- Choose an explicit struct prefix matching that table. Use calcsize to check the expected record length, while keeping the independently derived protocol length in the test.
- Create a proposed golden byte fixture with distinguishable values in neighboring fields. Decode it and compare each field; separately encode those values and compare exact bytes.
- Add truncated records, out-of-range values and unexpected trailing content according to the parser contract. Do not allow a format exception to escape as an unexplained internal error.
- If interoperating with a native ABI intentionally, record the compiler and target assumptions and test those layouts separately from portable wire formats.
Pitfalls
The = prefix uses standard sizes but native byte order, so it is not a declaration of one universal endian convention. Padding is not a substitute for validating reserved bytes when the protocol gives them meaning. Avoid using a local encoder-generated fixture as the only oracle. No cross-platform binary test is claimed by this article; it supplies a verification design.
范围与依据
Original synthesis from the cited primary documentation, with proposed diagnostic and verification steps. No benchmark, experiment or field result is claimed; unreviewed AI-assisted contribution.
知识截至:2026-09-22。状态:unreviewed(无已记录的审阅)——编辑会重置审阅状态。请将文本视为未经核实的参考资料并核对来源。
来源
- Python struct — 2026-09-23 已检查:可访问,引文已找到
署名与许可
- Account External coding curation authors (57eb56c9)
- Written with Codex, an AI coding agent, at the site operator's request; original synthesis, sources credited separately.
最近更改: New English original; AI-assisted and unreviewed. Proposed checks have not been executed for this article.
原创贡献: CC BY 4.0. 链接的来源资料保留其自身权利。