struct 模块 二进制 字节流

http://blog.csdn.net/JGood/article/details/4290158

 

 

Python是一门非常简洁的语言，对于数据类型的表示，不像其他语言预定义了许多类型（如：在C#中，光整型就定义了8种），它只定义了六种基本类型：字符串，整数，浮点数，元组，列表，字典。通过这六种数据类型，我们可以完成大部分工作。但当Python需要通过网络与其他的平台进行交互的时候，必须考虑到将这些数据类型与其他平台或语言之间的类型进行互相转换问题。打个比方：C++写的客户端发送一个int型(4字节)变量的数据到Python写的服务器，Python接收到表示这个整数的4个字节数据，怎么解析成Python认识的整数呢？ Python的标准模块struct就用来解决这个问题。

　　struct模块的内容不多，也不是太难，下面对其中最常用的方法进行介绍：

 struct.pack

　　struct.pack用于将Python的值根据格式符，转换为字符串（因为Python中没有字节(Byte)类型，可以把这里的字符串理解为字节流，或字节数组）。其函数原型为：struct.pack(fmt, v1, v2, ...)，参数fmt是格式字符串，关于格式字符串的相关信息在下面有所介绍。v1, v2, ...表示要转换的python值。下面的例子将两个整数转换为字符串（字节流）:

 

import struct

a = 20
b = 400

str = struct.pack("ii", a, b)  #转换后的str虽然是字符串类型，但相当于其他语言中的字节流（字节数组），可以在网络上传输
print 'length:', len(str)
print str
print repr(str)

#---- result
#length: 8
#    ----这里是乱码
#'/x14/x00/x00/x00/x90/x01/x00/x00'

 

格式符"i"表示转换为int，'ii'表示有两个int变量。进行转换后的结果长度为8个字节（int类型占用4个字节，两个int为8个字节），可以看到输出的结果是乱码，因为结果是二进制数据，所以显示为乱码。可以使用python的内置函数repr来获取可识别的字符串，其中十六进制的0x00000014, 0x00001009分别表示20和400。

struct.unpack

　　struct.unpack做的工作刚好与struct.pack相反，用于将字节流转换成python数据类型。它的函数原型为：struct.unpack(fmt, string)，该函数返回一个元组。 下面是一个简单的例子：

str = struct.pack("ii", 20, 400)
a1, a2 = struct.unpack("ii", str)    函数返回一个元组
print 'a1:', a1
print 'a2:', a2

#---- result:
#a1: 20
#a2: 400

 

struct.calcsize

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

　　struct.calcsize用于计算格式字符串所对应的结果的长度，如：struct.calcsize('ii')，返回8。因为两个int类型所占用的长度是8个字节。

struct.pack_into, struct.unpack_from

 　　这两个函数在Python手册中有所介绍，但没有给出如何使用的例子。其实它们在实际应用中用的并不多。Google了很久，才找到一个例子，贴出来共享一下：

 

import struct
from ctypes import create_string_buffer

buf = create_string_buffer(12)
print repr(buf.raw)

struct.pack_into("iii", buf, 0, 1, 2, -1)
print repr(buf.raw)

print struct.unpack_from('iii', buf, 0)

#---- result
#'/x00/x00/x00/x00/x00/x00/x00/x00/x00/x00/x00/x00'
#'/x01/x00/x00/x00/x02/x00/x00/x00/xff/xff/xff/xff'
#(1, 2, -1)

 

关于格式字符串

　　在Python手册中，给出了C语言中常用类型与Python类型对应的格式符：

 

格式符	C语言类型	Python类型	注
x	pad byte	no value
c	char	string of length 1
b	signed char	integer
B	unsigned char	integer
?	_Bool	bool
h	short	integer
H	unsigned short	integer
i	int	integer
I	unsigned int	integer or long
l	long	integer
L	unsigned long	long
q	long long	long
Q	unsigned long long	long
f	float	float
d	double	float
s	char[]	string
p	char[]	string
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)把这个字符串发送出去.

 

===================================================================

http://www.cnblogs.com/gala/archive/2011/09/22/2184801.html

 

示例二：

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'来表示换行。

 

https://www.delftstack.com/zh/howto/python/how-to-convert-int-to-bytes-in-python-2-and-python-3/

 

将整型 int 转换为字节 bytes 是将字节 bytes 转换为整型 int的逆操作，本文中介绍的大多数的 int到 bytes 的方法都是 bytes 到 int 方法的反向方法。

Python 2.7 和 3 中 int 到 bytes 转换的通用方法

你可以使用 Python struct 模块中的 pack 函数将整数转换为特定格式的字节。

 

>>> import struct
>>> struct.pack("B", 2)
'\x02'
>>> struct.pack(">H", 2)
'\x00\x02'
>>> struct.pack("<H", 2)
'\x02\x00'

struct.pack 函数中的第一个参数是格式字符串，它指定了字节格式比如长度，字节顺序(little/big endian)等。

Python 3 中新引入的 int 到 bytes 的转换方法

使用 bytes 来进行 int 到 bytes 的转换

在上一篇文章中提到过，bytes 是 Python 3 中的内置数据类型。你可以使用 bytes 轻松地将整数 0~255 转换为字节数据类型。

 

>>> bytes([2])
b'\x02`

友情提示

整数需要放在括号[]中，否则你得到将是占用该整数个字节位置的空字节，而不是相应的字节本身。

 

>>> bytes(3)
b'\x00\x00\x00'

通过 int.to_bytes() 方法将整型转换为字节类型

从 Python3.1 开始引入了一个引入了一个新的整数类方法int.to_bytes()。它是上一篇文章中讨论的 int.from_bytes() 反向转换方法。

 

>>> (258).to_bytes(2, byteorder="little")
b'\x02\x01'
>>> (258).to_bytes(2, byteorder="big")
b'\x01\x02'
>>> (258).to_bytes(4, byteorder="little", signed=True)
b'\x02\x01\x00\x00'
>>> (-258).to_bytes(4, byteorder="little", signed=True)
b'\xfe\xfe\xff\xff'

第一个参数是转换后的字节数据长度，第二个参数 byteorder 将字节顺序定义为 little 或 big-endian，可选参数 signed 确定是否使用二进制补码来表示整数。

运行速度比较

Python 3 中, 你有 3 种方法可以转换 int 为 bytes，

• bytes() 方法
• struct.pack() 方法
• int.to_bytes() 方法

我们将测试每种方法的执行时间以比较它们的性能，最后将会给出来提高程序运行速度的建议。

 

>>> import timeint
>>> timeit.timeit('bytes([255])', number=1000000)
0.31296982169325455
>>> timeit.timeit('struct.pack("B", 255)', setup='import struct', number=1000000)
0.2640925447800839
>>> timeit.timeit('(255).to_bytes(1, byteorder="little")', number=1000000)
0.5622947660224895

转换方法	执行时间(100 万次)
bytes()	0.31296982169325455 s
struct.pack()	0.2640925447800839 s
int.to_bytes()	0.5622947660224895 s

因此，请使用 struct.pack() 函数执行来执行整型到字节的转换以获得最佳执行性能，虽然它已在 Python 2 分支中引入了，生姜还是老的辣！