python struct

python struct

    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'  
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  
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
  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)  
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手册 struct 模块

Python手册 struct 模块:http://docs.python.org/library/struct.html#module-struct

 

转载声明: 本文转自 http://blog.csdn.net/JGood/archive/2009/06/22/4290158.aspx

 

 

 

FormatC TypePython typeStandard sizeNotes
x pad byte no value    
c char string of length 1 1  
b signed char integer 1 (3)
B unsigned char integer 1 (3)
? _Bool bool 1 (1)
h short integer 2 (3)
H unsigned short integer 2 (3)
i int integer 4 (3)
I unsigned int integer 4 (3)
l long integer 4 (3)
L unsigned long integer 4 (3)
q long long integer 8 (2), (3)
Q unsigned long long integer 8 (2), (3)
f float float 4 (4)
d double float 8 (4)
s char[] string    
p char[] string    
P void * integer   (5), (3)

看到在进行c格式的二进制文件读取的过程中,用到了struct.unpack方法,因此开始找struct模块的一些相关解释,网上没有看到很清晰的说明,那就根据Python v2.6.5 documentation自己写一个好了。

这个struct主要是用来处理C结构数据的,读入时先转换为Python的字符串类型,然后再转换为Python的结构化类型,比如元组(tuple)啥的~

一般输入的渠道来源于文件或者网络的二进制流。

在转化过程中,主要用到了一个格式化字符串(format strings),用来规定转化的方法和格式。

下面来谈谈主要的方法:

struct.pack(fmt,v1,v2,.....)

将v1,v2等参数的值进行一层包装,包装的方法由fmt指定。被包装的参数必须严格符合fmt。最后返回一个包装后的字符串。

struct.unpack(fmt,string)

顾 名思义,解包。比如pack打包,然后就可以用unpack解包了。返回一个由解包数据(string)得到的一个元组(tuple), 即使仅有一个数据也会被解包成元组。其中len(string) 必须等于 calcsize(fmt),这里面涉及到了一个calcsize函数,再后面谈到。

struct.calcsize(fmt)

这个就是用来计算fmt格式所描述的结构的大小。

 

格式字符串(format string)由一个或多个格式字符(format characters)组成,对于这些格式字符的描述参照Python manual如下

Formatc TypePythonNote
x pad byte no value  
c char string of length 1  
b signedchar integer  
B unsignedchar integer  
? _Bool bool (1)
h short integer  
H unsignedshort integer  
i int integer  
I unsignedint integer or long  
l long integer  
L unsignedlong long  
q longlong long (2)
Q unsignedlonglong long (2)
f float float  
d double float  
s char[] string  
p char[] string  
P void* long  

说到这里,大家可能都有点迷糊了,那就看一段小代码

 

import struct 

# native byteorder 
buffer = struct.pack("ihb", 1, 2, 3) 
print repr(buffer) 
print struct.unpack("ihb", buffer) 

# data from a sequence, network byteorder 
data = [1, 2, 3] 
buffer = struct.pack("!ihb", *data)
print repr(buffer) 
print struct.unpack("!ihb", buffer)

 

 

Output:

'\x01\x00\x00\x00\x02\x00\x03'
(1, 2, 3)
'\x00\x00\x00\x01\x00\x02\x03'
(1, 2, 3)

首 先将参数1,2,3打包,打包前1,2,3明显属于python数据类型中的integer,pack后就变成了C结构的二进制串,转成 python的string类型来显示就是  '\x01\x00\x00\x00\x02\x00\x03'。由于本机是小端('little- endian',关于大端和小端的区别请参照这里, 故而高位放在低地址段。i 代表C struct中的int类型,故而本机占4位,1则表示为01000000;h 代表C struct中的short类型,占2位,故表示为0200;同理b 代表C struct中的signed char类型,占1位,故而表示为03。

其他结构的转换也类似,有些特别的可以参考Manual。

在Format string 的首位,有一个可选字符来决定大端和小端,列表如下:

   
@ native native
= native standard
< little-endian standard
> big-endian standard
! network (= big-endian) standard

如果没有附加,默认为@,即使用本机的字符顺序(大端or小端),对于C结构的大小和内存中的对齐方式也是与本机相一致的(native),比如有的机器integer为2位而有的机器则为四位;有的机器内存对其位四位对齐,有的则是n位对齐(n未知,我也不知道多少)。

还有一个标准的选项,被描述为:如果使用标准的,则任何类型都无内存对齐。

比如刚才的小程序的后半部分,使用的format string中首位为!,即为大端模式标准对齐方式,故而输出的为'\x00\x00\x00\x01\x00\x02\x03',其中高位自己就被放在内存的高地址位了。

关于struct模块的讲解就到这里。本文只做引子,详细内容可以参见手册。由于水平有限,谬误之处还请指出。

 

posted on 2015-09-21 17:32  小西红柿  阅读(287)  评论(0)    收藏  举报

导航