python struct 模块

官方文档：https://docs.python.org/3.7/library/struct.html?highlight=struct#module-struct

该模块执行 Python 值和表示为 Python对象的 C struct 之间的转换。bytes可用于处理存储在文件中或来自网络连接以及其他来源的二进制数据。它使用 格式字符串作为 C 结构布局的紧凑描述以及与 Python 值的预期转换。

默认情况下，打包给定 C 结构的结果包括填充字节，以保持所涉及的 C 类型的正确对齐；同样，开箱时也会考虑对齐。选择此行为是为了使打包结构的字节与相应 C 结构的内存布局完全对应。要处理与平台无关的数据格式或省略隐式填充字节，请使用standard大小和对齐而不是 native大小和对齐。

struct 模块的用途：

1、按照指定格式将 Python 数据转换为字符串，该字符串为字节流，如：网络传输时不能传输int，此时先将int转化为字节流，然后再发送。 2、按照指定格式将字节流转换为 Python 指定的数据类型。 3、处理二进制数据，如果用 struct 来处理图片文件的话，需要使用 ‘rb’/‘wb’ 以二进制(字节流)读写的方式来处理文件。 4、处理 c 语言中的结构体。

1.函数和异常

该模块定义了以下异常和函数：

• exception

exception struct.error

在各种场合提出异常；参数是一个描述错误的字符串。

• pack

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

返回一个字节对象，其中包含根据格式字符串格式打包的值 v1、v2 、 ...。参数必须与格式要求的值完全匹配。

• pack_into

struct.pack_into(format, buffer, offset, v1, v2, ...)

根据格式字符串格式打包值 v1，v2 ，...... ，并将打包的字节写入从位置 offset 开始的可写缓冲区。注意，偏移量是必需的参数。

• unpack

struct.unpack(format, buffer)

根据格式字符串 format 从缓冲区中解包 。结果是一个元组，即使它只包含一个项目。缓冲区的字节大小必须与格式所需的大小相匹配。

• unpack_from

struct.unpack_from(format, buffer, offset=0)

根据格式字符串，从位置偏移开始的缓冲区解包。结果是一个元组，即使它只包含一个项目。缓冲区的大小（以字节为单位）减去 offset 后，必须至少是格式所需的大小。

• iter_unpack

struct.iter_unpack(format, buffer)

根据格式字符串 format从缓冲区中迭代解包。这个函数返回一个迭代器，它将从缓冲区中读取相同大小的块，直到它的所有内容都被消耗完。缓冲区的字节大小必须是格式所需大小的倍数。每次迭代都会产生一个由格式字符串指定的元组。

• calcsize

struct.calcsize(format)

返回与格式字符串 format 对应的结构体（以及由此产生的字节对象 ）的大小。

2.格式化字符串

格式字符串是用于在打包和解包数据时指定预期布局的机制。它们是通过格式字符构建的，它指定了被打包/解包的数据类型。此外，还有用于控制字节顺序、大小和对齐的特殊字符。

2.1 字节顺序、大小和对齐

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

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

本机字节顺序是大端或小端，具体取决于主机系统。例如：

• Intel x86 和 AMD64 (x86-64) 是 little-endian；
• 摩托罗拉 68000 和 PowerPC G5 是大端；
• ARM 和 Intel Itanium 具有可切换的字节序（双字节序）。

可以使用sys.byteorder检查系统的字节顺序。

本机大小和对齐方式是使用 C 编译器的 sizeof 表达式确定的。这总是与本机字节顺序相结合。

标准大小仅取决于格式字符；

'@'和'='之间的区别：两者都使用本机字节顺序，但后者的大小和对齐方式是标准化的。

'!'适用于那些声称他们不记得网络字节顺序是大端还是小端的人。

无法指示非本机字节顺序（强制字节交换）；使用适当的 < 或 > 。

注意：

1. 填充仅在连续的结构成员之间自动添加。在编码结构的开头或结尾处不添加任何填充。
2. 使用非原生大小和对齐方式时不添加填充，例如使用“<”、“>”、“=”和“！”。
3. 要将结构的结尾与特定类型的对齐要求对齐，请以该类型的代码结束格式，并且重复计数为零。

2.2格式字符串

