1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
django-bitfield
---------------
.. image:: https://secure.travis-ci.org/ahref/django-bitfield.png?branch=master
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!)
Requirements
============
* Django >= 1.2
Note: SQLite does not support save operations using a ``Bit`` (per the example under Usage)
Installation
============
Install it with pip (or easy_install)::
pip install django-bitfield
Usage
=====
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=(
'awesome_flag',
'flaggy_foo',
'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)
MyModel.objects.filter(pk=o.pk).update(flags=F('flags') | MyModel.flags.awesome_flag)
# Set flags manually to [awesome_flag, flaggy_foo]
MyModel.objects.filter(pk=o.pk).update(flags=MyModel.flags.awesome_flag | MyModel.flags.flaggy_foo)
# Remove awesome_flag (does not work in SQLite)
MyModel.objects.filter(pk=o.pk).update(flags=F('flags') & ~MyModel.flags.awesome_flag)
# Find by awesome_flag
MyModel.objects.filter(flags=MyModel.flags.awesome_flag)
# Exclude by awesome_flag
MyModel.objects.filter(flags=~MyModel.flags.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
Enjoy!
Admin
=====
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
|
