Skip to main content

A powerful declarative parser/builder for binary data

Project description

Construct is a powerful declarative parser (and builder) for binary data.

Instead of writing imperative code to parse a piece of data, you declaratively define a data structure that describes your data. As this data structure is not code, you can use it in one direction to parse data into Pythonic objects, and in the other direction, convert (“build”) objects into binary data.

The library provides both simple, atomic constructs (such as integers of various sizes), as well as composite ones which allow you form hierarchical structures of increasing complexity. Construct features bit and byte granularity, easy debugging and testing, an easy-to-extend subclass system, and lots of primitive constructs to make your work easier:

  • Fields: raw bytes or numerical types

  • Structs and Sequences: combine simpler constructs into more complex ones

  • Adapters: change how data is represented

  • Arrays/Ranges: duplicate constructs

  • Meta-constructs: use the context (history) to compute the size of data

  • If/Switch: branch the computational path based on the context

  • On-demand (lazy) parsing: read only what you require

  • Pointers: jump from here to there in the data stream

Example

A PascalString is a string prefixed by its length:

>>> from construct import *
>>>
>>> PascalString = Struct("PascalString",
...     UBInt8("length"),
...     Bytes("data", lambda ctx: ctx.length),
... )
>>>
>>> PascalString.parse("\x05helloXXX")
Container({'length': 5, 'data': 'hello'})
>>> PascalString.build(Container(length = 6, data = "foobar"))
'\x06foobar'

Instead of specifying the length manually, let’s use an adapter:

>>> PascalString2 = ExprAdapter(PascalString,
...     encoder = lambda obj, ctx: Container(length = len(obj), data = obj),
...     decoder = lambda obj, ctx: obj.data
... )
>>> PascalString2.parse("\x05hello")
'hello'
>>> PascalString2.build("i'm a long string")
"\x11i'm a long string"

See more examples of file formats and network protocols in the repository.

Resources

Construct’s homepage is http://construct.readthedocs.org, where you can find all kinds of docs and resources. The library itself is developed on github; please use github issues to report bugs, and github pull-requests to send in patches. For general discussion or questions, please use the new discussion group.

Requirements

Construct should run on any Python 2.5-3.3 implementation.

Its only requirement is six, which is used to overcome the differences between Python 2 and 3.

Project details


Release history Release notifications | RSS feed

This version

2.5.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

construct-2.5.1.zip (75.9 kB view details)

Uploaded Source

construct-2.5.1.tar.gz (56.3 kB view details)

Uploaded Source

Built Distribution

construct-2.5.1.win32.exe (269.7 kB view details)

Uploaded Source

File details

Details for the file construct-2.5.1.zip.

File metadata

  • Download URL: construct-2.5.1.zip
  • Upload date:
  • Size: 75.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for construct-2.5.1.zip
Algorithm Hash digest
SHA256 9d123b2590a5645385cf881f25960a2e2a262337e4697dfdbcac4b4496da44b3
MD5 4616eb3c12e86ba859ff2ed2f01ddb1c
BLAKE2b-256 30fb555abffe84e89c0a464809ba3fd49a0af1d64e58d507b69709259045b939

See more details on using hashes here.

File details

Details for the file construct-2.5.1.tar.gz.

File metadata

  • Download URL: construct-2.5.1.tar.gz
  • Upload date:
  • Size: 56.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for construct-2.5.1.tar.gz
Algorithm Hash digest
SHA256 5ae387cfde856f9ce3b1f4b1fc58750b6dc30994d96bde2517cfe47d10d51323
MD5 4881ed2208f6ee226b61e2310f696924
BLAKE2b-256 a30c228d95226ee8a09ee6e3ba329008286612628dfac3bea4ab33cadb189256

See more details on using hashes here.

File details

Details for the file construct-2.5.1.win32.exe.

File metadata

File hashes

Hashes for construct-2.5.1.win32.exe
Algorithm Hash digest
SHA256 14eee8ff1d30bc75b8024796693ec8bc25a61b3323f6bfd4c0768f08acae19df
MD5 99d8062dd1035b59ae523e8001cbfdd7
BLAKE2b-256 7be3b622c56268b6f458e5f8f19b70025ce520fc56be5c14881742e7eadce74d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page