struct — balení a rozbalení primitivních datových typů

Tento modul provádí převody mezi hodnotami Pythonu a strukturami ve stylu C reprezentovanými jako objekty bytes Pythonu, přičemž k popisu rozložení dat používá formátovací řetězce.

Podporovány jsou následující pořadí bajtů:

Znak	Pořadí bajtů	Velikost	Zarovnání
@	nativní	nativní	nativní
<	little-endian	standardní	žádné
>	big-endian	standardní	žádné
!	síťové (= big-endian)	standardní	žádné

Podporovány jsou následující datové typy:

Formát	Typ v C	Typ v Pythonu	Standardní velikost
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

1. Vyžaduje podporu long při použití s hodnotami většími než 30 bitů.

2. Vyžaduje podporu pohyblivé řádové čárky.

Rozdíl oproti CPythonu

Bílé znaky nejsou ve formátovacích řetězcích podporovány.

Příklady

Zabalení a rozbalení hodnot v pořadí little-endian. Prefix < vybírá pořadí bajtů little-endian se standardními velikostmi a bez zarovnání:

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

Zabalení do existujícího bufferu a rozbalení z něj na bajtovém offsetu:

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

Funkce

struct.calcsize(fmt: str) → int

Vrátí počet bajtů potřebných k uložení daného fmt.

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

Zabalí values podle formátovacího řetězce fmt. Návratovou hodnotou je objekt bytes kódující hodnoty.

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

Zabalí values podle formátovacího řetězce fmt do buffer počínaje pozicí offset. offset může být záporný a počítá se pak od konce buffer.

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

Rozbalí z data podle formátovacího řetězce fmt. Návratovou hodnotou je n-tice rozbalených hodnot.

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

Rozbalí z data počínaje pozicí offset podle formátovacího řetězce fmt. offset může být záporný a počítá se pak od konce data. Návratovou hodnotou je n-tice rozbalených hodnot.