134 lines
4.9 KiB
Plaintext
134 lines
4.9 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: bitstring
|
|
Version: 4.2.3
|
|
Summary: Simple construction, analysis and modification of binary data.
|
|
Author-email: Scott Griffiths <dr.scottgriffiths@gmail.com>
|
|
Project-URL: homepage, https://github.com/scott-griffiths/bitstring
|
|
Project-URL: documentation, https://bitstring.readthedocs.io/
|
|
Keywords: binary,bitarray,bitvector,bitfield
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Requires-Python: >=3.8
|
|
Description-Content-Type: text/markdown
|
|
License-File: LICENSE
|
|
Requires-Dist: bitarray <3.0.0,>=2.9.0
|
|
|
|
|
|
|
|
|
|
|
|
**bitstring** is a Python module to help make the creation and analysis of all types of bit-level binary data as simple and efficient as possible.
|
|
|
|
It has been actively maintained since 2006.
|
|
|
|
|
|
|
|
[](https://github.com/scott-griffiths/bitstring/actions/workflows/ci.yml)
|
|
[](https://bitstring.readthedocs.io/en/latest/)
|
|
[](https://app.codacy.com/gh/scott-griffiths/bitstring/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
|
[](https://libraries.io/pypi/bitstring)
|
|
|
|
[](https://www.pepy.tech/projects/bitstring)
|
|
[](https://pypistats.org/packages/bitstring)
|
|
|
|
----
|
|
|
|
> [!NOTE]
|
|
> To see what been added, improved or fixed, and also to see what's coming in the next version, see the [release notes](https://github.com/scott-griffiths/bitstring/blob/main/release_notes.md).
|
|
|
|
|
|
# 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:
|
|
|
|
* [Overview](https://bitstring.readthedocs.io/en/stable/index.html)
|
|
* [Quick Reference](https://bitstring.readthedocs.io/en/stable/quick_reference.html)
|
|
* [Full Reference](https://bitstring.readthedocs.io/en/stable/reference.html)
|
|
|
|
There is also an introductory walkthrough notebook on [binder](https://mybinder.org/v2/gh/scott-griffiths/bitstring/main?labpath=doc%2Fwalkthrough.ipynb).
|
|
|
|
# Examples
|
|
|
|
### Installation
|
|
```
|
|
$ pip install bitstring
|
|
```
|
|
|
|
### Creation
|
|
```pycon
|
|
>>> 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
|
|
```pycon
|
|
>>> 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
|
|
```pycon
|
|
>>> 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
|
|
```pycon
|
|
>>> 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
|
|
```pycon
|
|
>>> 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])
|
|
```
|
|
|
|
|
|
<sub>Copyright (c) 2006 - 2024 Scott Griffiths</sub>
|