django-field-history 0.8.0

文档

完整文档位于 https://django-field-history.readthedocs.io。

功能

• 保留特定模型字段所有更改的历史记录。

• 存储字段的名称、值、更改日期和时间以及更改用户。

• 与所有模型字段类型（除ManyToManyField外）兼容。

快速入门

安装 django-field-history

pip install django-field-history

确保将其放在 INSTALLED_APPS 中。

INSTALLED_APPS = [
    # other apps...
    'field_history',
]

然后将它添加到您的模型中。

from field_history.tracker import FieldHistoryTracker

class PizzaOrder(models.Model):
    STATUS_CHOICES = (
        ('ORDERED', 'Ordered'),
        ('COOKING', 'Cooking'),
        ('COMPLETE', 'Complete'),
    )
    status = models.CharField(max_length=64, choices=STATUS_CHOICES)

    field_history = FieldHistoryTracker(['status'])

现在每次您更改订单的状态字段时，该更改的信息都将存储在数据库中。

from field_history.models import FieldHistory

# No FieldHistory objects yet
assert FieldHistory.objects.count() == 0

# Creating an object will make one
pizza_order = PizzaOrder.objects.create(status='ORDERED')
assert FieldHistory.objects.count() == 1

# This object has some fields on it
history = FieldHistory.objects.get()
assert history.object == pizza_order
assert history.field_name == 'status'
assert history.field_value == 'ORDERED'
assert history.date_created is not None

# You can query FieldHistory using the get_{field_name}_history()
# method added to your model
histories = pizza_order.get_status_history()
assert list(FieldHistory.objects.all()) == list(histories)

# Or using the custom FieldHistory manager
histories2 = FieldHistory.objects.get_for_model_and_field(pizza_order, 'status')
assert list(histories) == list(histories2)

# Updating that particular field creates a new FieldHistory
pizza_order.status = 'COOKING'
pizza_order.save()
assert FieldHistory.objects.count() == 2

updated_history = histories.latest()
assert updated_history.object == pizza_order
assert updated_history.field_name == 'status'
assert updated_history.field_value == 'COOKING'
assert updated_history.date_created is not None

管理命令

django-field-history附带一些管理命令。

python manage.py createinitialfieldhistory

python manage.py renamefieldhistory --model=app_label.model_name --from_field=old_field_name --to_field=new_field_name

class Person(models.Model):
    username = models.CharField(max_length=255)

    field_history = FieldHistoryTracker(['username'])

class Person(models.Model):
    handle = models.CharField(max_length=255)

    field_history = FieldHistoryTracker(['handle'])

python manage.py renamefieldhistory --model=myapp.Person --from_field=username --to_field=handle

存储更改字段的用户

有两种方法可以存储更改模型字段的用户。最简单的方法是使用发起请求的已登录用户。为此，将FieldHistoryMiddleware类添加到您的MIDDLEWARE设置中。

MIDDLEWARE = [
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'field_history.middleware.FieldHistoryMiddleware',
]

或者，您可以在具有您跟踪的字段的模型中添加一个_field_history_user属性。此属性应在您的字段更新时返回要存储在FieldHistory中的用户。

class Pizza(models.Model):
    name = models.CharField(max_length=255)
    updated_by = models.ForeignKey('auth.User')

    field_history = FieldHistoryTracker(['name'])

    @property
    def _field_history_user(self):
        return self.updated_by

与MySQL协作

如果您使用MySQL，则在运行迁移时默认配置将抛出异常。（默认情况下，FieldHistory.object_id实现为TextField以提供灵活性，但MySQL InnoDB表中的索引列最大为767字节。）要修复此问题，您可以在settings.py中将FIELD_HISTORY_OBJECT_ID_TYPE设置为覆盖默认字段类型，以使用满足MySQL约束的类型。 FIELD_HISTORY_OBJECT_ID_TYPE可以设置为以下之一

1. 您希望使用的Django模型字段类，或者

2. 一个元组 (field_class, kwargs)，其中field_class是Django模型字段类，kwargs是要传递给字段类构造函数的参数字典。

为了在MySQL中使用与Postgres相似的默认行为配置object_id以使用CharField，请将以下内容添加到settings.py中

from django.db import models
FIELD_HISTORY_OBJECT_ID_TYPE = (models.CharField, {'max_length': 100})

FIELD_HISTORY_OBJECT_ID_TYPE还允许您使用更适用于您用例的字段类型，即使您使用Postgres（或类似的无约束数据库）。例如，如果您始终允许Django自动创建一个id字段（内部实现为AutoField），将FIELD_HISTORY_OBJECT_ID_TYPE设置为IntegerField将导致效率提升（时间和空间）。这看起来像

from django.db import models
FIELD_HISTORY_OBJECT_ID_TYPE = models.IntegerField

运行测试

代码实际上工作吗？

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements-test.txt
(myenv) $ python runtests.py

历史