StructReader 1.0.3

use class to parse binary format

StructReader – Binary Structure Parsing Framework

Installation

Install StructReader from PyPI:

pip install StructReader

Update

Update an existing installation of StructReader:

pip install --upgrade StructReader

1. Overview

StructReader is a binary format parsing framework for Python.

It is designed specifically for structured binary data parsing, where the layout is known or partially known, such as custom file formats.

Instead of manually reading bytes and tracking offsets, you declare the binary format structure, and StructReader handles stream reading, endianness, field dependencies, and control flow.

---

2. Basic Idea

You define a binary structure as a Python class.

• Each class attribute represents one field
• The attribute value describes how to read the field

The framework:

1. Compiles the structure into an internal opcode representation
2. Executes the opcodes against a binary stream
3. Produces a Python object or dictionary

---

3. Defining a Structure

Example

class Header:
    magic = UIntBE[32]
    size  = UInt[16]
    data  = Bytes[Var.size]

Parsing:

obj = ParseStruct(Header, data)

Access fields:

print(obj.magic)
print(obj.size)
print(obj.data)

---

4. Primitive Types

4.1 Integer Types

Type	Description
Int[n]	Signed integer, n bits
UInt[n]	Unsigned integer, n bits
IntLE[n]	Little-endian signed
IntBE[n]	Big-endian signed
UIntLE[n]	Little-endian unsigned
UIntBE[n]	Big-endian unsigned

Example:

id    = UInt[32]
flags = UIntBE[16]

---

4.2 Floating Point Types

Type	Description
Float[n]	Floating point, default endianness
FloatLE[n]	Little-endian
FloatBE[n]	Big-endian

Example:

x = Float[32]
y = FloatBE[64]

---

4.3 Strings

Str[length]
Str[length, encoding]

• length may be a constant or a previously defined field
• Default encoding is UTF-8

Example:

name_len = UInt[8]
name     = Str[Var.name_len]

---

4.4 Raw Bytes

Bytes[length]

Reads raw bytes from the stream.

Example:

payload = Bytes[16]

---

4.5 Variable-Length Integer

Uvarint
Svarint

Reads an unsigned/signed variable-length integer using 7-bit continuation encoding.

4.6 Boolean

Bool

Reads 1 byte and returns True if non-zero.

---

4.7 Stream Length

Len

Returns the total length of the input stream (in bytes).

Example:

class File:
    size = Len

---

4.8 Until (Terminated Read)

Until[value]

Reads data until a terminator value is encountered.

• The terminator is not included in the result
• Stream position advances past the terminator

Example:

name = Str[Until[b'\x00']]
data = Bytes[Until[b'\xFF\xFF']]

---

4.9 Align (Alignment Helper)

Align[n]

Returns the number of bytes needed to align the stream position to n.

Usually combined with Seek.

Example:

pad = Align[16]
Seek[Var.pad, 1]

---

5. Composite Types

5.1 List (Array)

List[count, value_type]

• count may be a constant or another field

Example:

count = UInt[16]
items = List[count, UInt[32]]

---

5.2 Nested Structures

Structures can be nested by referencing another structure class.

Example:

class Point:
    x = Int[32]
    y = Int[32]

class Shape:
    center = Point
    radius = UInt[16]

---

6. Field References (Var)

Var.field_name

Allows a field to reference a previously parsed field.

Example:

class Packet:
    length = UInt[16]
    data   = Bytes[Var.length]

---

7. Stream Position Control

7.1 Current Position

Pos

Returns the current read position in the stream.

---

7.2 Seek

Seek[offset, mode]

If mode is omitted, it defaults to 0.

Mode	Meaning
0	Absolute position
1	Relative to current position
2	Relative to end

Example:

Seek[128]      # same as Seek[128, 0]
Seek[128, 0]   # absolute position
Seek[16, 1]    # relative to current position

---

7.3 Peek (Non-consuming Read)

