Python基础之:struct和格式化字符

灰太狼 2023-01-13 05:42 46阅读 0赞

### 文章目录 ###

*  简介
 *  struct中的方法
 *  格式字符串
 *   *  字节顺序，大小和对齐方式
     *  格式字符
     *   *  格式数字
         *  格式字符
         *  格式字符串
         *  填充的影响
         *  复杂应用

# 简介 #

文件的存储内容有两种方式，一种是二进制，一种是文本的形式。如果是以文本的形式存储在文件中，那么从文件中读取的时候就会遇到一个将文本转换为Python中数据类型的问题。实际上即使是文本的形式存储，存储的数据也是也是有结构的，因为Python底层是用C来编写的，这里我们也称之为C结构。

Lib/struct.py 就是负责进行这种结构转换的模块。

# struct中的方法 #

先看下struct的定义：

__all__ = [
        # Functions
        'calcsize', 'pack', 'pack_into', 'unpack', 'unpack_from',
        'iter_unpack',
    
        # Classes
        'Struct',
    
        # Exceptions
        'error'
        ]

其中有6个方法，1个异常。

我们主要来看这6个方法的使用：

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>struct.pack(format, v1, v2, …)</td> 
   <td>返回一个 bytes 对象，其中包含根据格式字符串 <em>format</em> 打包的值 <em>v1</em>, <em>v2</em>, … 参数个数必须与格式字符串所要求的值完全匹配。</td> 
  </tr> 
  <tr> 
   <td>struct.pack_into(format, buffer, offset, v1, v2, …)</td> 
   <td>根据格式字符串 <em>format</em> 打包 <em>v1</em>, <em>v2</em>, … 并将打包的字节串从 <em>offset</em> 开始的位置写入可写缓冲区 <em>buffer</em> 。 请注意 <em>offset</em> 是必需的参数。</td> 
  </tr> 
  <tr> 
   <td>struct.unpack(format, buffer)</td> 
   <td>根据格式字符串 <em>format</em> 从缓冲区 <em>buffer</em> 解包（假定是由 <code>pack(format, ...)</code> 打包）。 返回的结果为一个元组，即使其只包含一个条目。 缓冲区的字节大小必须匹配格式所要求的大小。</td> 
  </tr> 
  <tr> 
   <td>struct.unpack_from(format, /, buffer, offset=0)</td> 
   <td>从位置 offset 开始对 buffer 根据格式字符串 format 进行解包。 结果为一个元组，即使其中只包含一个条目。</td> 
  </tr> 
  <tr> 
   <td>struct.iter_unpack(format, buffer)</td> 
   <td>根据格式字符串 <em>format</em> 以迭代方式从缓冲区 <em>buffer</em> 解包。 此函数返回一个迭代器，它将从缓冲区读取相同大小的块直至其内容全部耗尽。</td> 
  </tr> 
  <tr> 
   <td>struct.calcsize(format)</td> 
   <td>返回与格式字符串 <em>format</em> 相对应的结构的大小（亦即 <code>pack(format, ...)</code> 所产生的字节串对象的大小）。</td> 
  </tr> 
 </tbody> 
</table>

这些方法主要就是打包和解包的操作，其中一个非常重要的参数就是format，也被成为格式字符串，它指定了每个字符串被打包的格式。

# 格式字符串 #

格式字符串是用来在打包和解包数据时指定数据格式的机制。 它们使用指定被打包/解包数据类型的 格式字符 进行构建。 此外，还有一些特殊字符用来控制 字节顺序，大小和对齐方式。

## 字节顺序，大小和对齐方式 ##

默认情况下，C类型以机器的本机格式和字节顺序表示，并在必要时通过填充字节进行正确对齐（根据C编译器使用的规则）。

我们也可以手动指定格式字符串的字节顺序，大小和对齐方式：

大端和小端是两种数据存储方式。

第一种Big Endian将高位的字节存储在起始地址

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_0_text_aHR0cDovL3d3dy5mbHlkZWFuLmNvbQ_size_35_color_8F8F8F_t_70][]

第二种Little Endian将地位的字节存储在起始地址

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_0_text_aHR0cDovL3d3dy5mbHlkZWFuLmNvbQ_size_35_color_8F8F8F_t_70 1][]

其实Big Endian更加符合人类的读写习惯，而Little Endian更加符合机器的读写习惯。

目前主流的两大CPU阵营中，PowerPC系列采用big endian方式存储数据，而x86系列则采用little endian方式存储数据。

如果不同的CPU架构直接进行通信，就由可能因为读取顺序的不同而产生问题。

