ustruct – 打包和解压缩原始数据类型

这个模块实现了相应 CPython 模块的一个子集,如下所述。有关更多信息,请参阅原始CPython文档: struct

格式化字符串

格式字符串是用于在打包和解包数据时指定预期布局的机制。它们是从格式字符构建的,它指定打包/解包的数据类型。此外,还有用于控制字节顺序,大小和对齐的特殊字符。

字节顺序,大小和对齐

默认情况下,C类型以机器的本机格式和字节顺序表示,并在必要时通过跳过填充字节进行正确对齐(根据C编译器使用的规则)。 或者,根据下表,格式字符串的第一个字符可用于指示打包数据的字节顺序,大小和对齐方式:

Character

Byte order

Size

Alignment

@

native

native

native

=

native

standard

none

<

little-endian

standard

none

>

big-endian

standard

none

!

network (= big-endian)

standard

none

格式字符

格式字符具有以下含义; 根据类型,C和Python值之间的转换应该是显而易见的。“标准大小”列是指使用标准大小时打包值的大小(以字节为单位); 也就是说,当格式字符串中的一个开始’<’,’>’,’!’或 ‘=’。使用本机大小时,打包值的大小取决于平台。

Format

C Type

Python type

Standard size

x

pad byte

no value

c

char

bytes 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

4

l

long

integer

4

L

unsigned long

integer

4

q

long long

integer

8

Q

unsigned long long

integer

8

n

ssize_t

integer

N

size_t

integer

e

(7)

float

2

f

float

float

4

d

double

float

8

s

char[]

bytes

p

char[]

bytes

P

void *

integer

函数

ustruct.calcsize(fmt)

返回需存入给定 fmt 的字节数量。

  • fmt - 格式字符类型,见上文格式字符表

>>> struct.calcsize("i")
4
>>> struct.calcsize("B")
1
ustruct.pack(fmt, v1, v2, ...)

根据格式字符串fmt,打包 v1, v2, … 值。返回值为一个解码该值的字节对象。

>>> struct.pack("ii", 3, 2)
b'\x03\x00\x00\x00\x02\x00\x00\x00'
ustruct.pack_into(fmt, buffer, offset, v1, v2, ...)

根据格式字符串fmt,将 v1, v2, … 值打包进从 offset 开始的缓冲区。从缓冲区的末端计数, offset 可能为负值。

ustruct.unpack(fmt, data)

根据格式字符串 fmt 对数据进行解压。返回值为一个解压值元组。

>>> buf = struct.pack("bb", 1, 2)
>>> print(buf)
b'\x01\x02'
>>> print(struct.unpack("bb", buf))
(1, 2)
ustruct.unpack_from(fmt, data, offset=0)

根据格式字符串 fmtoffset 处开始的数据解包。从缓冲区的末尾开始计数的偏移量可能为负。返回值是解压缩值的元组。

>>> buf = struct.pack("bb", 1, 2)
>>> print(struct.unpack("bb", buf))
(1, 2)
>>> print(struct.unpack_from("b", buf, 1))
(2,)