Django Dirty Fields 技术文档

1. 安装指南

安装方式

要安装 django-dirtyfields，您可以使用 pip 命令：

pip install django-dirtyfields

兼容性

django-dirtyfields 兼容以下版本的 Python 和 Django：

Django 版本	Python 版本
2.2, 3.0, 3.1	3.8, 3.9
3.2, 4.0	3.8, 3.9, 3.10
4.1	3.8, 3.9, 3.10, 3.11
4.2	3.8, 3.9, 3.10, 3.11, 3.12
5.0, 5.1	3.10, 3.11, 3.12

2. 项目的使用说明

使用步骤

1. 继承 DirtyFieldsMixin：在您想要跟踪的 Django 模型中继承 DirtyFieldsMixin。

   from django.db import models
   from dirtyfields import DirtyFieldsMixin
   
   class ExampleModel(DirtyFieldsMixin, models.Model):
       """A simple example model to test dirty fields mixin with"""
       boolean = models.BooleanField(default=True)
       characters = models.CharField(blank=True, max_length=80)
   

2. 检查实例是否为脏数据：使用 is_dirty() 函数检查模型实例是否为脏数据。

3. 获取脏字段：使用 get_dirty_fields() 函数获取脏字段及其原始值。

示例

>>> model = ExampleModel.objects.create(boolean=True, characters="first value")
>>> model.is_dirty()
False
>>> model.get_dirty_fields()
{}

>>> model.boolean = False
>>> model.characters = "second value"

>>> model.is_dirty()
True
>>> model.get_dirty_fields()
{'boolean': True, 'characters': 'first value'}

3. 项目API使用文档

DirtyFieldsMixin

DirtyFieldsMixin 是一个用于跟踪 Django 模型实例中脏字段的 mixin。脏字段指的是内存中的值与数据库中的值不同的字段。

方法

• is_dirty()：返回一个布尔值，表示模型实例是否为脏数据。
• get_dirty_fields()：返回一个字典，包含所有脏字段及其原始值。

示例

>>> model = ExampleModel.objects.create(boolean=True, characters="first value")
>>> model.is_dirty()
False
>>> model.get_dirty_fields()
{}

>>> model.boolean = False
>>> model.characters = "second value"

>>> model.is_dirty()
True
>>> model.get_dirty_fields()
{'boolean': True, 'characters': 'first value'}

4. 项目安装方式

使用 pip 安装

pip install django-dirtyfields

手动安装

您也可以从 GitHub 仓库下载源代码并手动安装：

git clone https://github.com/romgar/django-dirtyfields.git
cd django-dirtyfields
python setup.py install

通过以上步骤，您可以成功安装并使用 django-dirtyfields 来跟踪 Django 模型实例中的脏字段。