struct — упаковка и распаковка примитивных типов данных

Этот модуль выполняет преобразования между значениями Python и структурами в стиле C, представленными как объекты bytes Python, используя строки формата для описания компоновки данных.

Поддерживаются следующие порядки байтов:

Символ

Порядок байтов

Размер

Выравнивание

@

собственный

собственный

собственный

<

little-endian

стандартный

нет

>

big-endian

стандартный

нет

!

сетевой (= big-endian)

стандартный

нет

Поддерживаются следующие типы данных:

Формат

Тип C

Тип Python

Стандартный размер

b

signed char

целое число

1

B

unsigned char

целое число

1

h

short

целое число

2

H

unsigned short

целое число

2

i

int

целое число (1)

4

I

unsigned int

целое число (1)

4

l

long

целое число (1)

4

L

unsigned long

целое число (1)

4

q

long long

целое число (1)

8

Q

unsigned long long

целое число (1)

8

e

н/д (half-float)

float (2)

2

f

float

float (2)

4

d

double

float (2)

8

s

char[]

bytes

P

void *

целое число

  1. Требует поддержки long при использовании со значениями больше 30 бит.

  2. Требует поддержки чисел с плавающей запятой.

Отличие от CPython

Пробельные символы не поддерживаются в строках формата.

Примеры

Упаковка и распаковка значений в порядке little-endian. Префикс < выбирает порядок байтов little-endian со стандартными размерами и без выравнивания:

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

Упаковка в существующий буфер и распаковка из него по байтовому смещению:

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

Функции

struct.calcsize(fmt: str) int

Возвращает количество байтов, необходимое для хранения заданного fmt.

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

Упаковывает values в соответствии со строкой формата fmt. Возвращаемое значение – это объект bytes, кодирующий значения.

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

Упаковывает values в соответствии со строкой формата fmt в buffer, начиная со смещения offset. offset может быть отрицательным для отсчёта от конца buffer.

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

Распаковывает из data в соответствии со строкой формата fmt. Возвращаемое значение – это кортеж распакованных значений.

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

Распаковывает из data, начиная со смещения offset, в соответствии со строкой формата fmt. offset может быть отрицательным для отсчёта от конца data. Возвращаемое значение – это кортеж распакованных значений.