summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/events.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2011-02-01 15:09:28 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2011-02-01 15:09:28 -0500
commit7fcbd39118e470a8ef04256d486f46c176a21b0c (patch)
tree873de124f2af57b2336ea52d5be8f79a0008dd4c /lib/sqlalchemy/events.py
parent54cc2aa18c5e7db8b8121969e67b8e18f3c2362b (diff)
downloadsqlalchemy-7fcbd39118e470a8ef04256d486f46c176a21b0c.tar.gz
docuemnt args for before_parent_attach, after_parent_attach
Diffstat (limited to 'lib/sqlalchemy/events.py')
-rw-r--r--lib/sqlalchemy/events.py20
1 files changed, 20 insertions, 0 deletions
diff --git a/lib/sqlalchemy/events.py b/lib/sqlalchemy/events.py
index 8a2776898..fe9c5dda1 100644
--- a/lib/sqlalchemy/events.py
+++ b/lib/sqlalchemy/events.py
@@ -131,11 +131,31 @@ class DDLEvents(event.Events):
"""Called before a :class:`.SchemaItem` is associated with
a parent :class:`.SchemaItem`.
+ :param target: the target object
+ :param parent: the parent to which the target is being attached.
+
+ :func:`.event.listen` also accepts a modifier for this event:
+
+ :param propagate=False: When True, the listener function will
+ be established for any copies made of the target object,
+ i.e. those copies that are generated when
+ :meth:`.Table.tometadata` is used.
+
"""
def after_parent_attach(self, target, parent):
"""Called after a :class:`.SchemaItem` is associated with
a parent :class:`.SchemaItem`.
+
+ :param target: the target object
+ :param parent: the parent to which the target is being attached.
+
+ :func:`.event.listen` also accepts a modifier for this event:
+
+ :param propagate=False: When True, the listener function will
+ be established for any copies made of the target object,
+ i.e. those copies that are generated when
+ :meth:`.Table.tometadata` is used.
"""