struct --- pack และ unpack ชนิดข้อมูลพื้นฐาน

โมดูลนี้ทำการแปลงระหว่างค่า Python และ struct แบบ C-style ที่แสดงเป็นออบเจ็กต์ bytes ของ Python โดยใช้สตริงรูปแบบเพื่ออธิบายโครงสร้างของข้อมูล

รองรับลำดับไบต์ดังต่อไปนี้:

ตัวอักษร

ลำดับไบต์

ขนาด

การจัดตำแหน่ง

@

native

native

native

<

little-endian

standard

none

>

big-endian

standard

none

!

network (= big-endian)

standard

none

รองรับชนิดข้อมูลดังต่อไปนี้:

รูปแบบ

ชนิด C

ชนิด Python

ขนาดมาตรฐาน

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. ต้องการการรองรับ long เมื่อใช้กับค่าที่ใหญ่กว่า 30 บิต

  2. ต้องการการรองรับทศนิยม

ข้อแตกต่างจาก CPython

ไม่รองรับช่องว่างในสตริงรูปแบบ

ตัวอย่าง

Pack และ unpack ค่า 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

Pack ลงใน buffer ที่มีอยู่และ unpack จาก buffer ที่ 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,)

ฟังก์ชัน

struct.calcsize(fmt: str) → int

คืนค่าจำนวนไบต์ที่ต้องการสำหรับจัดเก็บ fmt ที่กำหนด

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

Pack values ตามสตริงรูปแบบ fmt ค่าที่คืนกลับคือออบเจ็กต์ bytes ที่เข้ารหัสค่าต่าง ๆ

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

Pack values ตามสตริงรูปแบบ fmt ลงใน buffer เริ่มต้นที่ offset offset อาจเป็นค่าลบเพื่อนับจากท้าย buffer

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

Unpack จาก data ตามสตริงรูปแบบ fmt ค่าที่คืนกลับคือทูเพิลของค่าที่ unpack แล้ว

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

Unpack จาก data เริ่มต้นที่ offset ตามสตริงรูปแบบ fmt offset อาจเป็นค่าลบเพื่อนับจากท้าย data ค่าที่คืนกลับคือทูเพิลของค่าที่ unpack แล้ว