No project description provided
Project description
wick
wick is a Python command line tool that generates file I/O source code for working with binary data.
Installation
$ pip install wick
Usage
$ wick common.h --language=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. We can write a simple 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 --language=python
Which will then emit:
import struct
class Record:
"""Simple Record
Attributes:
name: Record name
id: Record id.
"""
format = '<64sB'
size = struct.calcsize(format)
slots = (
'name',
'id'
)
def __init__(self,
name,
id):
self.name = name
self.id = id
@classmethod
def write(cls, file, record):
record_data = struct.pack(cls.format,
record.name,
record.id)
file.write(record_data)
@classmethod
def read(cls, file):
record_data = file.read(cls.size)
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 = Record.read(file)
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, file.read())]
Contributing
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.
- Fork this repo!
- Create your feature branch:
git checkout -b features/add-javascript-code-generator
- Commit your changes:
git commit -m 'Implemented Javascript code generator'
- Push the branch:
git push origin add-javascript-code-generator
- Submit a pull request.
- Create an issue.
License
MIT
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.