Django SortedM2M 技术文档

1. 安装指南

安装依赖

django-sortedm2m 支持 Python 3.6 及以上版本，并且兼容多个 Django 版本。请确保你的开发环境满足以下要求：

• Python 3.6 或更高版本
• Django 2.2 或更高版本

安装步骤

你可以通过 pip 来安装 django-sortedm2m：

pip install django-sortedm2m

安装完成后，确保在 Django 项目的 INSTALLED_APPS 中添加 sortedm2m：

INSTALLED_APPS = [
    ...
    'sortedm2m',
    ...
]

2. 项目的使用说明

使用场景

django-sortedm2m 是一个用于替换 Django 自带的 ManyToManyField 的字段，它允许你在多对多关系中保持添加关系的顺序。

例如，假设你有一个画廊模型和一个照片模型，通常你会希望在这两个模型之间建立多对多关系，以便可以将多张照片添加到一个画廊中，同时也可以将同一张照片添加到多个画廊中。然而，Django 默认的多对多关系不提供排序功能，这通常会导致照片在画廊中随机排序。

通过使用 SortedManyToManyField，你可以轻松解决这个问题，保持照片在画廊中的顺序。

示例代码

以下是一个简单的示例，展示了如何在模型中使用 SortedManyToManyField：

from django.db import models
from sortedm2m.fields import SortedManyToManyField

class Photo(models.Model):
    name = models.CharField(max_length=50)
    image = models.ImageField(upload_to='photos/')

class Gallery(models.Model):
    name = models.CharField(max_length=50)
    photos = SortedManyToManyField(Photo)

在这个例子中，Gallery 模型中的 photos 字段是一个 SortedManyToManyField，它将保持添加照片的顺序。

3. 项目API使用文档

SortedManyToManyField 参数

sorted

• 默认值: True
• 说明: 如果设置为 False，SortedManyToManyField 将表现得像 Django 的原始 ManyToManyField，不会进行排序。

sort_value_field_name

• 默认值: 'sort_value'
• 说明: 指定中间表中用于排序的字段名称。你可以根据需要更改此名称。

base_class

• 默认值: None
• 说明: 你可以设置 base_class，它是排序多对多关系中间模型的基类。你可以使用它来添加额外的字段或方法。

迁移 ManyToManyField 到 SortedManyToManyField

如果你已经有一个 ManyToManyField，并希望将其迁移为 SortedManyToManyField，可以按照以下步骤操作：

1. 在模型中将 ManyToManyField 替换为 SortedManyToManyField。
2. 运行 python manage.py makemigrations 生成迁移文件。
3. 编辑生成的迁移文件，将 migrations.AlterField 替换为 sortedm2m.operations.AlterSortedManyToManyField。
4. 运行 python manage.py migrate 应用迁移。

4. 项目安装方式

通过 pip 安装

最简单的安装方式是通过 pip：

pip install django-sortedm2m

手动安装

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

git clone https://github.com/jazzband/django-sortedm2m.git
cd django-sortedm2m
python setup.py install

安装完成后，确保在 Django 项目的 INSTALLED_APPS 中添加 sortedm2m。

5. 管理界面中的使用

在 Django Admin 中使用

SortedManyToManyField 提供了一个自定义的拖拽排序小部件，可以在 Django Admin 中使用。要启用此功能，请确保在 INSTALLED_APPS 中添加 sortedm2m，并在 ModelAdmin 中避免使用 filter_horizontal 或 filter_vertical。

from django.contrib import admin

class GalleryAdmin(admin.ModelAdmin):
    raw_id_fields = ('photos',)

这样，你就可以在 Django Admin 中通过拖拽来排序多对多关系中的项目。

6. 贡献指南

django-sortedm2m 是一个开源项目，欢迎贡献代码。你可以通过以下步骤参与开发：

1. 克隆仓库：

   git clone https://github.com/jazzband/django-sortedm2m.git
   

2. 安装开发依赖：

   pip install -r requirements-dev.txt
   

3. 运行测试：

   tox
   

请遵循 Jazzband 的贡献指南和行为准则。

7. 代码质量

该项目使用 isort、pycodestyle 和 pylint 来管理代码质量。你可以通过以下命令运行代码质量检查：

tox -e quality

---

通过以上文档，你应该能够顺利安装和使用 django-sortedm2m，并在 Django 项目中实现多对多关系的排序功能。