grokcore.annotation 4.0

设置grokcore.annotation

本包的设置本质上与grokcore.component包类似，请参阅其文档以获取详细信息。您需要的唯一附加ZCML行是

<include package="grokcore.annotation" />

请将此行放置在根ZCML文件的顶部附近，但在包含grokcore.component配置的行下方。

示例

以下是一个使用注解的简单示例

import grokcore.annotation
from zope import interface

# Create a model and an interface you want to adapt it to
# and an annotation class to implement the persistent adapter.
class Mammoth(grokcore.annotation.Model):
    pass

class ISerialBrand(interface.Interface):
    unique = interface.Attribute("Brands")

class Branding(grokcore.annotation.Annotation):
    grokcore.annotation.implements(ISerialBrand)
    unique = 0

# Grok the above code, then create some mammoths
manfred = Mammoth()
mumbles = Mammoth()

# creating Annotations work just like Adapters
livestock1 = ISerialBrand(manfred)
livestock2 = ISerialBrand(mumbles)

# except you can store data in them, this data will transparently persist
# in the database for as long as the object exists
livestock1.unique = 101
livestock2.unique = 102

# attributes not listed in the interface will also be persisted
# on the annotation
livestock2.foo = "something"

API概览

基类

注解

注解的基类。继承自持久化类Persistent。

模型

您希望使用注解的模型的基类。

queryAnnotation(model, interface)

查询给定模型上的给定接口的注解。如果找到则返回注解，否则返回None。这不会进行任何写操作。

deleteAnnotation(model, interface)

查找给定的注解并从模型中删除它。

LazyAnnotation

注解的基类。仅在显式设置懒属性值时才写入数据库对象。

LazyAnnotationProperty

与LazyAnnotation一起工作的属性实现。

此外，grokcore.annotation包公开了grokcore.component API。

变更