Python中struct 模块的使用教程

Posted 2023-04-12 Python学习

1.struct 简单介绍

struct 是 Python 的内置模块, 在使用 socket 通信的时候, 大多数据的传输都是以二进制流的形式的存在, 而 struct 模块就提供了一种机制, 该机制可以将某些特定的结构体类型打包成二进制流的字符串然后再网络传输，而接收端也应该可以通过某种机制进行解包还原出原始的结构体数据

2.struct 的使用

struct 模块可以将任意大小的数字转换成一个固定长度(可选择)的 bytes, 这个原理类似于前面章节讲过的 hash 算法, 不论内容多大, 最终的 hash 值长度不变, 不同的是 hash 算法是不可逆的, 而且传入的原材料可以是文本、字符串等许多数据类型, struct 可以反解出原来的数据

ps : struct 模块只能转换数字, 不能转换其他的数据类型

3.基本使用 pack 和 unpack

正确使用示例 (打包字节长度对应表请往下看)

import struct

res = struct.pack("i",1234566)  # 传入的必须是 int 类型
print(res)          # b\'\\x86\\xd6\\x12\\x00\'  (查看内容)
print(type(res))    # <class \'bytes\'>      (查看类型)

res2 = struct.unpack("i",res)   # 使用什么 Format 打包就用什么解包
print(res2)         # (1234566,)           (是个元组)
print(type(res2))   # <class \'tuple\'>      (查看类型)
print(res2[0])      # 1234566         

传入非 int 类型引发的错误示例

import struct

res = struct.pack("i","1231")
# 抛出异常 : struct.error: required argument is not an integer (参数必须是整数)

解包时使用的 Format 不一致错误示例

import struct

res = struct.pack("i",123)

res2 = struct.unpack("q",res)
# struct.error: unpack requires a buffer of 8 bytes

传入多个值

res = struct.pack("hiq",12,23,451312)  # 传入多个值, 并使用不同的 Fromat
print(res)  # b\'\\x0c\\x00\\x00\\x00\\x17\\x00\\x00\\x00\\xf0\\xe2\\x06\\x00\\x00\\x00\\x00\\x00\'
print(type(res))  # <class \'bytes\'>

a,b,c = struct.unpack("hiq",res)  # 使用解压赋值，有几个值就需要有几个 Fromat
print(a,b,c)                      # 12 23 451312

Fromat 与值不一致错误示例

with open("aaa.txt","wb")as f:
    for i in range(5):
        res = struct.pack("i",i)
        f.write(res)
        
with open("aaa.txt","rb")as f:
    res = f.read()
    print(res)
    a,b,c,d,e= struct.unpack("i",res)  # 打包的时候是 5 个值, 解包的时候也要传 5 个值
    print(a,b,c,d,e)  # 抛出异常 : struct.error: unpack requires a buffer of 4 bytes

打包一个 json 后的信息长度, 在 socket 中可用于发送报头(报头为固定长度)

import struct
import json

dic = 
    "header_name" : "a.txt",
    "total_size" : 22,
    "heash" : "shawn"
 #Python小白学习交流群：725638078

res = json.dumps(dic)  # 将报头序列化
lens = struct.pack("i",len(res))  # 将报头的长度传入并打包
lens2 = struct.unpack("i",lens)   # 假设通信另一端收到打包的二进制,再进行解包拿到长度
print(lens2)    # (60,)
print(lens[0])  # 60

4.打包字节长度对照表

字符(Format)	cType	Python type	Standard size
x	pad byte	no value
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	4
l(小写L)	long	integer	4
L	unsigned long	integer	4
q	long long	integer	8
Q	unsigned long long	integer	8
f	float	float	4
d	double	float	8
s	charl	string
p	charl	string
P	void*	integer

Python使用struct处理二进制

转载自: http://blog.csdn.net/evan2008/article/details/8002958

 

有的时候需要用python处理二进制数据，比如，存取文件，socket操作时.这时候，可以使用python的struct模块来完成.可以用 struct来处理c语言中的结构体.
 

struct模块中最重要的三个函数是pack(), unpack(), calcsize()

pack(fmt, v1, v2, ...)     按照给定的格式(fmt)，把数据封装成字符串(实际上是类似于c结构体的字节流)

unpack(fmt, string)       按照给定的格式(fmt)解析字节流string，返回解析出来的tuple

calcsize(fmt)                 计算给定的格式(fmt)占用多少字节的内存
 

struct中支持的格式如下表：

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	unsigned int	integer or long	4
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

