X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/b97aa6632f51c6c1737768bde749dcd99bc5f1e6..46997a51ed0ceb16ddbac712fbcb552a86cdc9e2:/philo/models/base.py diff --git a/philo/models/base.py b/philo/models/base.py index c361bdc..46fa8d5 100644 --- a/philo/models/base.py +++ b/philo/models/base.py @@ -16,6 +16,9 @@ from philo.utils.entities import AttributeMapper, TreeAttributeMapper from philo.validators import json_validator +__all__ = ('Tag', 'value_content_type_limiter', 'register_value_model', 'unregister_value_model', 'JSONValue', 'ForeignKeyValue', 'ManyToManyValue', 'Attribute', 'Entity', 'TreeEntity') + + class Tag(models.Model): """A simple, generic model for tagging.""" #: A CharField (max length 255) which contains the name of the tag. @@ -43,7 +46,7 @@ class Titled(models.Model): abstract = True -#: An instance of :class:`ContentTypeRegistryLimiter` which is used to track the content types which can be related to by :class:`ForeignKeyValue`\ s and :class:`ManyToManyValue`\ s. +#: An instance of :class:`.ContentTypeRegistryLimiter` which is used to track the content types which can be related to by :class:`ForeignKeyValue`\ s and :class:`ManyToManyValue`\ s. value_content_type_limiter = ContentTypeRegistryLimiter() @@ -310,7 +313,7 @@ class Entity(models.Model): def get_attribute_mapper(self, mapper=AttributeMapper): """ - Returns a dictionary-like object which can be used to retrieve related :class:`Attribute`\ s' values directly. + Returns an :class:`.AttributeMapper` which can be used to retrieve related :class:`Attribute`\ s' values directly. Example:: @@ -492,7 +495,7 @@ class TreeEntity(Entity, TreeModel): def get_attribute_mapper(self, mapper=None): """ - Returns a dictionary-like object which can be used to retrieve related :class:`Attribute`\ s' values directly. If an attribute with a given key is not related to the :class:`Entity`, then the object will check the parent's attributes. + Returns a :class:`.TreeAttributeMapper` or :class:`.AttributeMapper` which can be used to retrieve related :class:`Attribute`\ s' values directly. If an :class:`Attribute` with a given key is not related to the :class:`Entity`, then the mapper will check the parent's attributes. Example::