每天40分玩转Django：Django插件开发

Django插件开发

一、插件开发概述表

阶段	主要任务	技术要点	难度
准备工作	项目结构设计、环境配置	项目布局、setup.py	★★★☆☆
开发实现	功能开发、测试编写	Django AppConfig、Signals	★★★★☆
文档编写	API文档、使用说明	Markdown、reStructuredText	★★★☆☆
发布部署	PyPI打包、发布	setuptools、twine	★★★★☆

二、创建可重用Django应用

我们以一个通用的评论系统插件为例，演示如何创建可重用的Django应用。

2.1 项目结构

django-generic-comments/
├── LICENSE
├── MANIFEST.in
├── README.md
├── setup.py
├── generic_comments/
│   ├── __init__.py
│   ├── apps.py
│   ├── models.py
│   ├── views.py
│   ├── urls.py
│   ├── forms.py
│   ├── signals.py
│   ├── templates/
│   │   └── generic_comments/
│   │       ├── comment_form.html
│   │       └── comment_list.html
│   └── static/
│       └── generic_comments/
│           ├── css/
│           └── js/
└── tests/├── __init__.py├── test_models.py└── test_views.py

2.2 核心代码实现

# generic_comments/apps.py
from django.apps import AppConfigclass GenericCommentsConfig(AppConfig):name = 'generic_comments'verbose_name = 'Generic Comments'def ready(self):import generic_comments.signals

# generic_comments/models.py
from django.db import models
from django.conf import settings
from django.contrib.contenttypes.fields import GenericForeignKey
from django.contrib.contenttypes.models import ContentTypeclass Comment(models.Model):content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)object_id = models.PositiveIntegerField()content_object = GenericForeignKey('content_type', 'object_id')user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)content = models.TextField()created_at = models.DateTimeField(auto_now_add=True)updated_at = models.DateTimeField(auto_now=True)is_public = models.BooleanField(default=True)class Meta:ordering = ['-created_at']def __str__(self):return f'Comment by {self.user.username} on {self.content_object}'

# generic_comments/forms.py
from django import forms
from .models import Commentclass CommentForm(forms.ModelForm):class Meta:model = Commentfields = ['content']widgets = {'content': forms.Textarea(attrs={'rows': 4})}

# generic_comments/views.py
from django.shortcuts import redirect, get_object_or_404
from django.contrib.auth.decorators import login_required
from django.contrib.contenttypes.models import ContentType
from django.contrib import messages
from .forms import CommentForm
from .signals import comment_posted@login_required
def add_comment(request, content_type_id, object_id):content_type = get_object_or_404(ContentType, id=content_type_id)content_object = content_type.get_object_for_this_type(id=object_id)if request.method == 'POST':form = CommentForm(request.POST)if form.is_valid():comment = form.save(commit=False)comment.user = request.usercomment.content_type = content_typecomment.object_id = object_idcomment.save()# 触发评论发布信号comment_posted.send(sender=comment.__class__,comment=comment,request=request)messages.success(request, '评论已发布')return redirect(content_object.get_absolute_url())else:form = CommentForm()return render(request, 'generic_comments/comment_form.html', {'form': form,'content_object': content_object})

# generic_comments/signals.py
from django.dispatch import Signalcomment_posted = Signal()# 信号接收器示例
def notify_comment_posted(sender, comment, request, **kwargs):"""当评论发布时发送通知"""pass

2.3 配置文件

# setup.py
from setuptools import setup, find_packagessetup(name='django-generic-comments',version='0.1.0',packages=find_packages(exclude=['tests*']),include_package_data=True,license='MIT',description='A Django app for adding comments to any model',long_description=open('README.md').read(),long_description_content_type='text/markdown',url='https://github.com/yourusername/django-generic-comments',author='Your Name',author_email='your.email@example.com',classifiers=['Environment :: Web Environment','Framework :: Django','Framework :: Django :: 3.2','Intended Audience :: Developers','License :: OSI Approved :: MIT License','Operating System :: OS Independent','Programming Language :: Python','Programming Language :: Python :: 3','Programming Language :: Python :: 3.8','Topic :: Internet :: WWW/HTTP','Topic :: Internet :: WWW/HTTP :: Dynamic Content',],python_requires='>=3.8',install_requires=['Django>=3.2',],
)

