This package provides a GUI (based on wxPython) for 'construct', which is a powerful declarative and symmetrical parser and builder for binary data. It can either be used standalone or embedded as a widget in another application.

Features:

• show documentation as tooltip
• different editors for:
  • Integer values
  • Enum values
  • FlagsEnum values
  • DateTime values
• undo/redo in HexEditor and in ConstructEditor
• extensible for custom constructs

The preferred way to installation is via PyPI:

pip install construct-editor

This project uses uv as a project management tool. To set up your development environment, run the following command:

uv sync

To run the unit tests, run:

uv run poe test

To run the linter/code formatter (including auto fix), run:

uv run poe lint

To run all supported type checkers (currently mypy, pyright and ty), run:

uv run poe typecheck

To run unit tests, linter/code formatter and type checkers, run:

uv run poe check-all

To start the standalone version, just execute the following in the command line:

construct-editor

This is a simple example

import wx
import construct as cs
from construct_editor.wx_widgets import WxConstructHexEditor

constr = cs.Struct(
    "a" / cs.Int16sb,
    "b" / cs.Int16sb,
)
b = bytes([0x12, 0x34, 0x56, 0x78])

app = wx.App(False)
frame = wx.Frame(None, title="Construct Hex Editor", size=(1000, 200))
editor_panel = WxConstructHexEditor(frame, construct=constr, binary=b)
editor_panel.construct_editor.expand_all()
frame.Show(True)
app.MainLoop()

This snipped generates a GUI like this:

This is the main widget ot this library. It offers a look at the raw binary data and also at the parsed structure. It offers a way to modify the raw binary data, which is then automaticly converted to the structed view. It also supports to modify the structed data and build the binary data from it.

This is just the right side of the ConstructHexEditor, but can be used also used as standalone widget. It provides:

• Viewing the structure of a construct (without binary data)
• Parsing binary data according to the construct

Just the left side of the ConstructHexEditor, but can be used also used as standalone widget. It provides:

• Viewing Bytes in a Hexadecimal form
• Callbacks when some value changed
• Changeable format via TableFormat