struct.pack の fmt ドキュメント

16進数のプロトコルを扱うコードを書くとき、Python では struct.pack を必ずと言っていいほど使う。書き方はいろいろあるのに、全然覚えられない。たとえば

struct.pack('>H', checksum)
data = struct.pack('>I', id) 

1. バイトオーダーとアライメント（先頭文字）

フォーマット文字列の最初の文字は、通常バイトオーダーとアライメントを表す：

2. データ型とサイズ

3. 特殊記号

4. よく使う組み合わせの例

1. ビッグエンディアンの4バイト符号なし整数 + 倍精度浮動小数点数をパックする：

   Pythonコピー

   data = struct.pack('>Id', 0x1234, 3.14)
   

2. パディング付きのリトルエンディアン構造体をパックする（例: int + char、4バイトアライメント）：

   Pythonコピー

   data = struct.pack('<ic', 42, b'A')  # 自动填充 1 字节
   

3. 固定長の文字列をパックする：

   Pythonコピー

   data = struct.pack('10s', b'hello')  # 补零到 10 字节
   

4. ブール値 + 符号なし短整数をパックする（ネットワークバイトオーダー）：

   Pythonコピー

   data = struct.pack('!?H', True, 0xABCD)
   

5. 注意点

1. 数値範囲の検証：

   • たとえば B（0〜255）や I（0〜0xFFFFFFFF）は、範囲を超えるとエラーになる。

   • パックする前に数値の範囲をチェックすることをおすすめします：

     Pythonコピー

     if not (0 <= value <= 0xFFFF):
         raise ValueError("数值超出范围")
     

2. プラットフォームによる違い：

   • l と L は32ビットシステムでは4バイト、64ビットシステムでは8バイトになることがある。
   • 確実に4バイトにしたい場合は i または I を使う。

3. 文字列の扱い：

   • s フォーマットでは長さを明示する必要がある（例: 10s）。

   • 長さが動的に変わる文字列が必要な場合は、len() と組み合わせて使う：

     Pythonコピー

     s = b'hello'
     data = struct.pack(f'I{len(s)}s', len(s), s)