Django: Basic Models Behaviors
Tiny app to provide basic behaviors for django models, like:
- Timestampable
- Publishable
- SoftDeletable
- Cacheable
Installation
From PyPI:
$ pip install django-basic-models-behaviors
Usage
PublishableModel
Here is an example of Article using PublishableModel:
from basic_models_behaviors import models as behaviors
from django.db import models
class Article(behaviors.PublishableModel):
title = models.CharField(max_length=255)
contents = models.TextField()Then:
>>> article = Article(title='Foo', contents='Lorem lipsum')
>>> article.publish()
>>> article.is_published()
True
>>> article.unpublish()
>>> article.is_published()
False
>>> article.is_not_published()
TrueSoftDeletableModel
SoftDeletableModel behavior will add deleted_at field in set the current timestamp instead of delete the object. force_delete() will actually delete the model.
In your models.py:
from basic_models_behaviors import models as behaviors
from django.db import models
class Article(behaviors.SoftDeletableModel):
title = models.CharField(max_length=255)
contents = models.TextField()Then:
>>> from models import Article
>>> article = Article(title='foo', contents='Lorem lipsum')
>>> article.delete()
>>> article.has_been_deleted()
True
>>> article.undelete()
>>> article.has_been_deleted()
False
>>> article.force_delete()Tests
Run tests:
$ pip install -r tests/requirements.txt $ py.test --ds=tests.settings tests
Authors
- @wo0dyn • Nicolas Dubois <nicolas.c.dubois@gmail.com>
