struct — pakowanie i rozpakowywanie prymitywnych typów danych

Ten moduł wykonuje konwersje pomiędzy wartościami Pythona a strukturami w stylu C reprezentowanymi jako obiekty bytes Pythona, używając łańcuchów formatu do opisania układu danych.

Obsługiwane są następujące kolejności bajtów:

Znak	Kolejność bajtów	Rozmiar	Wyrównanie
@	natywna	natywna	natywna
<	little-endian	standardowy	brak
>	big-endian	standardowy	brak
!	sieciowa (= big-endian)	standardowy	brak

Obsługiwane są następujące typy danych:

Format	Typ C	Typ Pythona	Rozmiar standardowy
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. Wymaga obsługi typu long, gdy używane z wartościami większymi niż 30 bitów.

2. Wymaga obsługi liczb zmiennoprzecinkowych.

Różnica względem CPythona

Białe znaki nie są obsługiwane w łańcuchach formatu.

Przykłady

Pakowanie i rozpakowywanie wartości little-endian. Przedrostek < wybiera kolejność bajtów little-endian z rozmiarami standardowymi i bez wyrównania:

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

Pakowanie do i rozpakowywanie z istniejącego bufora pod przesunięciem bajtowym:

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

Funkcje

struct.calcsize(fmt: str) → int

Zwraca liczbę bajtów potrzebnych do przechowania podanego fmt.

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

Pakuje wartości values zgodnie z łańcuchem formatu fmt. Wartością zwracaną jest obiekt bytes kodujący te wartości.

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

Pakuje wartości values zgodnie z łańcuchem formatu fmt do bufora buffer, zaczynając od przesunięcia offset. offset może być ujemne, aby liczyć od końca bufora buffer.

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

Rozpakowuje z danych data zgodnie z łańcuchem formatu fmt. Wartością zwracaną jest krotka rozpakowanych wartości.

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

Rozpakowuje z danych data, zaczynając od przesunięcia offset, zgodnie z łańcuchem formatu fmt. offset może być ujemne, aby liczyć od końca danych data. Wartością zwracaną jest krotka rozpakowanych wartości.