django-entity 4.2.0

发行说明

django实体是一个应用程序，它为django项目提供了在单独的、包含良好且易于访问的表中镜像其实体和实体关系的能力。只支持PostgreSQL。

Django Entity为大型项目提供了更好地隔离其应用程序的能力，同时将那些必须在主项目中处理实体及其关系的应用程序中特定于应用程序的代码最小化。

什么是实体？实体是django项目中的任何模型。例如，实体可以是django用户模型或用户组。类似地，实体关系定义不同类型实体之间的超级和子关系。例如，组将是用户的超级实体。Django Entity应用程序允许您在模型定义中轻松表达这种关系，并将其同步到项目中任何其他应用程序都可以访问的集中位置。

用例

假设您有一个django项目，它定义了许多类型的用户分组。例如，假设在您的企业项目中，您允许用户定义其经理、公司职位和区域分支位置。类似地，假设您有一个应用程序，它可以根据用户的经理（或该经理手下的任何人）、他们的职位或所在地区向用户组发送电子邮件。这个电子邮件应用程序可能需要知道这些关系的特定于应用程序的建模才能构建。类似地，根据模型的不同，查询manager层次结构下的所有用户可能是一个代价高昂的查找。

使用django实体，可以编写电子邮件应用程序来采用实体模型，而不必理解每个组的复杂关系。传递给电子邮件应用程序的实体模型可以是CompanyPosition模型，get_sub_entities（）。is_any_type（contentType.objects.get_for_model（user））将返回该CompanyPosition模型下的所有用户模型。这使得电子邮件应用程序可以完全与主项目定义其关系的方式隔离开来。类似地，在companyposition下获取所有用户模型的查询可能比直接从项目中查询要高效得多（取决于项目的模型结构）。

入门-配置实体同步

基本用例

与django的model admin类似，通过在实体注册表中注册实体来配置实体，如下所示：

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

就像这样，帐户模型现在在每次保存、删除或更新帐户的任何M2M字段时都会同步到实体表。

更高级的同步选项

如果django实体只将对象同步到单个实体表，那么django实体不会太多。为了利用镜像关系的强大功能，用户必须为继承entityconfig的实体定义配置。下面是一个小例子，它将我们的帐户模型扩展为有一个组外键。

fromentity.configimportregister_entity,EntityConfigclassAccount(Model):email=models.CharField(max_length=64)group=models.ForeignKey(Group)@register_entity()classGroupConfig(EntityConfig):queryset=Group.objects.all()@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()defget_super_entities(self,model_objs):return{Group:[(model_obj.id,model_obj.group_id)formodel_objinmodel_objs]}

在上面的场景中，我们使用默认的实体配置镜像组模型。但是，帐户模型现在使用继承实体配置的特殊配置。它覆盖get_super_entities函数，将作为超级实体的所有模型对象的列表返回给帐户。帐户同步后，用户可以对帐户关系进行各种筛选分组（稍后详细介绍）。

注意-在上面的示例中，我们还使用了register\u entity装饰符，这实际上是执行entity\u registry.register\u entity（model\u class，entity\u config\u class）

除了能够镜像关系之外，还可以扩展实体配置以镜像有关实体的元数据。例如，在前面的示例中使用帐户模型：

@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()defget_super_entities(self,model_objs):return{Group:[(model_obj.id,model_obj.group_id)formodel_objinmodel_objs]}defget_entity_meta(self,model_obj):return{'email':model_obj.email}

通过上述配置，每个帐户实体都将有一个entity_meta字段（一个json字段），该字段还镜像了email属性。元数据镜像功能强大，可以在需要访问具体模型的具体字段的实体上构建通用应用程序（无需预取实体指向的所有具体模型）。

除了元数据之外，实体还具有镜像显示名称字段的能力，以便为也可以在数据库中筛选的实体提供人类可读的名称。默认情况下，显示名称字段使用应用于具体模型实例的unicode（）函数的结果。用户可以通过重写实体配置中的get\u display\u name方法来重写此行为。

实体也可以配置为活动或非活动，这可以通过在配置中添加get\u is\u active函数来完成，如果实体是活动的，则返回true（默认值），否则返回false。

高级同步（续）-实体类型

实体可以用它们的"种类"来标记高级过滤功能。实体类型允许用户显式地声明要镜像的实体类型，同时提供关于实体类型的可读内容。这是通过镜像每个实体指向的实体kind对象中的一个唯一的名称字段和一个显示名称字段来实现的。

默认情况下，django实体将实体的内容类型镜像为其类型。名称字段将是内容类型的app_标签，后跟内容类型的模型。对于该名称对实体类型的描述不够充分的情况，用户可以覆盖实体配置中的get\u entity\u kind函数。例如：

@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()defget_entity_kind(self,model_obj):return(model_obj.email_domain,'Email domain {0}'.format(model_obj.email_domain))

在上述情况下，根据电子邮件的域将帐户实体分为不同的类型。返回元组的第二个值提供了一个人类可读的正在创建的类型版本。

更高级的同步-观看其他型号

在hood下面，django实体在镜像模型上进行保存、删除和m2m更新时同步镜像实体表。但是，有些模型实际上可能依赖于模型的直接字段没有指向的对象。例如，假设我们有以下型号：

classGroup(models.Model):group_name=models.CharField()classUser(models.Model):email=models.CharField()groups=models.ManyToManyField(Group)classAccount(models.Model):user=models.OneToOneField(User)

现在，假设帐户模型希望将用户模型中的每个组模型添加为其超级实体。这将通过以下配置设置：

@register_entity()classGroupConfig(EntityConfig):queryset=Group.objects.all()@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()defget_super_entities(self,model_objs):return{Group:[(model_obj.id,group.id)formodel_objinmodel_objsforgroupinmodel_obj.user.groups.all()]}

尽管这是很好的，如果这是现成的，django实体无法知道帐户模型需要在其关联的用户模型中的字段更改时更新。为了确保帐户模型正确镜像，请在实体配置中添加一个监视类变量，如下所示：

@register_entity()classGroupConfig(EntityConfig):queryset=Group.objects.all()@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()watching=[(User,lambdauser_obj:Account.objects.filter(user=user_obj)),]defget_super_entities(self,model_objs):return{Group:[(model_obj.id,group.id)formodel_objinmodel_objsforgroupinmodel_obj.user.groups.all()]}

监视字段定义元组列表。每个元组中的第一个元素表示要监视的模型。元组中的第二个元素描述用于访问与更改的监视模型相关的实体模型的函数。

这是另一个早晨e使用指向帐户的地址模型的复杂示例。

classAddress(models.Model):account=models.ForeignKey(Account)

要在帐户模型的用户模型更改时使地址模型同步，请定义如下实体配置：

@register_entity()classAddressConfig(EntityConfig):queryset=Address.objects.all()watching=[(User,lambdauser_model_obj:Address.objects.filter(account__user=user_model_obj)),]

同样，在引擎盖下发生的所有事情是，当一个用户模型被更改时，与该更改的用户模型相关的所有实体模型都被返回，以便它们可以被同步。

确保实体同步最佳查询

由于用户可能需要从许多不同的外键中镜像许多不同的超级实体，因此向django实体提供缓存提示是有益的。这可以通过简单地将预取的django queryset提供给实体配置中的queryset属性来实现。例如，我们以前的帐户实体配置需要执行以下操作：

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()

fromentity.configimportEntityConfig,register_entityclassAccount(Model):email=models.CharField(max_length=64)@register_entity()classAccountConfig(EntityConfig):queryset=Account.objects.all()