]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
mapper configured doc
authorMike Bayer <mike_mp@zzzcomputing.com>
Fri, 21 Sep 2012 16:12:01 +0000 (12:12 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Fri, 21 Sep 2012 16:12:01 +0000 (12:12 -0400)
lib/sqlalchemy/orm/events.py

index 61517770f8682b0d0f12daec4fd758ef5215ff43..9132ef8fa7bcb972ffc04b1fa0cd228f5529a087 100644 (file)
@@ -390,8 +390,16 @@ class MapperEvents(event.Events):
     def mapper_configured(self, mapper, class_):
         """Called when the mapper for the class is fully configured.
 
-        This event is the latest phase of mapper construction.
-        The mapper should be in its final state.
+        This event is the latest phase of mapper construction, and
+        is invoked when the mapped classes are first used, so that relationships
+        between mappers can be resolved.   When the event is called,
+        the mapper should be in its final state.
+
+        While the configuration event normally occurs automatically,
+        it can be forced to occur ahead of time, in the case where the event
+        is needed before any actual mapper usage,  by using the
+        :func:`.configure_mappers` function.
+
 
         :param mapper: the :class:`.Mapper` which is the target
          of this event.