Go to file
2022-08-02 18:11:51 -04:00
bitmask Initial style formatting 2022-08-02 18:11:51 -04:00
tests Initial style formatting 2022-08-02 18:11:51 -04:00
.gitignore Package bitmask using hatch 2022-07-31 19:35:09 -04:00
LICENSE Add LICENSE 2022-07-26 20:20:24 -04:00
pyproject.toml pyproject.toml: add flake8, black as dependencies 2022-08-02 18:09:53 -04:00
README.md Package bitmask using hatch 2022-07-31 19:35:09 -04:00

Bitmask

Implementation of a Bitmask class in Python, allowing easy manipulation of EnumFlag values.

Features

  • create bitmasks from any EnumFlag type

  • simple "flag in Bitmask" syntax

  • bitwise operations, e.g. AND (&), OR (|), XOR (^)

  • assignment with operators (+=, -=, &=, etc.)

  • convenience functions like Bitmask.add(), or Bitmask.discard()

For development and tinkering:

  • included unit tests

  • ample documentation and examples in code

Example usage

from bitmask import Bitmask
from enum import IntFlag

class Desc(IntFlag):
	SMALL = 1
	ROUND = 1 << 1
	FUNKY = 1 << 2
	LARGE = 1 << 3

marble = Bitmask(Desc, Desc.SMALL, Desc.ROUND, Desc.FUNKY)

Desc.SMALL in marble
>>> True

Desc.LARGE in marble
>>> False

Bitmask(Desc, Desc.SMALL, Desc.ROUND) in marble
>>> True