# MANIFEST.in
include LICENSE
include README.md
recursive-include generic_comments/static *
recursive-include generic_comments/templates *
recursive-include docs *

三、应用开发流程图

在这里插入图片描述

四、测试用例编写

# tests/test_models.py
from django.test import TestCase
from django.contrib.auth import get_user_model
from django.contrib.contenttypes.models import ContentType
from generic_comments.models import CommentUser = get_user_model()class CommentModelTest(TestCase):def setUp(self):self.user = User.objects.create_user(username='testuser',email='test@example.com',password='testpass123')def test_comment_creation(self):comment = Comment.objects.create(user=self.user,content='Test comment',content_type=ContentType.objects.get_for_model(User),object_id=self.user.id)self.assertEqual(str(comment), f'Comment by testuser on {self.user}')self.assertTrue(comment.is_public)

# tests/test_views.py
from django.test import TestCase, Client
from django.urls import reverse
from django.contrib.auth import get_user_model
from django.contrib.contenttypes.models import ContentType
from generic_comments.models import CommentUser = get_user_model()class CommentViewsTest(TestCase):def setUp(self):self.client = Client()self.user = User.objects.create_user(username='testuser',password='testpass123')def test_add_comment(self):self.client.login(username='testuser', password='testpass123')content_type = ContentType.objects.get_for_model(User)response = self.client.post(reverse('generic_comments:add_comment', kwargs={'content_type_id': content_type.id,'object_id': self.user.id}),{'content': 'Test comment'})self.assertEqual(response.status_code, 302)self.assertEqual(Comment.objects.count(), 1)

五、文档编写

# Django Generic CommentsA reusable Django application for adding comments to any model.## Installation```bash
pip install django-generic-comments

Quick Start

Add “generic_comments” to your INSTALLED_APPS setting:

INSTALLED_APPS = [...'generic_comments',
]

Include the generic_comments URLconf in your project urls.py:

path('comments/', include('generic_comments.urls')),

Run migrations:

python manage.py migrate

Usage

To add comments to a model:

from django.contrib.contenttypes.fields import GenericRelation
from generic_comments.models import Commentclass YourModel(models.Model):comments = GenericRelation(Comment)


## 六、发布到PyPI### 6.1 打包准备1. 安装必要工具：
```bash
pip install setuptools wheel twine

创建分发包：

python setup.py sdist bdist_wheel

上传到PyPI：

twine upload dist/*

6.2 发布检查清单

代码质量检查：

# 运行测试
python runtests.py# 代码风格检查
flake8 generic_comments

文档完整性检查：

README.md 是否完整
使用说明是否清晰
API文档是否完整

版本号管理：

# generic_comments/__init__.py
VERSION = (0, 1, 0)
__version__ = '.'.join(map(str, VERSION))

七、使用示例

7.1 在项目中集成

# settings.py
INSTALLED_APPS = [...'generic_comments',
]# 可选配置
GENERIC_COMMENTS_CONFIG = {'moderate_comments': False,'email_notifications': True,
}# models.py
from django.db import models
from django.contrib.contenttypes.fields import GenericRelation
from generic_comments.models import Commentclass Article(models.Model):title = models.CharField(max_length=200)content = models.TextField()comments = GenericRelation(Comment)def get_absolute_url(self):return reverse('article_detail', args=[self.id])

7.2 模板使用

{% load generic_comments_tags %}<div class="comments">{% get_comment_list for article as comments %}{% for comment in comments %}<div class="comment"><div class="comment-user">{{ comment.user }}</div><div class="comment-content">{{ comment.content }}</div><div class="comment-date">{{ comment.created_at|date:"Y-m-d H:i" }}</div></div>{% endfor %}{% if user.is_authenticated %}{% get_comment_form for article as form %}<form method="post" action="{% url 'generic_comments:add_comment' content_type_id=content_type.id object_id=article.id %}">{% csrf_token %}{{ form.as_p }}<button type="submit">提交评论</button></form>{% endif %}
</div>