Python使用struct处理二进制
有的时候需要用 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='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' 来表示换行。