struct — primitieve gegevenstypen inpakken en uitpakken

Deze module voert conversies uit tussen Python-waarden en C-stijl structs die worden weergegeven als Python bytes-objecten, waarbij format-strings worden gebruikt om de lay-out van de gegevens te beschrijven.

De volgende byte-volgordes worden ondersteund:

Teken

Byte-volgorde

Grootte

Uitlijning

@

native

native

native

<

little-endian

standaard

geen

>

big-endian

standaard

geen

!

netwerk (= big-endian)

standaard

geen

De volgende gegevenstypen worden ondersteund:

Format

C-type

Python-type

Standaardgrootte

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.t. (half-float)

float (2)

2

f

float

float (2)

4

d

double

float (2)

8

s

char[]

bytes

P

void *

integer

  1. Vereist long-ondersteuning bij gebruik met waarden groter dan 30 bits.

  2. Vereist ondersteuning voor drijvende komma.

Verschil met CPython

Witruimte wordt niet ondersteund in format-strings.

Voorbeelden

Little-endian waarden inpakken en uitpakken. Het voorvoegsel < selecteert little-endian byte-volgorde met standaardgroottes en zonder uitlijning:

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

Inpakken in en uitpakken uit een bestaande buffer op een 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,)

Functies

struct.calcsize(fmt: str) int

Geeft het aantal bytes terug dat nodig is om de opgegeven fmt op te slaan.

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

Pakt de values in volgens de format-string fmt. De retourwaarde is een bytes-object dat de waarden codeert.

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

Pakt de values in volgens de format-string fmt in een buffer beginnend bij offset. offset mag negatief zijn om vanaf het einde van buffer te tellen.

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

Pakt uit de data uit volgens de format-string fmt. De retourwaarde is een tuple van de uitgepakte waarden.

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

Pakt uit de data uit beginnend bij offset volgens de format-string fmt. offset mag negatief zijn om vanaf het einde van data te tellen. De retourwaarde is een tuple van de uitgepakte waarden.