可扩展字段,使django应用程序能够将其数据存储在您的模型上。
django-appdata-mam的Python项目详细描述
可扩展字段和相关工具,使django应用程序能够扩展 可重复使用的应用程序。
重要提示
这个应用程序是原始Django appdata的分叉。 fork的创建是因为原始应用程序不能与最新版本的django一起正常工作,并且对pull请求的反应非常慢。 不过,如果可以的话,我建议您使用原始应用程序。
动机
在使用可重用的django应用程序时,我们经常发现需要添加 应用程序提供的模型或窗体之外的内容。一些应用试图解决 通过提供灵活的模型定义和可插入的形式(参见 django.contrib.comments作为这种方法的一个例子),但即使如此 导致一些重复的努力。
django appdataapp尝试,通过appdatafield,多种格式和appdatamodeladmin, 提供一个标准化的方法来扩展现有的应用程序。
扩展模型
当您使用appdatafield使用可扩展的django应用程序时:
from django.db import models from app_data import AppDataField class BlogPost(models.Model): text = models.TextField() app_data = AppDataField()
您的代码可以在任何(或所有)appdatafield上注册命名空间并存储 它通过注册一个container(的子类 appdatacontainer)。要定义使用django的表单框架的数据:
from django.forms.models import ModelMultipleChoiceField from app_data import app_registry, AppDataForm, AppDataContainer from .models import Tag class TaggingAppDataForm(AppDataForm): public_tags = ModelMultipleChoiceField(Tag.objects.all()) admin_tags = ModelMultipleChoiceField(Tag.objects.all()) class TaggingAppDataContainer(AppDataContainer): form_class = TaggingAppDataForm def tag_string(self): print ', '.join(t.name for t in self.public_tags) app_registry.register('tagging', TaggingAppDataContainer)
这将允许您访问任何定义的appdatafield中的'tagging'命名空间
from blog_app.models import BlogPost bp = BlogPost() assert bp.app_data.tagging.tag_string() == ""
其他选项
注意,如果不需要向容器添加自定义方法,可以 只需使用工厂创建子类:
app_registry.register('tagging', AppDataContainer.from_form(TaggingAppDataForm))
此外,您还可以将注册限制为给定的型号:
from blog_app.models import BlogPost app_registry.register('tagging', TaggingAppDataContainer, BlogPost)
扩展窗体
django appdata提供一个多格式的类-django的模型的包装器
与注册在
模型的appdatafield,通常可扩展应用程序将创建并使用
多种形式而不是常规的模型形式
使用该应用程序时,任何项目都可以向该应用程序添加其他子表单
这样当可重用应用程序的代码可以保持不变并且我们可以注入
对其处理的附加形式逻辑。 传递任何参数和关键字参数时都不会更改
modelform类多格式是包装的,因此即使您有自定义参数
对于您的模型一切仍将工作: 当然,您不限于使用工厂功能:from app_data.forms import multiform_factory
from .models import BlogPost
BlogPostMultiForm = multiform_factory(BlogPost)
from blog_app.forms import BlogPostMultiForm
BlogPostMultiForm.add_form('tagging', {'fields': ['public_tags']})
其他选项
from django.forms.models import BaseModelForm
class ModelFormWithUser(ModelForm):
def __init__(self, user, *args, **kwargs):
self.user = user
super(ModelFormWithUser, self).__init__(*args, **kwargs)
BlogPostMultiForm = multiform_factory(BlogPost, form=ModelFormWithUser)
from app_data import MultiForm
class MyMultiForm(MultiForm):
ModelForm = BlogPostModelForm
管理中的多种格式
如果您想将自己的代码添加到管理界面,只需使用 appdatamodeladmin:
from django.contrib import admin from app_data.admin import AppDataModelAdmin from blog_app.models import BlogPost class BlogPostAdmin(AppDataModelAdmin): # due to bug in django's admin validation we need to use # declared_fieldsets instead of just fieldsets declared_fieldsets = [ (None, {'fields': ['text', ]}), ('Tagging', {'fields': [('tagging.public_tags', 'tagging.admin_tags')]}) ] admin.site.register(BlogPost, BlogPostAdmin)
其他选项
与django的管理和表单一样,您可以通过 使用appdatamodeladmin的multiform属性。
幕后
django appdata使用textfield在模型上使用json存储数据 以及django的表单框架,用于数据的(反)序列化和验证。
当访问字段中的容器时,我们将尝试查找 注册表中的相应容器。如果找不到任何数据,则 如果存在则返回(dict)。为确保一切正常工作,我们建议 为您的项目放置某种类型的init代码,以确保 在运行任何实际代码之前完成注册。我们正在使用一个模块 在我们的应用程序中调用register,然后使用类似于管理员的piece of code 自动发现以遍历已安装的应用程序并加载此模块。