注1.q和Q只在机器支持64位操作时有意思

注2.每个格式前可以有一个数字，表示个数

注3.s格式表示一定长度的字符串，4s表示长度为4的字符串，但是p表示的是pascal字符串

注4.P用来转换一个指针，其长度和机器字长相关

注5.最后一个可以用来表示指针类型的，占4个字节
 

为了同c中的结构体交换数据，还要考虑有的c或c++编译器使用了字节对齐，通常是以4个字节为单位的32位系统，故而struct根据本地机器字节顺序转换.可以用格式中的第一个字符来改变对齐方式.定义如下：

Character Byte order Size and alignment

@	native	native            凑够4个字节
=	native	standard        按原字节数
<	little-endian	standard        按原字节数
>	big-endian	standard       按原字节数
!	network (= big-endian)	standard       按原字节数

使用方法是放在fmt的第一个位置，就像‘@5s6sif‘
 

示例一：

比如有一个结构体

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)

上面的格式字符串中，!表示我们要使用网络字节顺序解析，因为我们的数据是从网络中接收到的，在网络上传送的时候它是网络字节顺序的.后面的H表示 一个unsigned short的id,4s表示4字节长的字符串，2I表示有两个unsigned int类型的数据.


就通过一个unpack，现在id, tag, version, count里已经保存好我们的信息了.

同样，也可以很方便的把本地数据再pack成struct格式.

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

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

示例二：

import struct

a=12.34

#将a变为二进制

bytes=struct.pack(‘i‘,a)

此时bytes就是一个string字符串，字符串按字节同a的二进制存储内容相同。

再进行反操作

现有二进制数据bytes，（其实就是字符串），将它反过来转换成python的数据类型：

a,=struct.unpack(‘i‘,bytes)

注意，unpack返回的是tuple

所以如果只有一个变量的话：

bytes=struct.pack(‘i‘,a)

那么，解码的时候需要这样

a,=struct.unpack(‘i‘,bytes) 或者 (a,)=struct.unpack(‘i‘,bytes)

如果直接用a=struct.unpack(‘i‘,bytes)，那么 a=(12.34,) ，是一个tuple而不是原来的浮点数了。

 

我的说明：不知道作者原文是否错误，在此说明

将a转换成2进制时应该使用 struct.pack(‘f‘,a)或者struct.pack(‘d‘,a) 解包也同样的格式符，其中f有误差，而d没有出现误差。

 

如果是由多个数据构成的，可以这样：

a=‘hello‘

b=‘world!‘

c=2

d=45.123

bytes=struct.pack(‘5s6sif‘,a,b,c,d)

此时的bytes就是二进制形式的数据了，可以直接写入文件比如 binfile.write(bytes)

然后，当我们需要时可以再读出来，bytes=binfile.read()

再通过struct.unpack()解码成python变量

a,b,c,d=struct.unpack(‘5s6sif‘,bytes)

‘5s6sif‘这个叫做fmt，就是格式化字符串，由数字加字符构成，5s表示占5个字符的字符串，2i，表示2个整数等等，下面是可用的字符及类型，ctype表示可以与python中的类型一一对应。

注意：二进制文件处理时会碰到的问题

我们使用处理二进制文件时，需要用如下方法

binfile=open(filepath,‘rb‘)    读二进制文件

binfile=open(filepath,‘wb‘)    写二进制文件

那么和binfile=open(filepath,‘r‘)的结果到底有何不同呢？

不同之处有两个地方：

第一，使用‘r‘的时候如果碰到‘0x1A‘，就会视为文件结束，这就是EOF。使用‘rb‘则不存在这个问题。即，如果你用二进制写入再用文本读出的话，如果其中存在‘0X1A‘，就只会读出文件的一部分。使用‘rb‘的时候会一直读到文件末尾。

第二，对于字符串x=‘abc\ndef‘，我们可用len(x)得到它的长度为7，\n我们称之为换行符，实际上是‘0X0A‘。当我们用‘w‘即文本方式写的时候，在windows平台上会自动将‘0X0A‘变成两个字符‘0X0D‘，‘0X0A‘，即文件长度实际上变成8.。当用‘r‘文本方式读取时，又自动的转换成原来的换行符。如果换成‘wb‘二进制方式来写的话，则会保持一个字符不变，读取时也是原样读取。所以如果用文本方式写入，用二进制方式读取的话，就要考虑这多出的一个字节了。‘0X0D‘又称回车符。linux下不会变。因为linux只使用‘0X0A‘来表示换行。