Automatically manage bitfields in django models
Project description
Your project description goes here
Quickstart
Install bitfield_manager:
pip install django-bitfield-manager
Add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'bitfield_manager.apps.BitfieldManagerConfig',
...
)
Usage
First you’ll need a parent model with a status field
from django.db import models
from bitfield_manager.models import ParentBitfieldModel, ChildBitfieldModelMixin
class ParentExample(ParentBitfieldModel):
status = models.BigIntegerField()
def __str__(self): # __unicode__ on Python 2
return "status: %i" % self.status
Then for all models you want django-bitfield-manager to manage add the BitfieldMeta with a list of parent models. The list of parent models takes in a tuple. The first field is the name of the field on the child model that the bitfield-manager should use for modifying the status (should be a foreignkey, have not tested other relationships.) The second is the name of the BigIntegerField or BitField (if using django-bitfield) that you want modified. The 3rd field is the bitflag to use (i.e. 0 will be 1 << 0, 1 will be 1 << 1, etc.)
class ChildExample1(ChildBitfieldModelMixin, models.Model):
parent = models.ForeignKey('ParentExample', null=True)
class BitfieldMeta:
parent_models = [('parent', 'status', 0)]
class ChildExample2(ChildBitfieldModelMixin, models.Model):
parent = models.ForeignKey('ParentExample', null=True)
class BitfieldMeta:
parent_models = [('parent', 'status', 1)]
Now when creating/deleting child models the parent status should update
# create the model
p = ParentExample.objects.create(status=0)
p2 = ParentExample.objects.create(status=0)
# add a child p.status is now 1
c1 = ChildExample1.objects.create(parent=p)
# add the other child. p.status is now 3
c2 = ChildExample2.objects.create(parent=p)
# deleting a child will refresh the status. p.status is now 2
c1.delete()
# updates or mass deletes will require manual refresh
# p.status will be 2 and p2.status will be 0
ChildExample2.objects.filter(parent=p).update(parent=p2)
# trigger a manual refresh. p.status is now correct with a status of 0
p.force_status_refresh()
# if you know the related models modified you can specify them
# p2.status is now 2
p2.force_status_refresh(related_models=[ChildExample2])
# force status refresh will work with models multiple levels deep. Specify the search_depth to search
# more than 1 level deep
p2.force_status_refresh(search_depth=2)
Features
Allows for automatic bitfield management for Django Models.
Will update the status when models are added or deleted
Supports multi-level relationships (use dot syntax)
Supports django-bitfield
Running Tests
Does the code actually work?
source <YOURVIRTUALENV>/bin/activate (myenv) $ pip install tox (myenv) $ tox
Credits
Tools used in rendering this package:
History
0.2.0 (2017-01-27)
Added django-bitfield support
No longer uses signals
Added mixin for child models (ChildBitfieldModelMixin)
Added support for one-to-one and limited support for m2m fields
Added support for models multiple levels deep (using dot syntax)
0.1.0 (2017-01-18)
First release on PyPI.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for django-bitfield-manager-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39b192312193023f7d44a38fd1dc40bce732892192af4a4986f1113490241615 |
|
MD5 | 4539d147b3f8932bf0f19f39bb7e033f |
|
BLAKE2b-256 | 886d78f7ced4f7456491e225a0593bdb3ea91db6fec987c6efc29c4da7bc439e |