Django Fixture Magic 使用与技术文档

1. 安装指南

环境要求

在开始安装前，请确保您的系统满足以下环境要求：

• Python 2.7 或 Python 3.6
• Django 版本在 1.8 到 2.1 之间

安装步骤

安装 Django Fixture Magic 最简单的方式是使用 pip 工具：

pip install django-fixture-magic

如果您需要安装开发版本的 Django Fixture Magic，可以使用以下命令：

pip install -e git://github.com/davedash/django-fixture-magic#egg=fixture-magic

对于 Python 3 用户，需要额外安装 future 包：

pip install future

安装完成后，需要在 Django 项目的 settings.py 文件中将 fixture_magic 添加到 INSTALLED_APPS 中：

INSTALLED_APPS = (
    ...
    'fixture_magic',
    ...
)

2. 项目的使用说明

Django Fixture Magic 提供了四个命令行工具来帮助您管理和使用 fixtures。

dump_object

dump_object 命令可以导出指定模型的 JSON 表示，包括所有依赖对象（通过外键定义）：

./manage.py dump_object APP.MODEL PK1 PK2 PK3 ... > my_new_fixture.json

或者，您可以传入一个查询参数来导出匹配的对象：

./manage.py dump_object APP.MODEL --query '{"pk__in": [PK1, PK2, PK3]}' > my_new_fixture.json

如果您想导出所有对象及其依赖，可以使用星号：

./manage.py dump_object APP.MODEL '*' > my_new_fixture.json

默认情况下，dump_object 会导出与模型相关联的 fixtures。如果您想禁用此功能，可以使用 --no-follow 选项。

merge_fixtures

merge_fixtures 命令用于合并多个 fixtures 文件，移除重复数据：

./manage.py merge_fixtures fixture1.json fixture2.json fixture3.json ... > all_my_fixtures.json

reorder_fixtures

reorder_fixtures 命令可以重新排序 fixtures 文件中的模型顺序，以避免外键错误：

./manage.py reorder_fixtures fixture.json APP1.MODEL1 APP2.MODEL2 ... > ordered_fixture.json

未指定的模型将被追加到文件末尾。

custom_dump

custom_dump 命令通过读取 CUSTOM_DUMPS 设置来导出模型数据，它允许您自定义导出哪些属性或方法：

CUSTOM_DUMPS = {
    'addon': {
        'primary': 'addons.addon',
        'dependents': [
            'current_version',
            'current_version.files.all.0',
        ],
        'order': ('app1.model1', 'app2.model2',),
        'order_cond': {
            'app1.model1': lambda x: 1 if x.get('fields').get('parent_model1') else 0,
            'app2.model2': lambda x: -1 * x.get('pk'),
        },
    }
}

然后使用以下命令来执行 custom_dump：

./manage.py custom_dump addon id

3. 项目API使用文档

Django Fixture Magic 的 API 使用主要是围绕上述命令行工具进行的。详细的 API 文档可以在官方 GitHub 仓库的 wiki 页面中找到。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，主要通过 pip 进行安装。如果需要安装特定版本或者开发版本，可以通过指定 GitHub 仓库地址来进行安装。