> 填充只会在连续结构成员之间自动添加。 填充不会添加到已编码结构的开头和末尾。
> 
> 当使用非原字节大小和对齐方式即 ‘<’, ‘>’, ‘=’, and ‘!’ 时不会添加任何填充。

## 格式字符 ##

我们来看下字符都有哪些格式：

<table> 
 <thead> 
  <tr> 
   <th align="left">格式</th> 
   <th align="left">C 类型</th> 
   <th align="left">Python 类型</th> 
   <th align="left">标准大小（字节）</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>x</code></td> 
   <td align="left">填充字节</td> 
   <td align="left">无</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>c</code></td> 
   <td align="left"><code>char</code></td> 
   <td align="left">长度为 1 的字节串</td> 
   <td align="left">1</td> 
  </tr> 
  <tr> 
   <td align="left"><code>b</code></td> 
   <td align="left"><code>signed char</code></td> 
   <td align="left">整数</td> 
   <td align="left">1</td> 
  </tr> 
  <tr> 
   <td align="left"><code>B</code></td> 
   <td align="left"><code>unsigned char</code></td> 
   <td align="left">整数</td> 
   <td align="left">1</td> 
  </tr> 
  <tr> 
   <td align="left"><code>?</code></td> 
   <td align="left"><code>_Bool</code></td> 
   <td align="left">bool</td> 
   <td align="left">1</td> 
  </tr> 
  <tr> 
   <td align="left"><code>h</code></td> 
   <td align="left"><code>short</code></td> 
   <td align="left">整数</td> 
   <td align="left">2</td> 
  </tr> 
  <tr> 
   <td align="left"><code>H</code></td> 
   <td align="left"><code>unsigned short</code></td> 
   <td align="left">整数</td> 
   <td align="left">2</td> 
  </tr> 
  <tr> 
   <td align="left"><code>i</code></td> 
   <td align="left"><code>int</code></td> 
   <td align="left">整数</td> 
   <td align="left">4</td> 
  </tr> 
  <tr> 
   <td align="left"><code>I</code></td> 
   <td align="left"><code>unsigned int</code></td> 
   <td align="left">整数</td> 
   <td align="left">4</td> 
  </tr> 
  <tr> 
   <td align="left"><code>l</code></td> 
   <td align="left"><code>long</code></td> 
   <td align="left">整数</td> 
   <td align="left">4</td> 
  </tr> 
  <tr> 
   <td align="left"><code>L</code></td> 
   <td align="left"><code>unsigned long</code></td> 
   <td align="left">整数</td> 
   <td align="left">4</td> 
  </tr> 
  <tr> 
   <td align="left"><code>q</code></td> 
   <td align="left"><code>long long</code></td> 
   <td align="left">整数</td> 
   <td align="left">8</td> 
  </tr> 
  <tr> 
   <td align="left"><code>Q</code></td> 
   <td align="left"><code>unsigned long long</code></td> 
   <td align="left">整数</td> 
   <td align="left">8</td> 
  </tr> 
  <tr> 
   <td align="left"><code>n</code></td> 
   <td align="left"><code>ssize_t</code></td> 
   <td align="left">整数</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>N</code></td> 
   <td align="left"><code>size_t</code></td> 
   <td align="left">整数</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>e</code></td> 
   <td align="left">(6)</td> 
   <td align="left">浮点数</td> 
   <td align="left">2</td> 
  </tr> 
  <tr> 
   <td align="left"><code>f</code></td> 
   <td align="left"><code>float</code></td> 
   <td align="left">浮点数</td> 
   <td align="left">4</td> 
  </tr> 
  <tr> 
   <td align="left"><code>d</code></td> 
   <td align="left"><code>double</code></td> 
   <td align="left">浮点数</td> 
   <td align="left">8</td> 
  </tr> 
  <tr> 
   <td align="left"><code>s</code></td> 
   <td align="left"><code>char[]</code></td> 
   <td align="left">字节串</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>p</code></td> 
   <td align="left"><code>char[]</code></td> 
   <td align="left">字节串</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>P</code></td> 
   <td align="left"><code>void *</code></td> 
   <td align="left">整数</td> 
   <td align="left"></td> 
  </tr> 
 </tbody> 
</table>

### 格式数字 ###

举个例子，比如我们要打包一个int对象，我们可以这样写：

In [101]: from struct import *
    
    In [102]: pack('i',10)
    Out[102]: b'\n\x00\x00\x00'
    
    In [103]: unpack('i',b'\n\x00\x00\x00')
    Out[103]: (10,)
      
    In [105]: calcsize('i')
    Out[105]: 4

