ustruct - 打包和解压原始数据类型

ustruct模块实现相应CPython模块的子集。更多信息请参阅CPython文档：struct

格式字符串

格式字符串是用来在打包和解包数据时指定预期布局的机制。 其使用指定被打包/解包数据类型的格式字符进行构建。 此外，还有一些特殊字符用来控制字节顺序，大小和对齐方式。

字节顺序，大小和对齐方式

默认情况下，C类型以机器的本机格式和字节顺序表示，并在必要时通过跳过填充字节来正确对齐（根据C编译器使用的规则）。根据下表，格式字符串的第一个字符可用于指示打包数据的字节顺序，大小和对齐方式：

如果第一个字符不是其中之一，则假定为 '@' 。

格式化字符表

ustruct方法

ustruct.calcsize

ustruct.calcsize(fmt)

返回存放 fmt 需要的字节数。

参数描述：

• fmt - 格式字符的类型，详情见上文格化式字符表

示例：

>>> import ustruct
>>> ustruct.calcsize('i')
4
>>> ustruct.calcsize('f')
4
>>> ustruct.calcsize('d')
8

ustruct.pack

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

按照格式字符串 fmt 压缩参数v1、 v2、…。

参数描述：

• fmt - 格式字符的类型，详情见上文格化式字符表
• v1, v2, ... - 是需要进行数据转换的变量名或值

返回值描述：

• 返回参数编码后的字节对象。

示例：

>>> import ustruct

>>> ustruct.pack('ii', 7, 9)  # 打包两个整数
b'\x07\x00\x00\x00\t\x00\x00\x00'

ustruct.unpack

ustruct.unpack(fmt, data)

根据格式化字符串 fmt 对数据进行解压，返回值为一个元组。

参数描述：

• fmt - 格式字符的类型，详情见上文格化式字符表
• data - 要进行解压的数据

返回值描述：

• 返回包含解压值的元组(即使只包含一个项)。

示例：

>>> import ustruct

>>> ustruct.unpack('ii', b'\x07\x00\x00\x00\t\x00\x00\x00')  # 解压之前打包的两个整数
(7, 9)

ustruct.pack_into

ustruct.pack_into(fmt, buffer, offset, v1, v2, ...)

根据格式字符串fmt将值v1、v2、 …打包到从offset开始的缓冲区中。从缓冲区的末尾算起，offset可能为负。

参数描述：

• fmt - 格式字符的类型，详情见上文格化式字符表
• buffer - 可写数据缓冲区
• offset - 写入的起始位置
• v1, v2, ... - 需要写入缓冲区的数据

示例：

>>> import ustruct

# 定义格式字符串
>>> fmt = "3sB"
# 定义一个字符串和一个整数
>>> name = "Tom"
>>> age = 25

# 将两个值按指定格式打包，并写入bytes类型的空缓冲区中
>>> buf = bytearray(8) # 创建容量为8字节的缓冲区
>>> ustruct.pack_into(fmt, buf, 0, name.encode(), age) # 将"name"编码成bytes类型并写入三个字符(占3个字节)，后面紧跟着一个占1个字节的整数"age"

>>>  print(buf) # 输出：bytearray(b'Tom\x19\x00\x00\x00')
bytearray(b'Tom\x19\x00\x00\x00\x00')

ustruct.unpack_from

ustruct.unpack_from(fmt, data, offset=0)

根据格式化字符串 fmt 解析从 offest 开始的数据解压，从缓冲区末尾开始计数的偏移量可能为负值。

参数描述：

• fmt - 格式字符的类型，详情见上文格化式字符表
• data - 数据缓冲区(缓冲区大小以字节为单位)
• offset - (可选)解压的起始位置，默认为零

返回值描述：

• 返回解压值的元组(即使只包含一个项)。

示例：

>>> import ustruct

# 定义格式字符串
>>> fmt = "3sB"
# 定义要解包的字节序列
>>> data = bytearray(b'Tom\x19\x00\x00\x00\x00')

# 从字节序列的第一个字节开始解包
>>> result = ustruct.unpack_from(fmt, data, 0)
>>> print(result) # 输出：(b'Tom', 25)
(b'Tom', 25)