Skip to main content

No project description provided

Project description



Python 3.6 PyPI version Build Status

wick is a Python command line tool that automatically generates file I/O source code for working with binary data.


I was working on a project that involved reverse engineering file formats and I found that most data structures tend to be composed of several simpler data structures. I also noticed that the simpler structures were all very boilerplate. So I created this tool to write the simple structures for me, and I can do the more interesting work of composing them into the larger structure.

Supported Target Languages

  • C#
  • Python


$ pip install wick


$ wick example.h Python

What exactly does it do?

Let's walk through a concrete example.

Say we have binary data that is a sequence of records that are represented by a string name and an integer id. First we create a record.h file that contains a C struct representation of this data:

// record.h

// Simple Record
struct Record {
    // Record name
    char name[64];

    // Record id.
    unsigned char id;

Then we run wick on the file:

$ wick record.h Python

Which will then create a file whose contents look like:

import struct

class Record:
    """Simple Record object

        name: Record name

        id: Record id.

    format = '<64sB'
    size = struct.calcsize(format)

    __slots__ = (

    def __init__(self,
                 id): = name.split(b'\x00')[0].decode('ascii') if type(name) is bytes else name = id

    def write(cls, file, record):
        record_data = struct.pack(cls.format,


    def read(cls, file):
        record_data =
        record_struct = struct.unpack(cls.format, record_data)

        return Record(*record_struct)

Then we can import this code into Python and do work.

Read Data

with open(path, 'rb') as file:
    rec =

Write Data

with open(path, 'wb') as file:
    rec = Record(b'name', 0)
    Record.write(file, rec)

Unpack Lots of Data

import struct

# Assuming the file only contains Record data
with open(path, 'rb') as file:
    recs = [Record(*chunk) for chunk in struct.iter_unpack(Record.format,]


Have a bug fix or a new feature you'd like to see in wick? Send it our way! Please make sure you create an issue that addresses your fix/feature so we can discuss the contribution.

  1. Fork this repo!
  2. Create your feature branch: git checkout -b features/add-javascript-code-generator
  3. Commit your changes: git commit -m 'Implemented Javascript code generator'
  4. Push the branch: git push origin add-javascript-code-generator
  5. Submit a pull request.
  6. Create an issue.



See the license document for the full text.

Project details

Download files

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

Source Distribution

wick-1.0.1.tar.gz (18.3 kB view hashes)

Uploaded Source

Supported by

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