bitstruct

About

This module is intended to have a similar interface as the python struct module, but working on bits instead of primitive data types (char, int, …).

Documentation: http://bitstruct.readthedocs.org/en/latest

Installation

pip install bitstruct

Example usage

See the test suite: https://github.com/eerimoq/bitstruct/blob/master/tests/test_bitstruct.py

A basic example of packing/unpacking four integers:

>>> from bitstruct import *
>>> pack('u1u3u4s16', 1, 2, 3, -4)
bytearray(b'\xa3\xff\xfc')
>>> unpack('u1u3u4s16', bytearray(b'\xa3\xff\xfc'))
(1, 2, 3, -4)
>>> calcsize('u1u3u4s16')
24

The unpacked fields can be named by assigning them to variables or by wrapping the result in a named tuple:

>>> from bitstruct import *
>>> from collections import namedtuple
>>> MyName = namedtuple('myname', [ 'a', 'b', 'c', 'd' ])
>>> unpacked = unpack('u1u3u4s16', bytearray(b'\xa3\xff\xfc'))
>>> myname = MyName(*unpacked)
>>> myname
myname(a=1, b=2, c=3, d=-4)
>>> myname.c
3

An example of packing/unpacking a unsinged integer, a signed integer, a float, a boolean and a bytearray:

>>> from bitstruct import *
>>> pack('u5s5f32b1r13', 1, -1, 3.75, True, bytearray(b'\xff\xff'))
bytearray(b'\x0f\xd0\x1c\x00\x00?\xff')
>>> unpack('u5s5f32b1r13', bytearray(b'\x0f\xd0\x1c\x00\x00?\xff'))
(1, -1, 3.75, True, bytearray(b'\xff\xf8'))
>>> calcsize('u5s5f32b1r13')
56

The same format and values as in the previous example, but using LSB (Least Significant Bit) first instead of the default MSB (Most Significant Bit) first:

>>> from bitstruct import *
>>> pack('<u5s5f32b1r13', 1, -1, 3.75, True, bytearray(b'\xff\xff'))
bytearray(b'\x87\xc0\x00\x03\x80\xbf\xff')
>>> unpack('<u5s5f32b1r13', bytearray(b'\x87\xc0\x00\x03\x80\xbf\xff'))
(1, -1, 3.75, True, bytearray(b'\xff\xf8'))
>>> calcsize('<u5s5f32b1r13')
56

An example of unpacking values from a hexstring and a binary file:

>>> from bitstruct import *
>>> unpack('s17s13r24', bytearray('0123456789abcdef'.decode('hex')))
(582, -3751, bytearray(b'\xe2j\xf3'))
>>> with open("test.bin", "rb") as fin:
...     unpack('s17s13r24', bytearray(fin.read(8)))
...
...
(582, -3751, bytearray(b'\xe2j\xf3'))

Change endianness of the data with byteswap(), and then unpack the values:

>>> from bitstruct import *
>>> packed = pack('u1u3u4s16', 1, 2, 3, 1)
>>> unpack('u1u3u4s16', byteswap('12', packed))
(1, 2, 3, 256)

Release files for bitstruct 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for bitstruct 3.0.0
File	Interpreter	ABI	Platform	Reset
bitstruct-3.0.0-py2.py3-none-any.whl 6.1 kB Mar 28, 2016	Python 2, Python 3	none	any	Details

Release files / bitstruct-3.0.0-py2.py3-none-any.whl

Download URL	bitstruct-3.0.0-py2.py3-none-any.whl
Size	6.1 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`fe08548c090c4b68aa7e9ba4dbba27d7cf66b116652ee299756ab7eea9d10cae`
BLAKE2b-256 checksum How to use checksums	`d42516d6687aee0492956c88eecd5cef058bd1a825734d97feb6629faa56c0b7`
Upload date	Mar 28, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No