Python之struct模块（处理二进制）

本是古典何须时尚 2021-12-23 14:41 207阅读 0赞

有的时候需要用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中支持的格式如下表：

<table style="margin:0px; padding:0px; color:rgb(50,62,50); font-family:simsun; font-size:14px"> 
 <thead> 
 <tr> 
 <th style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif">Format</th> 
 <th style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif">C Type</th> 
 <th style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif">Python</th> 
 <th style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif">字节数</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> x</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> pad byte</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> no value</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 1</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> c</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> char</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> string of length 1</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 1</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> b</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> signed&nbsp;char</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> integer</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 1</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> B</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> unsigned&nbsp;char</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> integer</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 1</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> ?</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> _Bool</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> bool</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 1</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> h</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> short</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> integer</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 2</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> H</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> unsigned&nbsp;short</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> integer</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 2</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> i</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> int</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> integer</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 4</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> I</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> unsigned&nbsp;int</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> integer or long</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 4</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> l</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> long</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> integer</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 4</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> L</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> unsigned&nbsp;long</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> long</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 4</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> q</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> long&nbsp;long</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> long</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 8</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> Q</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> unsigned&nbsp;long&nbsp;long</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> long</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 8</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> f</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> float</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> float</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 4</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> d</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> double</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> float</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 8</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> s</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> char[]</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> string</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 1</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> p</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> char[]</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> string</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> 1</td> 
 </tr> 
 <tr> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> P</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> void&nbsp;*</td> 
 <td style="margin:0px; padding:0px; font-family:Verdana,宋体,sans-serif; line-height:18px"> long</td> 
 </tr> 
 </tbody> 
</table>

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

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

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

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

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

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

使用方法是放在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='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'来表示换行。