Python使用struct模块

一、Struct模块常用函数

struct模块的主要功能是根据一些特定的格式字符串来解析和构建二进制数据。这些格式字符串指定了数据的布局和类型，以及如何将数据打包（pack）到二进制形式或从二进制形式解包（unpack）。

1.常用函数

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

• 根据给定的格式字符串，将提供的值打包为二进制数据。
• 按照给定的格式(fmt)，把数据封装成字符串(实际上是类似于c结构体的字节流)
• 例如，struct.pack(‘i’, 42)将整数42打包为4字节的二进制数据。

unpack(format, buffer)

• 根据给定的格式字符串，从二进制数据中解包出值。
• 按照给定的格式(fmt)解析字节流string，返回解析出来的tuple。
• 例如，struct.unpack(‘i’, buffer)将从4字节的二进制数据中解包出一个整数。

calcsize(format)

• 计算给定格式字符串的大小（以字节为单位），用于确定所需的缓冲区大小。
• 计算给定的格式(fmt)占用多少字节的内存

2.struct 中支持的格式

• 注1：q和Q只在机器支持64位操作时有意思
• 注2：每个格式前可以有一个数字，表示个数
• 注3：s格式表示一定长度的字符串，4s表示长度为4的字符串，但是p表示的是pascal字符串
• 注4：P用来转换一个指针，其长度和机器字长相关

Format	C Type	Python	字节数
x	pad byte	no value	1
c	char	string of length 1	1
b	signed char	integer	1
B	unsigned char	integer	1
?	_Bool	bool	1
h	short	integer	2
H	unsigned short	integer	2
i	int	integer	4
I (大写的 i）	unsigned int	integer or long	4
l (小写的 L)	long	integer	4
L	unsigned long	long	4
q	long long	long	8
Q	unsigned long long	long	8
f	float	float	4
d	double	float	8
s	char[]	string	1
p	char[]	string	1
P	void *	long	8

3.字节对齐

• eg：使用方法是放在fmt的第一个位置，就像 '@5s6sif’

Character	Byte order	Size and alignment
@	native	native 凑够4个字节
=	native	standard 按原字节数
<	little-endian	standard 按原字节数
>	big-endian	standard 按原字节数
!	network (= big-endian)	standard 按原字节数

4.unpack使用示例

比如有一个结构体

struct Header
{
    unsigned short id;
    char[4] tag;
    unsigned int version;
    unsigned int count;
}

通过socket.recv接收到了一个上面的结构体数据，存在字符串s中，现在需要把它解析出来，可以使用 unpack() 函数.

import struct
id, tag, version, count = struct.unpack("!H4s2I", s)

格式字符串：“!H4s2I”

• !表示我们要使用网络字节顺序解析，因为我们的数据是从网络中接收到的，在网络上传送的时候它是网络字节顺序的
• 后面的H表示 一个unsigned short的id,4s表示4字节长的字符串，2I表示有两个unsigned int类型的数据.
• 现在id, tag, version, count里已经保存好我们的信息了

5.pack使用示例

把本地数据再pack成struct格式

ss = struct.pack("!H4s2I", id, tag, version, count);

• pack函数 就把id, tag, version, count按照指定的格式转换成了结构体Header，
• ss现在是一个字符串(实际上是类似于c结构体的字节流)，可以通过 socket.send(ss)把这个字符串发送出去.

二、使用struct模块进行打包和解包的基本用法

import struct

# 打包
packed_data = struct.pack('i', 42)
print(packed_data)  # b'*\x00\x00\x00'

# 解包
unpacked_data = struct.unpack('i', packed_data)
print(unpacked_data)  # (42,)

参考：

• python struct 结构体