格式字符具有以下含义；考虑到它们的类型，C 和 Python 值之间的转换应该是显而易见的。“标准大小”列是指使用标准大小时打包值的大小（以字节为单位）；也就是说，当格式字符串以 '<', '>', '!' 或 '=' 中的一个开头时。

格式字符前面可以有一个整数重复计数。例如，格式字符串'4h'的含义与'hhhh'。

格式之间的空白字符被忽略；计数及其格式不能包含空格。

对于's'格式字符，计数被解释为字节的长度，而不是像其他格式字符那样的重复计数；例如， '10s'表示单个 10 字节字符串，而'10c'表示 10 个字符。如果未给出计数，则默认为 1。对于打包，字符串将被截断或用空字节填充以使其适合。对于解包，生成的字节对象始终具有完全指定的字节数。作为一种特殊情况，'0s'表示单个空字符串（同时 '0c'表示 0 个字符）。

x当使用其中一种整数格式（'b', 'B', 'h', 'H', 'i', 'I', 'l', 'L', 'q', 'Q'）打包值时，如果x超出该格式的有效范围，则引发 struct.error。

格式字符对'p'“Pascal 字符串”进行编码，这意味着存储在固定字节数中的短可变长度字符串，由计数给出。存储的第一个字节是字符串的长度，或 255，以较小者为准。字符串的字节如下：如果传入的字符串pack()太长（长于 count 减 1），则只 count-1 存储字符串的前导字节。如果字符串短于 count-1，则用空字节填充它，以便使用精确计数的字节。请注意，对于unpack()，'p'格式字符会消耗 count字节，但返回的字符串不能包含超过 255 个字节。

对于'?'格式字符，返回值为True或 False。打包时使用参数对象的真值。本机或标准布尔表示中的 0 或 1 将被打包，并且任何非零值将 在解包时为 True。

3.示例

所有示例都假定本机字节顺序、大小和与大端机器对齐。

打包/解包三个整数的基本示例：

>>> from struct import *
>>> pack('hhl', 1, 2, 3)
b'\x00\x01\x00\x02\x00\x00\x00\x03'
>>> unpack('hhl', b'\x00\x01\x00\x02\x00\x00\x00\x03')
(1, 2, 3)
>>> calcsize('hhl')
8

解压的字段可以通过将它们分配给变量或将结果包装在命名元组中来命名：

>>> record = b'raymond   \x32\x12\x08\x01\x08'
>>> name, serialnum, school, gradelevel = unpack('<10sHHb', record)

>>> from collections import namedtuple
>>> Student = namedtuple('Student', 'name serialnum school gradelevel')
>>> Student._make(unpack('<10sHHb', record))
Student(name=b'raymond   ', serialnum=4658, school=264, gradelevel=8)

格式字符的顺序可能会影响大小，因为满足对齐要求所需的填充是不同的：

>>> pack('ci', b'*', 0x12131415)
b'*\x00\x00\x00\x12\x13\x14\x15'
>>> pack('ic', 0x12131415, b'*')
b'\x12\x13\x14\x15*'
>>> calcsize('ci')
8
>>> calcsize('ic')
5

以下格式'llh0l'在末尾指定两个填充字节，假设 long 在 4 字节边界上对齐：

>>> pack('llh0l', 1, 2, 3)
b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00'

4.类 Struct

该模块还定义了以下类型：

class struct.Struct(format)

返回一个新的 Struct 对象，该对象根据格式字符串 format 写入和读取二进制数据。一次创建一个 Struct 对象并调用它的方法比调用 struct 具有相同格式的函数更有效，因为格式字符串只需要编译一次。

编译后的Struct对象支持以下方法和属性：

• pack

pack(v1, v2, ...)

与函数 pack() 相同，使用编译格式。

• pack_into

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

与函数 pack_into() 相同，使用编译格式 。

• unpack

unpack(buffer)

与函数 unpack() 相同，使用编译格式。

• unpack_from

unpack_from(buffer, offset=0)

与函数 unpack_from() 相同，使用编译格式。

• iter_unpack

iter_unpack(buffer)

与函数 iter_unpack() 相同，使用编译格式。

• format

format

用于构造此 Struct 对象的格式字符串。

• size

size

对应于 format 的结构体（以及由此 pack() 方法产生的字节对象）的大小。