Peek[value]

Reads a value without advancing the stream position.

Example:

next_type = Peek[UInt[8]]

---

8. Conditional Parsing (Match)

Match[cond, params, results]

Selects one parsing branch based on the value of cond.

Example:

class Entry:
    type = UInt[8]
    data = Match[
        lambda t: 1 if t > 1 else 2 if t > 2 else 0,
        [Var.type],
        [
            UInt[32],    # index 0
            Str[8],      # index 1
            Bytes[8],    # index 2
        ]
    ]

---

9. Conditional Parsing (While)

While[cond, params, body]

Repeatedly parses body while the condition cond evaluates to True.

Example:

class Entry:
    values = While[
        lambda c: c < 128, # cond
        [UInt[8]],         # params
        [UInt[16]]         # body
    ]

---

10. Custom Functions (Func)

Func[callable, params...]

Calls a Python function with parsed parameters.

Example:

def checksum(a, b):
    return a ^ b

class Block:
    a = UInt[8]
    b = UInt[8]
    c = Func[checksum, Var.a, Var.b]

---

11. Group

Group[param1, param2, ...]

Used to group multiple parameters, mainly for function calls.

---

12. Parsing API

ParseStruct

ParseStruct(struct, data,
            ReturnDict=False,
            order='little',
            encoding='utf-8',
            order2=None,
            bytesToHex=False)

Parameters

• struct

  • A structure class or a compiled structure dictionary

• data

  • bytes, bytearray, memoryview, or BufferedReader

• ReturnDict (bool)

  • False (default): return an object with attributes
  • True: return a dictionary

• order ('little' | 'big')

  • Default integer byte order

• encoding (str)

  • Default string encoding

• order2 ('<' | '>' | None)

  • Float byte order override
  • If None, inferred from order

• bytesToHex (bool)

  • If True, Bytes[...] fields return hexadecimal strings

---

Parse to Dictionary

obj = ParseStruct(MyStruct, data, ReturnDict=True)

Returns a dictionary instead of an object.

---

Input Data Types

The input stream may be:

• bytes
• bytearray
• memoryview
• BufferedReader

---

13. Error Handling

• Parsing errors raise RuntimeError
• The error contains the failing field definition
• Context (Var) is reset between parse calls

---

14. Design Advantages

• Explicit support for binary format parsing
• Declarative structure definitions
• Configurable endianness and encoding
• Field dependency via Var
• Conditional parsing (Match)
• Stream control (Seek, Peek, Pos)
• Object or dictionary output modes
• No external dependencies

---

15. Default Value

Type	Default
Int	Int[32]
UInt	UInt[32]
IntLE	IntLE[32]
IntBE	IntBE[32]
UIntLE	UIntLE[32]
UIntBE	UIntBE[32]
Float	Float[32]
FloatLE	FloatLE[32]
FloatBE	FloatBE[32]
Str	Str[UInt[8]]
Bytes	Bytes[UInt[8]]
Seek	Seek[0]
Until	Until[b'\x00']
Align	Align[16]

16. Minimal Complete Example

from StructReader import ParseStruct

class Example:
    a = UInt[16]
    b = UInt[16]

obj = ParseStruct(Example, b"\x00\x01\x00\x02")
print(obj.a, obj.b)

from StructReader import CompileStruct, ParseStruct

class Example:
    a = UInt[16]
    b = UInt[16]

myStruct = CompileStruct(Example)
obj = ParseStruct(myStruct, b"\x00\x01\x00\x02")
print(obj.a, obj.b)

---

17. Summary

StructReader focuses on binary format parsing through a declarative, structure‑first approach.

By separating format description from byte reading logic, it allows complex binary layouts to be expressed clearly, maintained easily, and extended safely.

StructReader is especially suitable for projects involving:

• Complex or nested binary formats
• Field‑dependent layouts
• Conditional and dynamic parsing