Skip to main content

BitField in Django

Project description

Provides a BitField like class (using a BigIntegerField) for your Django models.

(If you’re upgrading from a version before 1.2 the API has changed greatly and is backwards incompatible!)


  • Django >= 1.10
  • PostgreSQL (see notes)


  • SQLite does not support save operations using a Bit (per the example under Usage).
  • MySQL fails on most queries related to BitField’s.


Install it with pip (or easy_install):

pip install django-bitfield


First you’ll need to attach a BitField to your class. This acts as a BigIntegerField (BIGINT) in your database:

from bitfield import BitField

class MyModel(models.Model):
    flags = BitField(flags=(

Flags can also be defined with labels:

class MyModel(models.Model):
    flags = BitField(flags=(
        ('awesome_flag', 'Awesome Flag!'),
        ('flaggy_foo', 'Flaggy Foo'),
        ('baz_bar', 'Baz (bar)'),

Now you can use the field using very familiar Django operations:

# Create the model
o = MyModel.objects.create(flags=0)

# Add awesome_flag (does not work in SQLite)

# Set flags manually to [awesome_flag, flaggy_foo]
MyModel.objects.filter( | MyModel.flags.flaggy_foo)

# Remove awesome_flag (does not work in SQLite)

# Find by awesome_flag

# Exclude by awesome_flag

# Test awesome_flag
if o.flags.awesome_flag:
    print "Happy times!"

# List all flags on the field
for f in o.flags:
    print f

# Get a flag label
print o.flags.get_label('awesome_flag')



To use the widget in the admin, you’ll need to update your ModelAdmin. Add the following lines to your ModelAdmin:

formfield_overrides = {
        BitField: {'widget': BitFieldCheckboxSelectMultiple},

Make sure you’ve imported the classes by adding these lines to the top of the file:

from bitfield import BitField
from bitfield.forms import BitFieldCheckboxSelectMultiple

There is also a BitFieldListFilter list filter (Django 1.4 or newer). To use it set list_filter ModelAdmin option:

list_filter = (
        ('flags', BitFieldListFilter,)

BitFieldListFilter is in bitfield.admin module:

from bitfield.admin import BitFieldListFilter

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 django-gravy-bitfield, version 1.9.1
Filename, size File type Python version Upload date Hashes
Filename, size django-gravy-bitfield-1.9.1.tar.gz (16.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page