struct — Packen und Entpacken primitiver Datentypen

Dieses Modul führt Konvertierungen zwischen Python-Werten und Structs im C-Stil durch, die als Python-bytes-Objekte dargestellt werden, wobei Format-Strings das Layout der Daten beschreiben.

Die folgenden Byte-Reihenfolgen werden unterstützt:

Zeichen	Byte-Reihenfolge	Größe	Ausrichtung
@	nativ	nativ	nativ
<	Little-Endian	Standard	keine
>	Big-Endian	Standard	keine
!	Netzwerk (= Big-Endian)	Standard	keine

Die folgenden Datentypen werden unterstützt:

Format	C-Typ	Python-Typ	Standardgröße
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/v (half-float)	float (2)	2
f	float	float (2)	4
d	double	float (2)	8
s	char[]	bytes
P	void *	integer

1. Erfordert long-Unterstützung, wenn mit Werten größer als 30 Bit verwendet.

2. Erfordert Gleitkomma-Unterstützung.

Unterschied zu CPython

Leerzeichen werden in Format-Strings nicht unterstützt.

Beispiele

Packen und Entpacken von Little-Endian-Werten. Das Präfix < wählt die Little-Endian-Byte-Reihenfolge mit Standardgrößen und ohne Ausrichtung:

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

Packen in einen und Entpacken aus einem bestehenden Puffer an einem Byte-Offset:

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,)

Funktionen

struct.calcsize(fmt: str) → int

Gibt die Anzahl der Bytes zurück, die zum Speichern des angegebenen fmt benötigt werden.

struct.pack(fmt: str, *values: Any) → bytes

Packt die values gemäß dem Format-String fmt. Der Rückgabewert ist ein bytes-Objekt, das die Werte codiert.

struct.pack_into(fmt: str, buffer: Any, offset: int, *values: Any) → None

Packt die values gemäß dem Format-String fmt in einen buffer, beginnend bei offset. offset darf negativ sein, um vom Ende von buffer aus zu zählen.

struct.unpack(fmt: str, data: bytes) → Tuple

Entpackt aus den data gemäß dem Format-String fmt. Der Rückgabewert ist ein Tupel der entpackten Werte.

struct.unpack_from(fmt: str, data: bytes, offset: int = 0, /) → Tuple

Entpackt aus den data, beginnend bei offset, gemäß dem Format-String fmt. offset darf negativ sein, um vom Ende von data aus zu zählen. Der Rückgabewert ist ein Tupel der entpackten Werte.