上面的例子中，我们打包了一个int对象10，然后又对其解包。并且计算了 i 这个格式的长度为4字节。

大家可以看到输出结果是 `b'\n\x00\x00\x00'` ，这里不去深究这个输出到底是什么意思，开头的b表示的是byte，后面是byte的编码。

格式字符之前可以带有整数重复计数。 例如，格式字符串 `'4h'` 的含义与 `'hhhh'` 完全相同。

看下如何打包4个short类型：

In [106]: pack('4h',2,3,4,5)
    Out[106]: b'\x02\x00\x03\x00\x04\x00\x05\x00'
    
    In [107]: unpack('4h',b'\x02\x00\x03\x00\x04\x00\x05\x00')
    Out[107]: (2, 3, 4, 5)

格式之间的空白字符会被忽略，但如果是struct.calcsize 方法的话格式字符中不可有空白字符。

当使用某一种整数格式 (‘b’, ‘B’, ‘h’, ‘H’, ‘i’, ‘I’, ‘l’, ‘L’, ‘q’, ‘Q’) 打包值 x 时，如果 x 在该格式的有效范围之外则将引发 struct.error。

### 格式字符 ###

除了数字之外，最常用的就是字符和字符串了。

我们先看下怎么使用格式字符，因为字符的长度是1个字节，我们需要这样做：

In [109]: pack('4c',b'a',b'b',b'c',b'd')
    Out[109]: b'abcd'
    
    In [110]: unpack('4c',b'abcd')
    Out[110]: (b'a', b'b', b'c', b'd')
    
    In [111]: calcsize('4c')
    Out[111]: 4

字符前面的b，表示这是一个字符，否则将会被当做字符串。

### 格式字符串 ###

再看下字符串的格式：

In [114]: pack('4s',b'abcd')
    Out[114]: b'abcd'
    
    In [115]: unpack('4s',b'abcd')
    Out[115]: (b'abcd',)
    
    In [116]: calcsize('4s')
    Out[116]: 4
    
    In [117]: calcsize('s')
    Out[117]: 1

可以看到对于字符串来说calcsize返回的是字节的长度。

### 填充的影响 ###

格式字符的顺序可能对大小产生影响，因为满足对齐要求所需的填充是不同的:

>>> pack('ci', b'*', 0x12131415)
    b'*\x00\x00\x00\x12\x13\x14\x15'
    >>> pack('ic', 0x12131415, b'*')
    b'\x12\x13\x14\x15*'
    >>> calcsize('ci')
    8
    >>> calcsize('ic')
    5

下面的例子我们将会展示如何手动影响填充效果：

In [120]: pack('llh',1, 2, 3)
    Out[120]: b'\x01\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x03\x00'

上面的例子中，我们打包1，2，3这三个数字，但是格式不一样，分别是long，long，short。

因为long是4个字节，short是2个字节，所以本质上是不对齐的。

如果想要对齐，我们可以在后面再加上 `0l` 表示0个long，从而进行手动填充：

In [118]: pack('llh0l', 1, 2, 3)
    Out[118]: b'\x01\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x03\x00\x00\x00\x00\x00\x00\x00'
    
    In [122]: unpack('llh0l',b'\x01\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x03\x00\x00\x00\x00\x00\x00\x00')
    Out[122]: (1, 2, 3)

### 复杂应用 ###

最后看一个复杂点的应用，这个应用中直接从unpack出来的数据读取到元组中：

>>> record = b'raymond \x32\x12\x08\x01\x08'
    >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record)
    
    >>> from collections import namedtuple
    >>> Student = namedtuple('Student', 'name serialnum school gradelevel')
    >>> Student._make(unpack('<10sHHb', record))
    Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)

> 本文已收录于 [http://www.flydean.com/13-python-struct-format-char/][http_www.flydean.com_13-python-struct-format-char]
> 
> 最通俗的解读，最深刻的干货，最简洁的教程，众多你不知道的小技巧等你来发现！
> 
> 欢迎关注我的公众号:「程序那些事」,懂技术，更懂你！

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_0_text_aHR0cDovL3d3dy5mbHlkZWFuLmNvbQ_size_35_color_8F8F8F_t_70]: /images/20221022/b1daa853f46d4a3fbeb4c2375ce2ad21.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_0_text_aHR0cDovL3d3dy5mbHlkZWFuLmNvbQ_size_35_color_8F8F8F_t_70 1]: /images/20221022/77c6944b981349608de92b0a37489528.png
[http_www.flydean.com_13-python-struct-format-char]: http://www.flydean.com/13-python-struct-format-char/