A django field to make it easy to order your model instances. If you have made an ordered list and you change the position of the list item instance then all the other list iteminstances belonging to that list has their position automatically updated to keep the list ordered without holes and list items with duplicate positions.
OrderedField field is a global ordering field for the entire table.
OrderedCollectionField order instances with respect to one or more other fields on the instance.
- python>=3.6 (Probably works with all python 3 versions, but not guaranteed)
The full documentation is at https://django-ordered-field.readthedocs.io.
pip install git+https://github.com/kimgea/django-ordered-field.git
In your models.py add the field you want
from django_ordered_field import OrderedField class YourModel(models.Model): name = models.CharField(max_length=100) order = OrderedField()
And your ready to go.
OrderedFieldwill keep correct ordering between all instances in the enire table
OrderedCollectionFieldcan seperate the table in different collection based on one or more columns and keep order in each collection
update_auto_nowwill update all other fields containing auto_now=True with django.utils.timezone.now if it is set to True
extra_field_updatescan be used to update other fields when their order is changed
self_updates_on_collection_changecan be used to update self (current instance) when it changes collection. Setting
self_updates_on_collection_change_like_regularto True will make it use the values from the extra_field_updates
- Must user model.save(). queryset methods does not work
- Order field cant be unique or in an uniqu_togheter constraint
- After a position has been updated, other members of the collection are updated using a single SQL UPDATE statement, this means the save method of the other instances won't be called. As a partial work-around use the
Based on django-positions (it did not work for django 2 at the time):
Tools used in rendering this package: