struct — empacota e desempacota tipos de dados primitivos¶
Este módulo realiza conversões entre valores Python e structs no estilo C representados como objetos bytes do Python, usando strings de formato para descrever o layout dos dados.
As seguintes ordens de bytes são suportadas:
Caractere |
Ordem de bytes |
Tamanho |
Alinhamento |
|---|---|---|---|
@ |
nativo |
nativo |
nativo |
< |
little-endian |
padrão |
nenhum |
> |
big-endian |
padrão |
nenhum |
! |
rede (= big-endian) |
padrão |
nenhum |
Os seguintes tipos de dados são suportados:
Formato |
Tipo C |
Tipo Python |
Tamanho padrão |
|---|---|---|---|
b |
signed char |
integer |
1 |
B |
unsigned char |
integer |
1 |
h |
short |
integer |
2 |
H |
unsigned short |
integer |
2 |
i |
int |
integer (1) |
4 |
I |
unsigned int |
integer (1) |
4 |
l |
long |
integer (1) |
4 |
L |
unsigned long |
integer (1) |
4 |
q |
long long |
integer (1) |
8 |
Q |
unsigned long long |
integer (1) |
8 |
e |
n/a (half-float) |
float (2) |
2 |
f |
float |
float (2) |
4 |
d |
double |
float (2) |
8 |
s |
char[] |
bytes |
|
P |
void * |
integer |
Requer suporte a long quando usado com valores maiores que 30 bits.
Requer suporte a ponto flutuante.
Diferença em relação ao CPython
Espaços em branco não são suportados em strings de formato.
Exemplos¶
Empacota e desempacota valores little-endian. O prefixo < seleciona a ordem de bytes little-endian com tamanhos padrão e sem alinhamento:
import struct
# Pack an unsigned short (H, 2 bytes) then an unsigned int (I, 4 bytes).
data = struct.pack("<HI", 7, 1000)
# data == b'\x07\x00\xe8\x03\x00\x00'
# Unpack returns a tuple of the values, in order.
struct.unpack("<HI", data)
# (7, 1000)
# calcsize() reports how many bytes the format needs.
struct.calcsize("<HI")
# 6
Empacota em e desempacota de um buffer existente em um offset de byte:
buf = bytearray(8)
# Write a little-endian signed int (i) at offset 2.
struct.pack_into("<i", buf, 2, -12345)
# buf == bytearray(b'\x00\x00\xc7\xcf\xff\xff\x00\x00')
# Read it back from the same offset.
struct.unpack_from("<i", buf, 2)
# (-12345,)
Funções¶
- struct.calcsize(fmt: str) int¶
Retorna o número de bytes necessários para armazenar o fmt fornecido.
- struct.pack(fmt: str, *values: Any) bytes¶
Empacota os values de acordo com a string de formato fmt. O valor de retorno é um objeto bytes que codifica os valores.
- struct.pack_into(fmt: str, buffer: Any, offset: int, *values: Any) None¶
Empacota os values de acordo com a string de formato fmt em um buffer a partir de offset. offset pode ser negativo para contar a partir do fim do buffer.