H`Tc@sdZddlmZmZmZddlmZddlZddlZddlm Z ddlm Z m Z dd l m Z mZdd lmZdd lmZd ejfd YZdefdYZdejfdYZdejfdYZdefdYZdejfdYZdefdYZdejfdYZdejfdYZdS(sORM event interfaces. i(teventtexctutili(t_mapper_or_noneiN(t interfaces(t mapperlibtinstrumentation(tSessiont sessionmaker(tscoped_session(tQueryableAttributetInstrumentationEventscBsheZdZdZejZedZee dZ edZ dZ dZ dZRS(sqEvents related to class instrumentation events. The listeners here support being established against any new style class, that is any object that is a subclass of 'type'. Events will then be fired off for events against that class. If the "propagate=True" flag is passed to event.listen(), the event will fire off for subclasses of that class as well. The Python ``type`` builtin is also accepted as a target, which when used has the effect of events being emitted for all classes. Note the "propagate" flag here is defaulted to ``True``, unlike the other class level events where it defaults to ``False``. This means that new subclasses will also be the subject of these events, when a listener is established on a superclass. .. versionchanged:: 0.8 - events here will emit based on comparing the incoming class to the type of class passed to :func:`.event.listen`. Previously, the event would fire for any class unconditionally regardless of what class was sent for listening, despite documentation which stated the contrary. t SomeBaseClasscCs!t|trt|SdSdS(N(t isinstancettypet_InstrumentationEventsHoldtNone(tclsttarget((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt _accept_with6s c s|j|j|jfdfd}tjj||jtjj j |dS(NcsO}r+t||r+||S rK||krK||SdS(N(t issubclass(t target_clstargt listen_cls(Rt propagatetfn(s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytlistenCs   cs>tjjdtj}ttjjj|dS(N( Rtregistryt _EventKeyRRt_instrumentation_factorytgetattrtdispatchtremove(treftkey(t identifierR(s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR Js     ( tdispatch_targetR#t _listen_fntweakrefR!tclass_twith_dispatch_targetRRt with_wrappert base_listen(Rt event_keyRtkwR ((RRRR#Rs[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt_listen=s  cCs'tt|jtjjjdS(N(tsuperR t_clearRRR(R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR/WscCsdS(sCalled after the given class is instrumented. To get at the :class:`.ClassManager`, use :func:`.manager_of_class`. N((tselfR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytclass_instrument\scCsdS(sCalled before the given class is uninstrumented. To get at the :class:`.ClassManager`, use :func:`.manager_of_class`. N((R0R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytclass_uninstrumentdscCsdS(s)Called when an attribute is instrumented.N((R0RR"tinst((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytattribute_instrumentls(t__name__t __module__t__doc__t_target_class_docRtInstrumentationFactoryt_dispatch_targett classmethodRtTrueR-R/R1R2R4(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR s   RcBs&eZdZdZejeZRS(swtemporary marker object used to transfer from _accept_with() to _listen() on the InstrumentationEvents class. cCs ||_dS(N(R'(R0R'((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt__init__vs(R5R6R7R=Rt dispatcherR R(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRps tInstanceEventscBseZdZdZejZedZee j ddZ ee e dZ edZdZdZd Zd Zd Zd Zd ZdZdZRS(sCDefine events specific to object lifecycle. e.g.:: from sqlalchemy import event def my_load_listener(target, context): print "on load!" event.listen(SomeClass, 'load', my_load_listener) Available targets include: * mapped classes * unmapped superclasses of mapped or to-be-mapped classes (using the ``propagate=True`` flag) * :class:`.Mapper` objects * the :class:`.Mapper` class itself and the :func:`.mapper` function indicate listening for all mappers. .. versionchanged:: 0.8.0 instance events can be associated with unmapped superclasses of mapped classes. Instance events are closely related to mapper events, but are more specific to the instance and its instrumentation, rather than its system of persistence. When using :class:`.InstanceEvents`, several modifiers are available to the :func:`.event.listen` function. :param propagate=False: When True, the event listener should be applied to all inheriting classes as well as the class which is the target of this listener. :param raw=False: When True, the "target" argument passed to applicable event listener functions will be the instance's :class:`.InstanceState` management object, rather than the mapped instance itself. t SomeClasscCstj||dS(N(t_InstanceEventsHoldtpopulate(RR't classmanager((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt_new_classmanager_instancesssqlalchemy.ormcCst|tjr|St|tjr/|jS||jkrEtjSt|trt|tjrmtjStj |}|r|St |SndS(N( R Rt ClassManagerRtMappert class_managertmapperRRtmanager_of_classRAR(RtormRtmanager((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRs c  s|j|j|j}}|sDfd}|j|}n|jd|||rx3|jtD]}|j|jdtqmWndS(Ncs|j||S(N(tobj(tstateRR,(R(s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytwrapsR(R$R#R%R)R*tsubclass_managersR<R(( RR+trawRR,RR#RNtmgr((Rs[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR-s cCs!tt|jtjdS(N(R.R?R/RA(R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR/scCsdS(sKCalled when the first instance of a particular mapping is called. N((R0RKR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt first_initscCsdS(sReceive an instance when its constructor is called. This method is only called during a userland construction of an object. It is not called when an object is loaded from the database. N((R0Rtargstkwargs((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytinitscCsdS(sReceive an instance when its constructor has been called, and raised an exception. This method is only called during a userland construction of an object. It is not called when an object is loaded from the database. N((R0RRSRT((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt init_failurescCsdS(s*Receive an object instance after it has been created via ``__new__``, and after initial attribute population has occurred. This typically occurs when the instance is created based on incoming result rows, and is only called once for that instance's lifetime. Note that during a result-row load, this method is called upon the first row received for this instance. Note that some attributes and collections may or may not be loaded or even initialized, depending on what's present in the result rows. :param target: the mapped instance. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :param context: the :class:`.QueryContext` corresponding to the current :class:`.Query` in progress. This argument may be ``None`` if the load does not correspond to a :class:`.Query`, such as during :meth:`.Session.merge`. N((R0Rtcontext((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytloadscCsdS(sjReceive an object instance after one or more attributes have been refreshed from a query. :param target: the mapped instance. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :param context: the :class:`.QueryContext` corresponding to the current :class:`.Query` in progress. :param attrs: iterable collection of attribute names which were populated, or None if all column-mapped, non-deferred attributes were populated. N((R0RRWtattrs((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytrefresh scCsdS(s*Receive an object instance after its attributes or some subset have been expired. 'keys' is a list of attribute names. If None, the entire state was expired. :param target: the mapped instance. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :param attrs: iterable collection of attribute names which were expired, or None if all attributes were expired. N((R0RRY((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytexpirescCsdS(syReceive an object instance as it is 'resurrected' from garbage collection, which occurs when a "dirty" state falls out of scope. :param target: the mapped instance. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. .. deprecated:: 0.9 - the resurrect event has no function, as the underlying functionality was dependent on the "mutation tracking" feature removed from SQLAlchemy in the 0.8 series. This event is removed in 1.0. N((R0R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt resurrect*scCsdS(sReceive an object instance when its associated state is being pickled. :param target: the mapped instance. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :param state_dict: the dictionary returned by :class:`.InstanceState.__getstate__`, containing the state to be pickled. N((R0Rt state_dict((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytpickle;scCsdS(sReceive an object instance after its associated state has been unpickled. :param target: the mapped instance. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :param state_dict: the dictionary sent to :class:`.InstanceState.__setstate__`, containing the state dictionary which was pickled. N((R0RR]((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytunpickleIs(R5R6R7R8RRER:R;RDRt dependenciesRtFalseR-R/RRRURVRXRZR[R\R^R_(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR?|s$'       t _EventsHoldcBsTeZdZdZedZdefdYZdZedZ RS(sHold onto listeners against unmapped, uninstrumented classes. Establish _listen() for that class' mapper/instrumentation when those objects are created for that class. cCs ||_dS(N(R'(R0R'((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR=`scCs|jjdS(N(t all_holdstclear(R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR/cst HoldEventscBs#eZdZeeedZRS(c Ks|j|j|j}}}|j|jkrB|j|j}ni}|j|jR(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRAs  t MapperEventscBseZdZdZejZedZee j ddZ ee e e dZ edZdZdZd Zd Zd Zd Zd ZdZdZdZdZdZdZdZRS(sT Define events specific to mappings. e.g.:: from sqlalchemy import event def my_before_insert_listener(mapper, connection, target): # execute a stored procedure upon INSERT, # apply the value to the row to be inserted target.calculated_value = connection.scalar( "select my_special_function(%d)" % target.special_number) # associate the listener function with SomeClass, # to execute during the "before_insert" hook event.listen( SomeClass, 'before_insert', my_before_insert_listener) Available targets include: * mapped classes * unmapped superclasses of mapped or to-be-mapped classes (using the ``propagate=True`` flag) * :class:`.Mapper` objects * the :class:`.Mapper` class itself and the :func:`.mapper` function indicate listening for all mappers. .. versionchanged:: 0.8.0 mapper events can be associated with unmapped superclasses of mapped classes. Mapper events provide hooks into critical sections of the mapper, including those related to object instrumentation, object loading, and object persistence. In particular, the persistence methods :meth:`~.MapperEvents.before_insert`, and :meth:`~.MapperEvents.before_update` are popular places to augment the state being persisted - however, these methods operate with several significant restrictions. The user is encouraged to evaluate the :meth:`.SessionEvents.before_flush` and :meth:`.SessionEvents.after_flush` methods as more flexible and user-friendly hooks in which to apply additional database state during a flush. When using :class:`.MapperEvents`, several modifiers are available to the :func:`.event.listen` function. :param propagate=False: When True, the event listener should be applied to all inheriting mappers and/or the mappers of inheriting classes, as well as any mapper which is the target of this listener. :param raw=False: When True, the "target" argument passed to applicable event listener functions will be the instance's :class:`.InstanceState` management object, rather than the mapped instance itself. :param retval=False: when True, the user-defined event function must have a return value, the purpose of which is either to control subsequent event propagation, or to otherwise alter the operation in progress by the mapper. Possible return values are: * ``sqlalchemy.orm.interfaces.EXT_CONTINUE`` - continue event processing normally. * ``sqlalchemy.orm.interfaces.EXT_STOP`` - cancel all subsequent event handlers in the chain. * other values - the return value specified by specific listeners. R@cCstj||dS(N(t_MapperEventsHoldRB(RR'RH((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt_new_mapper_instancesssqlalchemy.ormcCsl||jkrtjSt|trdt|tjr;|St|}|dk rW|St|Sn|SdS(N( RHRRFR RRRRRw(RRJRRH((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRs   c  s |j|j|j}}|d krH|tjk rHtjdn sV rst||}y$tj |dj ddWqt k rdqXnfd} |j | }n|rx=|jD]"} |j| jdt|qWn |j|dS( Ntbefore_configuredtafter_configureds{'before_configured' and 'after_configured' ORM events only invoke with the mapper() function or Mapper class as the target.iRicsa r6dk r6t|}|j|persist->event steps. .. warning:: Mapper-level flush events are designed to operate **on attributes local to the immediate object being handled and via SQL operations with the given** :class:`.Connection` **only.** Handlers here should **not** make alterations to the state of the :class:`.Session` overall, and in general should not affect any :func:`.relationship` -mapped attributes, as session cascade rules will not function properly, nor is it always known if the related class has already been handled. Operations that **are not supported in mapper events** include: * :meth:`.Session.add` * :meth:`.Session.delete` * Mapped collection append, add, remove, delete, discard, etc. * Mapped relationship attribute set/del events, i.e. ``someobject.related = someotherobject`` Operations which manipulate the state of the object relative to other objects are better handled: * In the ``__init__()`` method of the mapped object itself, or another method designed to establish some particular state. * In a ``@validates`` handler, see :ref:`simple_validators` * Within the :meth:`.SessionEvents.before_flush` event. :param mapper: the :class:`.Mapper` which is the target of this event. :param connection: the :class:`.Connection` being used to emit INSERT statements for this instance. This provides a handle into the current transaction on the target database specific to this instance. :param target: the mapped instance being persisted. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :return: No return value is supported by this event. N((R0RHt connectionR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt before_insert.scCsdS(s Receive an object instance after an INSERT statement is emitted corresponding to that instance. This event is used to modify in-Python-only state on the instance after an INSERT occurs, as well as to emit additional SQL statements on the given connection. The event is often called for a batch of objects of the same class after their INSERT statements have been emitted at once in a previous step. In the extremely rare case that this is not desirable, the :func:`.mapper` can be configured with ``batch=False``, which will cause batches of instances to be broken up into individual (and more poorly performing) event->persist->event steps. .. warning:: Mapper-level flush events are designed to operate **on attributes local to the immediate object being handled and via SQL operations with the given** :class:`.Connection` **only.** Handlers here should **not** make alterations to the state of the :class:`.Session` overall, and in general should not affect any :func:`.relationship` -mapped attributes, as session cascade rules will not function properly, nor is it always known if the related class has already been handled. Operations that **are not supported in mapper events** include: * :meth:`.Session.add` * :meth:`.Session.delete` * Mapped collection append, add, remove, delete, discard, etc. * Mapped relationship attribute set/del events, i.e. ``someobject.related = someotherobject`` Operations which manipulate the state of the object relative to other objects are better handled: * In the ``__init__()`` method of the mapped object itself, or another method designed to establish some particular state. * In a ``@validates`` handler, see :ref:`simple_validators` * Within the :meth:`.SessionEvents.before_flush` event. :param mapper: the :class:`.Mapper` which is the target of this event. :param connection: the :class:`.Connection` being used to emit INSERT statements for this instance. This provides a handle into the current transaction on the target database specific to this instance. :param target: the mapped instance being persisted. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :return: No return value is supported by this event. N((R0RHRR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_inserthscCsdS(sReceive an object instance before an UPDATE statement is emitted corresponding to that instance. This event is used to modify local, non-object related attributes on the instance before an UPDATE occurs, as well as to emit additional SQL statements on the given connection. This method is called for all instances that are marked as "dirty", *even those which have no net changes to their column-based attributes*. An object is marked as dirty when any of its column-based attributes have a "set attribute" operation called or when any of its collections are modified. If, at update time, no column-based attributes have any net changes, no UPDATE statement will be issued. This means that an instance being sent to :meth:`~.MapperEvents.before_update` is *not* a guarantee that an UPDATE statement will be issued, although you can affect the outcome here by modifying attributes so that a net change in value does exist. To detect if the column-based attributes on the object have net changes, and will therefore generate an UPDATE statement, use ``object_session(instance).is_modified(instance, include_collections=False)``. The event is often called for a batch of objects of the same class before their UPDATE statements are emitted at once in a later step. In the extremely rare case that this is not desirable, the :func:`.mapper` can be configured with ``batch=False``, which will cause batches of instances to be broken up into individual (and more poorly performing) event->persist->event steps. .. warning:: Mapper-level flush events are designed to operate **on attributes local to the immediate object being handled and via SQL operations with the given** :class:`.Connection` **only.** Handlers here should **not** make alterations to the state of the :class:`.Session` overall, and in general should not affect any :func:`.relationship` -mapped attributes, as session cascade rules will not function properly, nor is it always known if the related class has already been handled. Operations that **are not supported in mapper events** include: * :meth:`.Session.add` * :meth:`.Session.delete` * Mapped collection append, add, remove, delete, discard, etc. * Mapped relationship attribute set/del events, i.e. ``someobject.related = someotherobject`` Operations which manipulate the state of the object relative to other objects are better handled: * In the ``__init__()`` method of the mapped object itself, or another method designed to establish some particular state. * In a ``@validates`` handler, see :ref:`simple_validators` * Within the :meth:`.SessionEvents.before_flush` event. :param mapper: the :class:`.Mapper` which is the target of this event. :param connection: the :class:`.Connection` being used to emit UPDATE statements for this instance. This provides a handle into the current transaction on the target database specific to this instance. :param target: the mapped instance being persisted. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :return: No return value is supported by this event. N((R0RHRR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt before_updatescCsdS(sJReceive an object instance after an UPDATE statement is emitted corresponding to that instance. This event is used to modify in-Python-only state on the instance after an UPDATE occurs, as well as to emit additional SQL statements on the given connection. This method is called for all instances that are marked as "dirty", *even those which have no net changes to their column-based attributes*, and for which no UPDATE statement has proceeded. An object is marked as dirty when any of its column-based attributes have a "set attribute" operation called or when any of its collections are modified. If, at update time, no column-based attributes have any net changes, no UPDATE statement will be issued. This means that an instance being sent to :meth:`~.MapperEvents.after_update` is *not* a guarantee that an UPDATE statement has been issued. To detect if the column-based attributes on the object have net changes, and therefore resulted in an UPDATE statement, use ``object_session(instance).is_modified(instance, include_collections=False)``. The event is often called for a batch of objects of the same class after their UPDATE statements have been emitted at once in a previous step. In the extremely rare case that this is not desirable, the :func:`.mapper` can be configured with ``batch=False``, which will cause batches of instances to be broken up into individual (and more poorly performing) event->persist->event steps. .. warning:: Mapper-level flush events are designed to operate **on attributes local to the immediate object being handled and via SQL operations with the given** :class:`.Connection` **only.** Handlers here should **not** make alterations to the state of the :class:`.Session` overall, and in general should not affect any :func:`.relationship` -mapped attributes, as session cascade rules will not function properly, nor is it always known if the related class has already been handled. Operations that **are not supported in mapper events** include: * :meth:`.Session.add` * :meth:`.Session.delete` * Mapped collection append, add, remove, delete, discard, etc. * Mapped relationship attribute set/del events, i.e. ``someobject.related = someotherobject`` Operations which manipulate the state of the object relative to other objects are better handled: * In the ``__init__()`` method of the mapped object itself, or another method designed to establish some particular state. * In a ``@validates`` handler, see :ref:`simple_validators` * Within the :meth:`.SessionEvents.before_flush` event. :param mapper: the :class:`.Mapper` which is the target of this event. :param connection: the :class:`.Connection` being used to emit UPDATE statements for this instance. This provides a handle into the current transaction on the target database specific to this instance. :param target: the mapped instance being persisted. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :return: No return value is supported by this event. N((R0RHRR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_updatescCsdS(s Receive an object instance before a DELETE statement is emitted corresponding to that instance. This event is used to emit additional SQL statements on the given connection as well as to perform application specific bookkeeping related to a deletion event. The event is often called for a batch of objects of the same class before their DELETE statements are emitted at once in a later step. .. warning:: Mapper-level flush events are designed to operate **on attributes local to the immediate object being handled and via SQL operations with the given** :class:`.Connection` **only.** Handlers here should **not** make alterations to the state of the :class:`.Session` overall, and in general should not affect any :func:`.relationship` -mapped attributes, as session cascade rules will not function properly, nor is it always known if the related class has already been handled. Operations that **are not supported in mapper events** include: * :meth:`.Session.add` * :meth:`.Session.delete` * Mapped collection append, add, remove, delete, discard, etc. * Mapped relationship attribute set/del events, i.e. ``someobject.related = someotherobject`` Operations which manipulate the state of the object relative to other objects are better handled: * In the ``__init__()`` method of the mapped object itself, or another method designed to establish some particular state. * In a ``@validates`` handler, see :ref:`simple_validators` * Within the :meth:`.SessionEvents.before_flush` event. :param mapper: the :class:`.Mapper` which is the target of this event. :param connection: the :class:`.Connection` being used to emit DELETE statements for this instance. This provides a handle into the current transaction on the target database specific to this instance. :param target: the mapped instance being deleted. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :return: No return value is supported by this event. N((R0RHRR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt before_delete8scCsdS(s Receive an object instance after a DELETE statement has been emitted corresponding to that instance. This event is used to emit additional SQL statements on the given connection as well as to perform application specific bookkeeping related to a deletion event. The event is often called for a batch of objects of the same class after their DELETE statements have been emitted at once in a previous step. .. warning:: Mapper-level flush events are designed to operate **on attributes local to the immediate object being handled and via SQL operations with the given** :class:`.Connection` **only.** Handlers here should **not** make alterations to the state of the :class:`.Session` overall, and in general should not affect any :func:`.relationship` -mapped attributes, as session cascade rules will not function properly, nor is it always known if the related class has already been handled. Operations that **are not supported in mapper events** include: * :meth:`.Session.add` * :meth:`.Session.delete` * Mapped collection append, add, remove, delete, discard, etc. * Mapped relationship attribute set/del events, i.e. ``someobject.related = someotherobject`` Operations which manipulate the state of the object relative to other objects are better handled: * In the ``__init__()`` method of the mapped object itself, or another method designed to establish some particular state. * In a ``@validates`` handler, see :ref:`simple_validators` * Within the :meth:`.SessionEvents.before_flush` event. :param mapper: the :class:`.Mapper` which is the target of this event. :param connection: the :class:`.Connection` being used to emit DELETE statements for this instance. This provides a handle into the current transaction on the target database specific to this instance. :param target: the mapped instance being deleted. If the event is configured with ``raw=True``, this will instead be the :class:`.InstanceState` state-management object associated with the instance. :return: No return value is supported by this event. N((R0RHRR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_deleteks(R5R6R7R8RRFR:R;RxRR`RRaR-R/RRRyRzRRRRRRRRRR(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRvs.C '   $ ! #  % ' : : K K 3RwcBsHeZejZdZdejefdYZ e j e Z RS(cCs t|S(N(R(R0R'((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRlstHoldMapperEventscBseZRS((R5R6(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRs( R5R6R&RuRcRlRbReRvRRR>R(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRws  t SessionEventscBseZdZdZeZedZdZdZ dZ dZ dZ dZ d Zd Zd Zd Zd ZdZejdddddgddZejdddddgddZRS(sDefine events specific to :class:`.Session` lifecycle. e.g.:: from sqlalchemy import event from sqlalchemy.orm import sessionmaker def my_before_commit(session): print "before commit!" Session = sessionmaker() event.listen(Session, "before_commit", my_before_commit) The :func:`~.event.listen` function will accept :class:`.Session` objects as well as the return result of :class:`~.sessionmaker()` and :class:`~.scoped_session()`. Additionally, it accepts the :class:`.Session` class which will apply listeners to all :class:`.Session` instances globally. tSomeSessionOrFactorycCst|tr]|j}t|t r]t|t sHt|t r]tjdq]nt|trs|j St|trt|trtSt|tr|Snt|tr|SdSdS(NsrSession event listen on a scoped_session requires that its creation callable is associated with the Session class.( R R tsession_factoryRRRRRt ArgumentErrorR'R(RR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRs" cCsdS(sExecute when a new :class:`.SessionTransaction` is created. This event differs from :meth:`~.SessionEvents.after_begin` in that it occurs for each :class:`.SessionTransaction` overall, as opposed to when transactions are begun on individual database connections. It is also invoked for nested transactions and subtransactions, and is always matched by a corresponding :meth:`~.SessionEvents.after_transaction_end` event (assuming normal operation of the :class:`.Session`). :param session: the target :class:`.Session`. :param transaction: the target :class:`.SessionTransaction`. .. versionadded:: 0.8 .. seealso:: :meth:`~.SessionEvents.after_transaction_end` N((R0tsessiont transaction((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytafter_transaction_createscCsdS(sExecute when the span of a :class:`.SessionTransaction` ends. This event differs from :meth:`~.SessionEvents.after_commit` in that it corresponds to all :class:`.SessionTransaction` objects in use, including those for nested transactions and subtransactions, and is always matched by a corresponding :meth:`~.SessionEvents.after_transaction_create` event. :param session: the target :class:`.Session`. :param transaction: the target :class:`.SessionTransaction`. .. versionadded:: 0.8 .. seealso:: :meth:`~.SessionEvents.after_transaction_create` N((R0RR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytafter_transaction_endscCsdS(s!Execute before commit is called. .. note:: The :meth:`~.SessionEvents.before_commit` hook is *not* per-flush, that is, the :class:`.Session` can emit SQL to the database many times within the scope of a transaction. For interception of these events, use the :meth:`~.SessionEvents.before_flush`, :meth:`~.SessionEvents.after_flush`, or :meth:`~.SessionEvents.after_flush_postexec` events. :param session: The target :class:`.Session`. .. seealso:: :meth:`~.SessionEvents.after_commit` :meth:`~.SessionEvents.after_begin` :meth:`~.SessionEvents.after_transaction_create` :meth:`~.SessionEvents.after_transaction_end` N((R0R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt before_commitscCsdS(sqExecute after a commit has occurred. .. note:: The :meth:`~.SessionEvents.after_commit` hook is *not* per-flush, that is, the :class:`.Session` can emit SQL to the database many times within the scope of a transaction. For interception of these events, use the :meth:`~.SessionEvents.before_flush`, :meth:`~.SessionEvents.after_flush`, or :meth:`~.SessionEvents.after_flush_postexec` events. .. note:: The :class:`.Session` is not in an active transaction when the :meth:`~.SessionEvents.after_commit` event is invoked, and therefore can not emit SQL. To emit SQL corresponding to every transaction, use the :meth:`~.SessionEvents.before_commit` event. :param session: The target :class:`.Session`. .. seealso:: :meth:`~.SessionEvents.before_commit` :meth:`~.SessionEvents.after_begin` :meth:`~.SessionEvents.after_transaction_create` :meth:`~.SessionEvents.after_transaction_end` N((R0R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_commit*scCsdS(sExecute after a real DBAPI rollback has occurred. Note that this event only fires when the *actual* rollback against the database occurs - it does *not* fire each time the :meth:`.Session.rollback` method is called, if the underlying DBAPI transaction has already been rolled back. In many cases, the :class:`.Session` will not be in an "active" state during this event, as the current transaction is not valid. To acquire a :class:`.Session` which is active after the outermost rollback has proceeded, use the :meth:`.SessionEvents.after_soft_rollback` event, checking the :attr:`.Session.is_active` flag. :param session: The target :class:`.Session`. N((R0R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytafter_rollbackNscCsdS(sExecute after any rollback has occurred, including "soft" rollbacks that don't actually emit at the DBAPI level. This corresponds to both nested and outer rollbacks, i.e. the innermost rollback that calls the DBAPI's rollback() method, as well as the enclosing rollback calls that only pop themselves from the transaction stack. The given :class:`.Session` can be used to invoke SQL and :meth:`.Session.query` operations after an outermost rollback by first checking the :attr:`.Session.is_active` flag:: @event.listens_for(Session, "after_soft_rollback") def do_something(session, previous_transaction): if session.is_active: session.execute("select * from some_table") :param session: The target :class:`.Session`. :param previous_transaction: The :class:`.SessionTransaction` transactional marker object which was just closed. The current :class:`.SessionTransaction` for the given :class:`.Session` is available via the :attr:`.Session.transaction` attribute. .. versionadded:: 0.7.3 N((R0Rtprevious_transaction((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytafter_soft_rollback`scCsdS(sExecute before flush process has started. :param session: The target :class:`.Session`. :param flush_context: Internal :class:`.UOWTransaction` object which handles the details of the flush. :param instances: Usually ``None``, this is the collection of objects which can be passed to the :meth:`.Session.flush` method (note this usage is deprecated). .. seealso:: :meth:`~.SessionEvents.after_flush` :meth:`~.SessionEvents.after_flush_postexec` N((R0Rt flush_contextt instances((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt before_flush|scCsdS(sRExecute after flush has completed, but before commit has been called. Note that the session's state is still in pre-flush, i.e. 'new', 'dirty', and 'deleted' lists still show pre-flush state as well as the history settings on instance attributes. :param session: The target :class:`.Session`. :param flush_context: Internal :class:`.UOWTransaction` object which handles the details of the flush. .. seealso:: :meth:`~.SessionEvents.before_flush` :meth:`~.SessionEvents.after_flush_postexec` N((R0RR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_flushscCsdS(sExecute after flush has completed, and after the post-exec state occurs. This will be when the 'new', 'dirty', and 'deleted' lists are in their final state. An actual commit() may or may not have occurred, depending on whether or not the flush started its own transaction or participated in a larger transaction. :param session: The target :class:`.Session`. :param flush_context: Internal :class:`.UOWTransaction` object which handles the details of the flush. .. seealso:: :meth:`~.SessionEvents.before_flush` :meth:`~.SessionEvents.after_flush` N((R0RR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytafter_flush_postexecscCsdS(sExecute after a transaction is begun on a connection :param session: The target :class:`.Session`. :param transaction: The :class:`.SessionTransaction`. :param connection: The :class:`~.engine.Connection` object which will be used for SQL statements. .. seealso:: :meth:`~.SessionEvents.before_commit` :meth:`~.SessionEvents.after_commit` :meth:`~.SessionEvents.after_transaction_create` :meth:`~.SessionEvents.after_transaction_end` N((R0RRR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_beginscCsdS(sExecute before an instance is attached to a session. This is called before an add, delete or merge causes the object to be part of the session. .. versionadded:: 0.8. Note that :meth:`~.SessionEvents.after_attach` now fires off after the item is part of the session. :meth:`.before_attach` is provided for those cases where the item should not yet be part of the session state. .. seealso:: :meth:`~.SessionEvents.after_attach` N((R0Rtinstance((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt before_attachscCsdS(sExecute after an instance is attached to a session. This is called after an add, delete or merge. .. note:: As of 0.8, this event fires off *after* the item has been fully associated with the session, which is different than previous releases. For event handlers that require the object not yet be part of session state (such as handlers which may autoflush while the target object is not yet complete) consider the new :meth:`.before_attach` event. .. seealso:: :meth:`~.SessionEvents.before_attach` N((R0RR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_attachss0.9Rtqueryt query_contextRcCs|j|j|j|jfS(N(RRRWR(tupdate_context((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytscCsdS(sExecute after a bulk update operation to the session. This is called as a result of the :meth:`.Query.update` method. :param update_context: an "update context" object which contains details about the update, including these attributes: * ``session`` - the :class:`.Session` involved * ``query`` -the :class:`.Query` object that this update operation was called upon. * ``context`` The :class:`.QueryContext` object, corresponding to the invocation of an ORM query. * ``result`` the :class:`.ResultProxy` returned as a result of the bulk UPDATE operation. N((R0R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytafter_bulk_updatescCs|j|j|j|jfS(N(RRRWR(tdelete_context((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRscCsdS(sExecute after a bulk delete operation to the session. This is called as a result of the :meth:`.Query.delete` method. :param delete_context: a "delete context" object which contains details about the update, including these attributes: * ``session`` - the :class:`.Session` involved * ``query`` -the :class:`.Query` object that this update operation was called upon. * ``context`` The :class:`.QueryContext` object, corresponding to the invocation of an ORM query. * ``result`` the :class:`.ResultProxy` returned as a result of the bulk DELETE operation. N((R0R((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytafter_bulk_delete s(R5R6R7R8RR:R;RRRRRRRRRRRRRRt_legacy_signatureRR(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRs,    $          tAttributeEventscBsneZdZdZeZedZedZ ee e e e dZ dZ dZ dZRS(sDefine events for object attributes. These are typically defined on the class-bound descriptor for the target class. e.g.:: from sqlalchemy import event def my_append_listener(target, value, initiator): print "received append event for target: %s" % target event.listen(MyClass.collection, 'append', my_append_listener) Listeners have the option to return a possibly modified version of the value, when the ``retval=True`` flag is passed to :func:`~.event.listen`:: def validate_phone(target, value, oldvalue, initiator): "Strip non-numeric characters from a phone number" return re.sub(r'(?![0-9])', '', value) # setup listener on UserContact.phone attribute, instructing # it to use the return value listen(UserContact.phone, 'set', validate_phone, retval=True) A validation function like the above can also raise an exception such as :exc:`ValueError` to halt the operation. Several modifiers are available to the :func:`~.event.listen` function. :param active_history=False: When True, indicates that the "set" event would like to receive the "old" value being replaced unconditionally, even if this requires firing off database loads. Note that ``active_history`` can also be set directly via :func:`.column_property` and :func:`.relationship`. :param propagate=False: When True, the listener function will be established not just for the class attribute given, but for attributes of the same name on all current subclasses of that class, as well as all future subclasses of that class, using an additional listener that listens for instrumentation events. :param raw=False: When True, the "target" argument to the event will be the :class:`.InstanceState` management object, rather than the mapped instance itself. :param retval=False: when True, the user-defined event listening must return the "value" argument from the function. This gives the listening function the opportunity to change the value that is ultimately used for a "set" or "append" event. sSomeClass.some_attributecCs tjj||t|_dS(N(RtEventst _set_dispatchRat_active_history(Rt dispatch_cls((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRdscCs0t|tjr(t|jj|jS|SdS(N(R RtMapperPropertyRtparentR'R"(RR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRisc s|j|j|j}}|r2t|j_n s@ rgfd}|j|}n|jd||rtj |j } x:| j tD]&} |j | |j jdtqWndS(NcsCs|j}ns/||||S|||SdS(N(RL(RtvalueR(RPR}R(s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRN~s R(R$R#R%R<RRR)R*RRIR'ROR(R"( RR+tactive_historyRPR}RRR#RNRKRQ((RPR}Rs[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR-qs cCsdS(s)Receive a collection append event. :param target: the object instance receiving the event. If the listener is registered with ``raw=True``, this will be the :class:`.InstanceState` object. :param value: the value being appended. If this listener is registered with ``retval=True``, the listener function must return this value, or a new value which replaces it. :param initiator: An instance of :class:`.attributes.Event` representing the initiation of the event. May be modified from its original value by backref handlers in order to control chained event propagation. .. versionchanged:: 0.9.0 the ``initiator`` argument is now passed as a :class:`.attributes.Event` object, and may be modified by backref handlers within a chain of backref-linked events. :return: if the event was registered with ``retval=True``, the given value, or a new effective value, should be returned. N((R0RRt initiator((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytappendscCsdS(s4Receive a collection remove event. :param target: the object instance receiving the event. If the listener is registered with ``raw=True``, this will be the :class:`.InstanceState` object. :param value: the value being removed. :param initiator: An instance of :class:`.attributes.Event` representing the initiation of the event. May be modified from its original value by backref handlers in order to control chained event propagation. .. versionchanged:: 0.9.0 the ``initiator`` argument is now passed as a :class:`.attributes.Event` object, and may be modified by backref handlers within a chain of backref-linked events. :return: No return value is defined for this event. N((R0RRR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR scCsdS(sReceive a scalar set event. :param target: the object instance receiving the event. If the listener is registered with ``raw=True``, this will be the :class:`.InstanceState` object. :param value: the value being set. If this listener is registered with ``retval=True``, the listener function must return this value, or a new value which replaces it. :param oldvalue: the previous value being replaced. This may also be the symbol ``NEVER_SET`` or ``NO_VALUE``. If the listener is registered with ``active_history=True``, the previous value of the attribute will be loaded from the database if the existing value is currently unloaded or expired. :param initiator: An instance of :class:`.attributes.Event` representing the initiation of the event. May be modified from its original value by backref handlers in order to control chained event propagation. .. versionchanged:: 0.9.0 the ``initiator`` argument is now passed as a :class:`.attributes.Event` object, and may be modified by backref handlers within a chain of backref-linked events. :return: if the event was registered with ``retval=True``, the given value, or a new effective value, should be returned. N((R0RRtoldvalueR((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pytsets(R5R6R7R8R R:t staticmethodRR;RRaR-RR R(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR(s7  (R7tRRRtbaseRRR&RRRRRRtscopingR t attributesR RR RsRR?t RefCollectionRbRARvRwRR(((s[/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt s*  Z C  ~