bitstring is a Python module to help make the creation and analysis of binary data as simple and efficient as possible.
It has been maintained since 2006 and now has many millions of downloads per year.
News
November 2023: bitstring 4.1.3 released. Version 4.1 is a large update in terms of how much of the code has changed.
- Speed increased with bitarray dependency.
- New Array class for homogeneous data.
- Support for 8-bit floating point values.
See the release notes for details. Please let me know if you encounter any problems.
Overview
- Efficiently store and manipulate binary data in idiomatic Python.
- Create bitstrings from hex, octal, binary, files, formatted strings, bytes, integers and floats of different endiannesses.
- Powerful binary packing and unpacking functions.
- Bit-level slicing, joining, searching, replacing and more.
- Create and manipulate arrays of fixed-length bitstrings.
- Read from and interpret bitstrings as streams of binary data.
- Rich API - chances are that whatever you want to do there's a simple and elegant way of doing it.
- Open source software, released under the MIT licence.
Documentation
Extensive documentation for the bitstring module is available. Some starting points are given below:
You can also try out the interactive walkthrough notebook on binder.
Release Notes
To see what been added, improved or fixed, and also to see what's coming in the next version, see the release notes.
Examples
Installation
$ pip install bitstring
Creation
>>> from bitstring import Bits, BitArray, BitStream, pack
>>> a = BitArray(bin='00101')
>>> b = Bits(a_file_object)
>>> c = BitArray('0xff, 0b101, 0o65, uint6=22')
>>> d = pack('intle16, hex=a, 0b1', 100, a='0x34f')
>>> e = pack('<16h', *range(16))
Different interpretations, slicing and concatenation
>>> a = BitArray('0x3348')
>>> a.hex, a.bin, a.uint, a.float, a.bytes
('3348', '0011001101001000', 13128, 0.2275390625, b'3H')
>>> a[10:3:-1].bin
'0101100'
>>> '0b100' + 3*a
BitArray('0x866906690669, 0b000')
Reading data sequentially
>>> b = BitStream('0x160120f')
>>> b.read(12).hex
'160'
>>> b.pos = 0
>>> b.read('uint12')
352
>>> b.readlist('uint12, bin3')
[288, '111']
Searching, inserting and deleting
>>> c = BitArray('0b00010010010010001111') # c.hex == '0x1248f'
>>> c.find('0x48')
(8,)
>>> c.replace('0b001', '0xabc')
>>> c.insert('0b0000', pos=3)
>>> del c[12:16]
Arrays of fixed-length formats
>>> from bitstring import Array
>>> a = Array('uint7', [9, 100, 3, 1])
>>> a.data
BitArray('0x1390181')
>>> a[::2] *= 5
>>> a
Array('uint7', [45, 100, 15, 1])
Unit Tests
The 700+ unit tests should all pass. They can be run from the root of the project with
python -m unittest
Credits
Created by Scott Griffiths in 2006 to help with ad hoc parsing and creation of compressed video files. Maintained and expanded ever since as it became unexpectedly popular. Thanks to all those who have contributed ideas and code (and bug reports) over the years.
Copyright (c) 2006 - 2023 Scott Griffiths
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bitstring-4.1.3.tar.gz.
File metadata
- Download URL: bitstring-4.1.3.tar.gz
- Upload date:
- Size: 231.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.1 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1b47c84644a961ba8503db2bba8a5965ab53e81474becdf0a18383b5b5f3f795
|
|
| MD5 |
6b93b4eb3d2b0f25582fbbc5cbd0a0f5
|
|
| BLAKE2b-256 |
c1f630459981d5c8f04b6b4c1d8f006e36ffe4be2bff060ba9291c3503356dd3
|
File details
Details for the file bitstring-4.1.3-py3-none-any.whl.
File metadata
- Download URL: bitstring-4.1.3-py3-none-any.whl
- Upload date:
- Size: 60.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.1 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5619b9d6a4939717962b0fecb0034ad30277606b8b0bcce3f7cd6ac2400f6427
|
|
| MD5 |
373ec3eb6086bdd337dd8722d5f533b2
|
|
| BLAKE2b-256 |
6434901737226e0f48972e43c8ef23820a1195b14a8e9dbdf46bc5b8035c43b1
|
