Python struct 模块解析

什么是 struct 模块

Python struct 模块是用于处理 C 语言的结构体数据的工具。它提供了一种灵活的方式来解决 C 结构体中数据转换、分析和处理问题。在 Python 中，可以使用 struct 模块来解压缩二进制数据，或者将 Python 对象打包到二进制数据中去。

模块结构和函数

struct 模块核心由两个函数：pack() 和 unpack()。pack() 用于将 Python 对象打包转换为二进制数据；而 unpack() 相反，用于将二进制数据解包转换为 Python 对象。

另一个函数 calcsize(format) 用于计算格式字符串的字节数。

通过下面的代码块来看一下上述三个函数的具体使用方法：

import struct

# pack() 函数举例
packed = struct.pack('3s i f', b'foo', 10, 2.5)
print(packed)

# unpack() 函数举例
unpacked = struct.unpack('3s i f', packed)
print(unpacked)

# 计算格式字符串的字节数举例
size = struct.calcsize('3s i f')
print(size)

其中，第一个函数 pack() 的语法格式如下：

struct.pack(fmt, v1, v2, ...)

它接受任意数量的参数来打包。第一个参数 fmt 是格式字符串，表示它们的结构和类型。剩下的参数是要打包的值。该函数返回一个打包后的二进制数据。

另一个函数 unpack() 的语法格式如下：

struct.unpack(fmt, buffer)

它接受 buffer（包含要解包的字节）和格式字符串 fmt，并将其解码为元组。

而 calcsize(format) 函数的作用很简单，就是计算格式字符串 format 需要的字节数。format 字符串中各种指令对应的字节数必须相加才能得到结果，否则就会抛出一个 struct.error 异常。

注意事项

在使用 struct 模块时，必须特别注意其格式字符串的使用方式和字节顺序。在不同的平台上，字节顺序可以是不同的，如果字节顺序不一致，解码过程则可能会出现问题。

例如，在 Intel x86 架构下，整数字节顺序为 LITTLE_ENDIAN，而在 SPARC 和 Motorola 架构下，整数字节顺序为 BIG_ENDIAN。为了避免这种问题，可以使用字符 '<' 或 '>' 作为格式字符串的第一个字符来明确指定字节顺序。

示例

以下是两个示例，一个示例展示了如何编码 IP 包头信息，另一个示例展示了如何用结构体编码和解构 BZZA 包。

示例 1：编码 IP 包头

import struct
import socket

# IP包头编码格式
ip_header_fmt = '!BBHHHBBH4s4s'

#创建IP包头参数列表
ip_header_args = (4 << 4 | 5, 0, 20, 54321, 0, 255, socket.IPPROTO_TCP, 0, socket.inet_aton('192.168.1.1'),
                  socket.inet_aton('192.168.1.2'))

# 打包IP头
ip_header = struct.pack(ip_header_fmt, *ip_header_args)

print(ip_header)

在上述代码中，我们使用了格式字符串的感叹号前缀“!” 来表示网络字节顺序（big-endian）。

示例 2：用结构体编码和解构 BZZA 包

import struct

# 创建结构体格式化字符串
bzza_fmt = '3s B c i f'

# 数据
data = (b'XYZ', 0x20, b'a', 1234, 3.14)

# 打包和解包
packed = struct.pack(bzza_fmt, *data)
print(packed)

unpacked = struct.unpack(bzza_fmt, packed)
print(unpacked)

在上面的代码中，我们使用了一个结构体格式化字符串来表示 bzza 数据结构，其中，'3s' 表示一个 3 字节的字符串，'B' 表示一个字节，'c' 表示一个字符，'i' 表示一个整数，'f' 表示一个浮点数。我们将一个名为 'data' 的元组作为参数传递给 pack() 函数，并使用 '*' 操作符将元组解包为单独的参数（与可变位置参数功能类似）。然后，我们将打包后的数据解包并打印出来。