summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/orm/attributes.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2012-12-29 19:31:28 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2012-12-29 19:31:28 -0500
commitb30ef87d27898434188462455f3c850297e335d1 (patch)
tree58eddbad639eb05e1756d81db57822e8a4465ae2 /lib/sqlalchemy/orm/attributes.py
parent559b83312c44f7ebfe94bf7bd3b2de3133c5af9e (diff)
downloadsqlalchemy-b30ef87d27898434188462455f3c850297e335d1.tar.gz
Extended the :doc:`/core/inspection` system so that all Python descriptors
associated with the ORM or its extensions can be retrieved. This fulfills the common request of being able to inspect all :class:`.QueryableAttribute` descriptors in addition to extension types such as :class:`.hybrid_property` and :class:`.AssociationProxy`. See :attr:`.Mapper.all_orm_descriptors`.
Diffstat (limited to 'lib/sqlalchemy/orm/attributes.py')
-rw-r--r--lib/sqlalchemy/orm/attributes.py26
1 files changed, 24 insertions, 2 deletions
diff --git a/lib/sqlalchemy/orm/attributes.py b/lib/sqlalchemy/orm/attributes.py
index d2f20e94d..c3a297119 100644
--- a/lib/sqlalchemy/orm/attributes.py
+++ b/lib/sqlalchemy/orm/attributes.py
@@ -120,7 +120,23 @@ PASSIVE_ONLY_PERSISTENT = util.symbol("PASSIVE_ONLY_PERSISTENT",
class QueryableAttribute(interfaces._MappedAttribute,
interfaces._InspectionAttr,
interfaces.PropComparator):
- """Base class for class-bound attributes. """
+ """Base class for :term:`descriptor` objects that intercept
+ attribute events on behalf of a :class:`.MapperProperty`
+ object. The actual :class:`.MapperProperty` is accessible
+ via the :attr:`.QueryableAttribute.property`
+ attribute.
+
+
+ .. seealso::
+
+ :class:`.InstrumentedAttribute`
+
+ :class:`.MapperProperty`
+
+ :attr:`.Mapper.all_orm_descriptors`
+
+ :attr:`.Mapper.attrs`
+ """
is_attribute = True
@@ -231,7 +247,13 @@ inspection._self_inspects(QueryableAttribute)
class InstrumentedAttribute(QueryableAttribute):
- """Class bound instrumented attribute which adds descriptor methods."""
+ """Class bound instrumented attribute which adds basic
+ :term:`descriptor` methods.
+
+ See :class:`.QueryableAttribute` for a description of most features.
+
+
+ """
def __set__(self, instance, value):
self.impl.set(instance_state(instance),