Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jnyjny/bitvector
Bit Vector for Humans™
https://github.com/jnyjny/bitvector
bit-manipulation bit-twiddling bit-vector for-humans internet-of-things iot python python3
Last synced: 2 months ago
JSON representation
Bit Vector for Humans™
- Host: GitHub
- URL: https://github.com/jnyjny/bitvector
- Owner: JnyJny
- License: apache-2.0
- Created: 2020-07-02T01:35:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-17T15:06:55.000Z (6 months ago)
- Last Synced: 2024-09-18T02:59:03.626Z (3 months ago)
- Topics: bit-manipulation, bit-twiddling, bit-vector, for-humans, internet-of-things, iot, python, python3
- Language: Python
- Homepage:
- Size: 75.2 KB
- Stars: 9
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![version][pypi-version]
![pytest][pytest-action]
![license][license]
![monthly-downloads][monthly-downloads]
![Code style: black][code-style-black]
# Bit Vectors For Humans™
This simple bit vector implementation aims to make addressing single
bits a little less fiddly. It can be used by itself to work with bit
fields in an integer word, but it really starts to shine when you use
the supplied `BitField` descriptor with a subclass of `BitVector`:
```python
> from bitvector import BitVector, BitField
>
> class IOTDeviceCommand(BitVector):
> def __init__(self):
> super().__init__(size=32)
>
> power = BitField(0, 1) # offset and size
> spin = BitField(1, 1)
> speed = BitField(2, 4)
> sense = BitField(6, 2)
> red = BitField(8, 8)
> blue = BitField(16, 8)
> green = BitField(24, 8)
>
> widget_cmd = IOTDeviceCommand()
> widget_cmd.power = 1
> widget_cmd.sense = 2
> widget_cmd.speed = 5
> widget_cmd.red = 0xaa
> widget_cmd.blue = 0xbb
> widget_cmd.green = 0xcc
> widget_cmd
IOTDeviceCommand(value=0xccbbaa95, size=32)
> widget_cmd.bytes
b'\xcc\xbb\xaa\x95'
```
## Installation
```console
$ python3 -m pip install bitvector-for-humans
$ pydoc bitvector
...
```
Or directly from github:
```console
$ pip install git+https://github.com/JnyJny/bitvector.git
```
## Motivations
1. Address sub-byte bits in a less error prone way.
2. Minimize subdependencies (zero is minimized right?).
3. Learn something about descriptors: ✅.
## Caveats
The tests need expanding and I got lazy when writing the multi-bit
setting / getting code and it could undoubtedly be improved. Pull
requests gladly accepted.
## Other Ways to Implement a Bit Vector
1. Python builtin `ctypes.Structure` allows sub-byte bit fields
2. Python builtin `struct` provides extensive support for byte manipulations
3. Python3 IntEnums can be used to build bit field masks
4. The plain `int` will serve admirably with bitwise operators
5. Provide cffi bindings to existing bit-twiddling libraries
6. Use Numpy bool arrays as the "backing store"
7. Other good ideas I overlooked, forgot about or just plain don't know.
[pytest-action]: https://github.com/JnyJny/bitvector/workflows/pytest/badge.svg
[code-style-black]: https://img.shields.io/badge/code%20style-black-000000.svg
[pypi-version]: https://img.shields.io/pypi/v/bitvector-for-humans
[license]: https://img.shields.io/pypi/l/bitvector-for-humans
[monthly-downloads]: https://img.shields.io/pypi/dm/bitvector-for-humans