struct — primitív adattípusok be- és kicsomagolása

Ez a modul Python értékek és Python bytes objektumokként reprezentált C-stílusú structok közötti átalakításokat végez, az adatok elrendezésének leírásához formátumkarakterláncokat használva.

Az alábbi bájtsorrendek támogatottak:

Karakter	Bájtsorrend	Méret	Igazítás
@	natív	natív	natív
<	little-endian	standard	nincs
>	big-endian	standard	nincs
!	hálózati (= big-endian)	standard	nincs

Az alábbi adattípusok támogatottak:

Formátum	C típus	Python típus	Standard méret
b	signed char	egész szám	1
B	unsigned char	egész szám	1
h	short	egész szám	2
H	unsigned short	egész szám	2
i	int	egész szám (1)	4
I	unsigned int	egész szám (1)	4
l	long	egész szám (1)	4
L	unsigned long	egész szám (1)	4
q	long long	egész szám (1)	8
Q	unsigned long long	egész szám (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 *	egész szám

1. Long támogatást igényel, ha 30 bitnél nagyobb értékekkel használják.

2. Lebegőpontos támogatást igényel.

Eltérés a CPython-tól

A formátumkarakterláncokban nem támogatott a szóköz.

Példák

Little-endian értékek be- és kicsomagolása. A < prefix little-endian bájtsorrendet választ standard méretekkel és igazítás nélkül:

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

Becsomagolás egy meglévő pufferbe és kicsomagolás onnan egy bájteltolásnál:

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

Függvények

struct.calcsize(fmt: str) → int

Visszaadja a megadott fmt tárolásához szükséges bájtok számát.

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

Becsomagolja a values értékeket a fmt formátumkarakterlánc szerint. A visszatérési érték egy bytes objektum, amely az értékeket kódolja.

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

Becsomagolja a values értékeket a fmt formátumkarakterlánc szerint egy buffer pufferbe, az offset eltolástól kezdve. Az offset lehet negatív, hogy a buffer végétől számoljon.

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

Kicsomagolja az adatokat a data objektumból a fmt formátumkarakterlánc szerint. A visszatérési érték a kicsomagolt értékek tuple-je.

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

Kicsomagolja az adatokat a data objektumból, az offset eltolástól kezdve, a fmt formátumkarakterlánc szerint. Az offset lehet negatív, hogy a data végétől számoljon. A visszatérési érték a kicsomagolt értékek tuple-je.