Skip to main content

A bit flag class for python

Project description

BitFlag

PyPi release

A simple bit flag class for Python ๐Ÿ.

Installation

$ pip install bitflag

Usage

# 1. import the "BitFlag" class.
from bitflag import BitFlag

# 2. initialize a BitFlag instance with any number of string, flag arguments.
bf = BitFlag("flagA", "flagB", "flagC")

# 3. run operations on those bit flags!

# set โ€“ Set one or more bit flags.
bf.set("flagB", "flagC")

# unset โ€“ Unset one or more bit flags.
bf.unset("flagB")

# has โ€“ Check if one or more bit flags have been set.
bf.has("flagC")

# toggle โ€“ Toggle one or more bit flags.
bf.toggle("flagA", "flagB", "flagC")

# reset โ€“ Reset (unset) all bit flags.
bf.reset()

# flip โ€“ Flip all bit flags.
bf.flip()

# keys - iterate over flag keys.
for k in bf.keys():
    print(k)

# values - iterate over flag values.
for v in bf.values():
    print(v)

# items - iterate over flag keys and values.
for k,v in bf.items():
    print(k, v)

# str - informal string representation.
str(bf)

# repr - formal string representation.
repr(bf)

# int - integer representation.
int(bf)

License

MIT ยฉ Travis Clarke

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bitflag, version 2.0.0
Filename, size File type Python version Upload date Hashes
Filename, size bitflag-2.0.0-py3-none-any.whl (3.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size bitflag-2.0.0.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page