Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
Repository URL to install this package:
|
Version:
3.0.168 ▾
|
tvault-contego-common
/
home
/
tvault
/
.virtenv
/
lib
/
python2.7
/
site-packages
/
sqlalchemy
/
orm
/
events.pyc
|
|---|
ó
EYc @ s» d Z d d l m Z m Z m Z d d l m Z d d l Z d d l Z d d l m Z d d l m
Z
m Z d d l m
Z
m Z d d
l m Z d d l m Z d d l m Z d d
l m Z d e j f d YZ d e f d YZ d e j f d YZ d e j f d YZ d e f d YZ d e j f d YZ d e f d YZ d e j f d YZ! d e j f d YZ" d e j f d! YZ# d S(" s ORM event interfaces.
i ( t eventt exct utili ( t _mapper_or_noneiÿÿÿÿN( t
interfaces( t mapperlibt instrumentation( t Sessiont sessionmaker( t scoped_session( t QueryableAttribute( t Query( t inspect_getargspect InstrumentationEventsc B sh e Z d Z d Z e j Z e d Z e e d Z
e d Z d Z d Z
d Z RS( sq Events 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
SomeBaseClassc C s! t | t r t | Sd Sd S( N( t
isinstancet typet _InstrumentationEventsHoldt None( t clst target( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt _accept_with7 s
c s | j | j | j f d f d } t j j | | j t j j j
| d S( Nc sO } r+ t | | r+ | | S rK | | k rK | | Sd S( N( t
issubclass( t
target_clst argt
listen_cls( t fnt propagateR ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt listenD s
c s> t j j d t j } t t j j j | d S( N( R t registryt _EventKeyR R t _instrumentation_factoryt getattrt dispatcht remove( t reft key( t
identifierR ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR" K s
( t dispatch_targetR% t
_listen_fnt weakrefR# t class_t with_dispatch_targetR R t with_wrappert base_listen( R t event_keyR t kwR" ( ( R R% R R R sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt _listen> s c C s' t t | j t j j j d S( N( t superR
t _clearR R R! ( R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR1 X s c C s d S( s Called after the given class is instrumented.
To get at the :class:`.ClassManager`, use
:func:`.manager_of_class`.
N( ( t selfR ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt class_instrument] s c C s d S( s Called before the given class is uninstrumented.
To get at the :class:`.ClassManager`, use
:func:`.manager_of_class`.
N( ( R2 R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt class_uninstrumente s c C s d S( s) Called when an attribute is instrumented.N( ( R2 R R$ t inst( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt attribute_instrumentm s ( t __name__t
__module__t __doc__t _target_class_docR t InstrumentationFactoryt _dispatch_targett classmethodR t TrueR/ R1 R3 R4 R6 ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR
s R c B s& e Z d Z d Z e j e Z RS( sw temporary marker object used to transfer from _accept_with() to
_listen() on the InstrumentationEvents class.
c C s
| | _ d S( N( R) ( R2 R) ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt __init__w s ( R7 R8 R9 R? R t
dispatcherR
R! ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR q s t InstanceEventsc B s¿ e Z d Z d Z e j Z e d Z e e j
d d Z e e e d Z
e d Z d Z d Z d Z d
Z d Z d Z d
Z d Z d Z RS( sC Define 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 SomeClassc C s t j | | d S( N( t _InstanceEventsHoldt populate( R R) t classmanager( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt _new_classmanager_instanceª s s sqlalchemy.ormc C s t | t j r | St | t j r/ | j S| | j k rE t j St | t r t | t j rm t j St j | } | r | St
| Sn d S( N( R R t ClassManagerR t Mappert
class_managert mapperR R t manager_of_classRC R ( R t ormR t manager( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR ® s
c s | j | j | j } } | sD f d } | j | } n | j d | | | r x3 | j t D] } | j | j d t qm Wn d S( Nc s | j | | S( N( t obj( t stateR R. ( R ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt wrapÉ s R ( R& R% R' R+ R, t subclass_managersR> R* ( R R- t rawR R. R R% RP t mgr( ( R sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR/ Â s c C s! t t | j t j d S( N( R0 RA R1 RC ( R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR1 Ô s c C s d S( s] Called when the first instance of a particular mapping is called.
This event is called when the ``__init__`` method of a class
is called the first time for that particular class. The event
invokes before ``__init__`` actually proceeds as well as before
the :meth:`.InstanceEvents.init` event is invoked.
N( ( R2 RM R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt
first_initÙ s c C s d S( sÅ Receive an instance when its constructor is called.
This method is only called during a userland construction of
an object, in conjunction with the object's constructor, e.g.
its ``__init__`` method. It is not called when an object is
loaded from the database; see the :meth:`.InstanceEvents.load`
event in order to intercept a database load.
The event is called before the actual ``__init__`` constructor
of the object is called. The ``kwargs`` dictionary may be
modified in-place in order to affect what is passed to
``__init__``.
: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 args: positional arguments passed to the ``__init__`` method.
This is passed as a tuple and is currently immutable.
:param kwargs: keyword arguments passed to the ``__init__`` method.
This structure *can* be altered in place.
.. seealso::
:meth:`.InstanceEvents.init_failure`
:meth:`.InstanceEvents.load`
N( ( R2 R t argst kwargs( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt initã s c C s d S( sÇ Receive an instance when its constructor has been called,
and raised an exception.
This method is only called during a userland construction of
an object, in conjunction with the object's constructor, e.g.
its ``__init__`` method. It is not called when an object is loaded
from the database.
The event is invoked after an exception raised by the ``__init__``
method is caught. After the event
is invoked, the original exception is re-raised outwards, so that
the construction of the object still raises an exception. The
actual exception and stack trace raised should be present in
``sys.exc_info()``.
: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 args: positional arguments that were passed to the ``__init__``
method.
:param kwargs: keyword arguments that were passed to the ``__init__``
method.
.. seealso::
:meth:`.InstanceEvents.init`
:meth:`.InstanceEvents.load`
N( ( R2 R RU RV ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt init_failure s c C s d S( 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`.
.. seealso::
:meth:`.InstanceEvents.init`
:meth:`.InstanceEvents.refresh`
N( ( R2 R t context( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt load# s c C s d S( s) Receive an object instance after one or more attributes have
been refreshed from a query.
Contrast this to the :meth:`.InstanceEvents.load` method, which
is invoked when the object is first loaded 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: sequence of attribute names which
were populated, or None if all column-mapped, non-deferred
attributes were populated.
.. seealso::
:meth:`.InstanceEvents.load`
N( ( R2 R RY t attrs( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt refreshB s c C s d S( s Receive an object instance after one or more attributes have
been refreshed within the persistence of the object.
This event is the same as :meth:`.InstanceEvents.refresh` except
it is invoked within the unit of work flush process, and the values
here typically come from the process of handling an INSERT or
UPDATE, such as via the RETURNING clause or from Python-side default
values.
.. versionadded:: 1.0.5
: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 flush_context: Internal :class:`.UOWTransaction` object
which handles the details of the flush.
:param attrs: sequence of attribute names which
were populated.
N( ( R2 R t
flush_contextR[ ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt
refresh_flushY s c C s d S( 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: sequence of attribute
names which were expired, or None if all attributes were
expired.
N( ( R2 R R[ ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt expirep s c C s d S( sÈ Receive 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( ( R2 R t
state_dict( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt pickle s c C s d S( sÖ Receive 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( ( R2 R R` ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt unpickle s ( R7 R8 R9 R: R RG R< R= RF R t dependenciesR t FalseR/ R1 RT RW RX RZ R\ R^ R_ Ra Rb ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRA } s$ '
! t _EventsHoldc B sT e Z d Z d Z e d Z d e f d YZ d Z e d Z RS( s¶ Hold onto listeners against unmapped, uninstrumented classes.
Establish _listen() for that class' mapper/instrumentation when
those objects are created for that class.
c C s
| | _ d S( N( R) ( R2 R) ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR? ¦ s c C s | j j d S( N( t all_holdst clear( R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR1 © s t
HoldEventsc B s# e Z d Z e e e d Z RS( c K s | j | j | j } } } | j | j k rB | j | j } n i } | j | j <t j j | | | | | f | | j <| r t | j j
} xo | r| j d }
| j |
j
| j
|
} | d k r | j | j d | d t | q q Wn d S( Ni RR R ( R& R% R R) Rf R R t _stored_in_collectiont _keyt listt __subclasses__t popt extendt resolveR R* R Rd ( R R- RR R R. R R% R t
collectiont stackt subclasst subject( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR/ ° s N( R7 R8 R R< R= Rd R/ ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRh s c C sM | j | j | j } } } t | t rI | j | j } | | j =n d S( N( R& R% R R Re Rf R) Rj ( R2 R- R R% R Rp ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR" É s c C s x | j D]y } | | j k r
| j | } xT | j D]C \ } } } | sZ | | k r9 | j | j d | d t q9 q9 Wq
q
Wd S( NRR R ( t __mro__Rf t valuesR* R Rd ( R R) Rs Rr Rp R- RR R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRD Ñ s
(
R7 R8 R9 R? R= R1 t objectRh R" RD ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRe s RC c B sH e Z e j Z d Z d e j e f d YZ e
j e Z RS( c C s
t j | S( N( R RK ( R2 R) ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRo ä s t HoldInstanceEventsc B s e Z RS( ( R7 R8 ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRw ç s (
R7 R8 R( t WeakKeyDictionaryRf Ro Re Rh RA Rw R R@ R! ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRC á s t MapperEventsc B sË e Z d Z d Z e j Z e d Z e e j
d d Z e e e e d Z
e d Z d Z d Z d Z d
Z d Z d Z d
Z d Z d Z d Z RS( 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.
RB c C s t j | | d S( N( t _MapperEventsHoldRD ( R R) RJ ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt _new_mapper_instance5 s s sqlalchemy.ormc C sl | | j k r t j St | t rd t | t j r; | St | } | d k rW | St | Sn | Sd S( N( RJ R RH R R R R R Rz ( R RL R RJ ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR 9 s
c s | j | j | j } } | d k rH | t j k rH t j d n sV rÓ s© t | | } y! t | d j d d Wq© t
k
r¥ d q© Xn f d } | j | } n | r x= | j
D]" }
| j |
j d t | qã Wn
| j | d S(
Nt before_configuredt after_configureds{ 'before_configured' and 'after_configured' ORM events only invoke with the mapper() function or Mapper class as the target.i R i c sa r6 d k r6 t | } | j | <n sP | | t j S | | Sd S( N( R Rk RN R t EXT_CONTINUE( R R. ( R RR t retvalt target_index( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRP a s
R ( s before_configureds after_configured( R& R% R' R RH R t warnR R t indext
ValueErrorR R+ t self_and_descendantsR* R, R> ( R R- RR R R R. R R% t methRP RJ ( ( R RR R R sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR/ J s(
!
c C s! t t | j t j d S( N( R0 Ry R1 Rz ( R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR1 s s c C s d S( s Receive a class when the mapper is first constructed,
before instrumentation is applied to the mapped class.
This event is the earliest phase of mapper construction.
Most attributes of the mapper are not yet initialized.
This listener can either be applied to the :class:`.Mapper`
class overall, or to any un-mapped class which serves as a base
for classes that will be mapped (using the ``propagate=True`` flag)::
Base = declarative_base()
@event.listens_for(Base, "instrument_class", propagate=True)
def on_new_class(mapper, cls_):
" ... "
:param mapper: the :class:`.Mapper` which is the target
of this event.
:param class\_: the mapped class.
N( ( R2 RJ R) ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt instrument_classx s c C s d S( s× Called when a specific mapper has completed its own configuration
within the scope of the :func:`.configure_mappers` call.
The :meth:`.MapperEvents.mapper_configured` event is invoked
for each mapper that is encountered when the
:func:`.orm.configure_mappers` function proceeds through the current
list of not-yet-configured mappers.
:func:`.orm.configure_mappers` is typically invoked
automatically as mappings are first used, as well as each time
new mappers have been made available and new mapper use is
detected.
When the event is called, the mapper should be in its final
state, but **not including backrefs** that may be invoked from
other mappers; they might still be pending within the
configuration operation. Bidirectional relationships that
are instead configured via the
:paramref:`.orm.relationship.back_populates` argument
*will* be fully available, since this style of relationship does not
rely upon other possibly-not-configured mappers to know that they
exist.
For an event that is guaranteed to have **all** mappers ready
to go including backrefs that are defined only on other
mappings, use the :meth:`.MapperEvents.after_configured`
event; this event invokes only after all known mappings have been
fully configured.
The :meth:`.MapperEvents.mapper_configured` event, unlike
:meth:`.MapperEvents.before_configured` or
:meth:`.MapperEvents.after_configured`,
is called for each mapper/class individually, and the mapper is
passed to the event itself. It also is called exactly once for
a particular mapper. The event is therefore useful for
configurational steps that benefit from being invoked just once
on a specific mapper basis, which don't require that "backref"
configurations are necessarily ready yet.
:param mapper: the :class:`.Mapper` which is the target
of this event.
:param class\_: the mapped class.
.. seealso::
:meth:`.MapperEvents.before_configured`
:meth:`.MapperEvents.after_configured`
N( ( R2 RJ R) ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt mapper_configured s c C s d S( s Called before a series of mappers have been configured.
The :meth:`.MapperEvents.before_configured` event is invoked
each time the :func:`.orm.configure_mappers` function is
invoked, before the function has done any of its work.
:func:`.orm.configure_mappers` is typically invoked
automatically as mappings are first used, as well as each time
new mappers have been made available and new mapper use is
detected.
This event can **only** be applied to the :class:`.Mapper` class
or :func:`.mapper` function, and not to individual mappings or
mapped classes. It is only invoked for all mappings as a whole::
from sqlalchemy.orm import mapper
@event.listens_for(mapper, "before_configured")
def go():
# ...
Constrast this event to :meth:`.MapperEvents.after_configured`,
which is invoked after the series of mappers has been configured,
as well as :meth:`.MapperEvents.mapper_configured`, which is invoked
on a per-mapper basis as each one is configured to the extent possible.
Theoretically this event is called once per
application, but is actually called any time new mappers
are to be affected by a :func:`.orm.configure_mappers`
call. If new mappings are constructed after existing ones have
already been used, this event will likely be called again. To ensure
that a particular event is only called once and no further, the
``once=True`` argument (new in 0.9.4) can be applied::
from sqlalchemy.orm import mapper
@event.listens_for(mapper, "before_configured", once=True)
def go():
# ...
.. versionadded:: 0.9.3
.. seealso::
:meth:`.MapperEvents.mapper_configured`
:meth:`.MapperEvents.after_configured`
N( ( R2 ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR| Ã s c C s d S( s2 Called after a series of mappers have been configured.
The :meth:`.MapperEvents.after_configured` event is invoked
each time the :func:`.orm.configure_mappers` function is
invoked, after the function has completed its work.
:func:`.orm.configure_mappers` is typically invoked
automatically as mappings are first used, as well as each time
new mappers have been made available and new mapper use is
detected.
Contrast this event to the :meth:`.MapperEvents.mapper_configured`
event, which is called on a per-mapper basis while the configuration
operation proceeds; unlike that event, when this event is invoked,
all cross-configurations (e.g. backrefs) will also have been made
available for any mappers that were pending.
Also constrast to :meth:`.MapperEvents.before_configured`,
which is invoked before the series of mappers has been configured.
This event can **only** be applied to the :class:`.Mapper` class
or :func:`.mapper` function, and not to individual mappings or
mapped classes. It is only invoked for all mappings as a whole::
from sqlalchemy.orm import mapper
@event.listens_for(mapper, "after_configured")
def go():
# ...
Theoretically this event is called once per
application, but is actually called any time new mappers
have been affected by a :func:`.orm.configure_mappers`
call. If new mappings are constructed after existing ones have
already been used, this event will likely be called again. To ensure
that a particular event is only called once and no further, the
``once=True`` argument (new in 0.9.4) can be applied::
from sqlalchemy.orm import mapper
@event.listens_for(mapper, "after_configured", once=True)
def go():
# ...
.. seealso::
:meth:`.MapperEvents.mapper_configured`
:meth:`.MapperEvents.before_configured`
N( ( R2 ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR} ÷ s c C s d S( sÁ Receive an object instance before an INSERT statement
is emitted corresponding to that instance.
This event is used to modify local, non-object related
attributes on the instance before 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 before their INSERT 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 only allow **very limited operations**,
on attributes local to the row being operated upon only,
as well as allowing any SQL to be emitted on the given
:class:`.Connection`. **Please read fully** the notes
at :ref:`session_persistence_mapper` for guidelines on using
these methods; generally, the :meth:`.SessionEvents.before_flush`
method should be preferred for general on-flush changes.
: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.
.. seealso::
:ref:`session_persistence_events`
N( ( R2 RJ t
connectionR ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt
before_insert* s c C s d S( 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 only allow **very limited operations**,
on attributes local to the row being operated upon only,
as well as allowing any SQL to be emitted on the given
:class:`.Connection`. **Please read fully** the notes
at :ref:`session_persistence_mapper` for guidelines on using
these methods; generally, the :meth:`.SessionEvents.before_flush`
method should be preferred for general on-flush changes.
: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.
.. seealso::
:ref:`session_persistence_events`
N( ( R2 RJ R R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_insertX s c C s d S( s Receive 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 only allow **very limited operations**,
on attributes local to the row being operated upon only,
as well as allowing any SQL to be emitted on the given
:class:`.Connection`. **Please read fully** the notes
at :ref:`session_persistence_mapper` for guidelines on using
these methods; generally, the :meth:`.SessionEvents.before_flush`
method should be preferred for general on-flush changes.
: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.
.. seealso::
:ref:`session_persistence_events`
N( ( R2 RJ R R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt
before_update s c C s d S( sR Receive 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 only allow **very limited operations**,
on attributes local to the row being operated upon only,
as well as allowing any SQL to be emitted on the given
:class:`.Connection`. **Please read fully** the notes
at :ref:`session_persistence_mapper` for guidelines on using
these methods; generally, the :meth:`.SessionEvents.before_flush`
method should be preferred for general on-flush changes.
: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.
.. seealso::
:ref:`session_persistence_events`
N( ( R2 RJ R R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_updateÇ s c C s d S( 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 only allow **very limited operations**,
on attributes local to the row being operated upon only,
as well as allowing any SQL to be emitted on the given
:class:`.Connection`. **Please read fully** the notes
at :ref:`session_persistence_mapper` for guidelines on using
these methods; generally, the :meth:`.SessionEvents.before_flush`
method should be preferred for general on-flush changes.
: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.
.. seealso::
:ref:`session_persistence_events`
N( ( R2 RJ R R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt
before_delete s c C s d S( 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 only allow **very limited operations**,
on attributes local to the row being operated upon only,
as well as allowing any SQL to be emitted on the given
:class:`.Connection`. **Please read fully** the notes
at :ref:`session_persistence_mapper` for guidelines on using
these methods; generally, the :meth:`.SessionEvents.before_flush`
method should be preferred for general on-flush changes.
: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.
.. seealso::
:ref:`session_persistence_events`
N( ( R2 RJ R R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_delete/ s ( R7 R8 R9 R: R RH R< R= R{ R Rc R Rd R/ R1 R R R| R} R R R R R R ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRy í s& C ' 4 4 3 . . A @ (Rz c B sH e Z e j Z d Z d e j e f d YZ e
j e Z RS( c C s
t | S( N( R ( R2 R) ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRo [ s t HoldMapperEventsc B s e Z RS( ( R7 R8 ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR ^ s (
R7 R8 R( Rx Rf Ro Re Rh Ry R R R@ R! ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRz X s t
SessionEventsc B sï e Z d Z d Z e Z e d Z d Z d Z d Z
d Z d Z d Z
d Z d
Z d Z d Z d
Z d Z e j d d d d d g d d Z e j d d d d d g d d Z RS( s Define 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.
t SomeSessionOrFactoryc C sÆ t | t r] | j } t | t r] t | t sH t | t r] t j d q] n t | t rs | j St | t r« t | t r t St | t r | Sn t | t r¾ | Sd Sd S( Nsr Session event listen on a scoped_session requires that its creation callable is associated with the Session class.( R R t session_factoryR R R R R t
ArgumentErrorR) R ( R R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR s" c C s d S( sq Execute 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`.
To detect if this is the outermost
:class:`.SessionTransaction`, as opposed to a "subtransaction" or a
SAVEPOINT, test that the :attr:`.SessionTransaction.parent` attribute
is ``None``::
@event.listens_for(session, "after_transaction_create")
def after_transaction_create(session, transaction):
if transaction.parent is None:
# work with top-level transaction
To detect if the :class:`.SessionTransaction` is a SAVEPOINT, use the
:attr:`.SessionTransaction.nested` attribute::
@event.listens_for(session, "after_transaction_create")
def after_transaction_create(session, transaction):
if transaction.nested:
# work with SAVEPOINT transaction
.. seealso::
:class:`.SessionTransaction`
:meth:`~.SessionEvents.after_transaction_end`
N( ( R2 t sessiont transaction( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_transaction_create s c C s d S( sß Execute 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`.
To detect if this is the outermost
:class:`.SessionTransaction`, as opposed to a "subtransaction" or a
SAVEPOINT, test that the :attr:`.SessionTransaction.parent` attribute
is ``None``::
@event.listens_for(session, "after_transaction_create")
def after_transaction_end(session, transaction):
if transaction.parent is None:
# work with top-level transaction
To detect if the :class:`.SessionTransaction` is a SAVEPOINT, use the
:attr:`.SessionTransaction.nested` attribute::
@event.listens_for(session, "after_transaction_create")
def after_transaction_end(session, transaction):
if transaction.nested:
# work with SAVEPOINT transaction
.. seealso::
:class:`.SessionTransaction`
:meth:`~.SessionEvents.after_transaction_create`
N( ( R2 R R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_transaction_endÆ s c C s d S( 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( ( R2 R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt
before_commití s c C s d S( sq Execute 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( ( R2 R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_commit s c C s d S( só Execute 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( ( R2 R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_rollback- s c C s d S( s Execute 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( ( R2 R t previous_transaction( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_soft_rollback? s c C s d S( sL Execute 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`
:ref:`session_persistence_events`
N( ( R2 R R] t instances( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt before_flush[ s c C s d S( s Execute 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`
:ref:`session_persistence_events`
N( ( R2 R R] ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_flusho s c C s d S( sÄ Execute 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`
:ref:`session_persistence_events`
N( ( R2 R R] ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_flush_postexec
s c C s d S( s Execute 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( ( R2 R R R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_begin s c C s d S( s4 Execute 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`
:ref:`session_lifecycle_events`
N( ( R2 R t instance( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt
before_attach± s c C s d S( s Execute 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`
:ref:`session_lifecycle_events`
N( ( R2 R R¢ ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_attachÄ s s 0.9R t queryt
query_contextt resultc C s | j | j | j | j f S( N( R R¥ RY R§ ( t update_context( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt <lambda>Þ s c C s d S( s¬ Execute 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( ( R2 R¨ ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_bulk_updateÜ s c C s | j | j | j | j f S( N( R R¥ RY R§ ( t delete_context( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR© ø s c C s d S( s« Execute 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( ( R2 R« ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt after_bulk_deleteö s ( R7 R8 R9 R: R R< R= R R R R R R R R R R R¡ R£ R¤ R t _legacy_signatureRª R¬ ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR d s, * ' $ t AttributeEventsc B s e Z d Z d Z e Z e d Z e d Z e e
e
e
e
d Z d Z d Z
d Z d Z d Z RS(
s® Define 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.
s SomeClass.some_attributec C s" t j j | | } t | _ | S( N( R t Eventst
_set_dispatchRd t _active_history( R t dispatch_clsR! ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR° M s c C s0 t | t j r( t | j j | j S| Sd S( N( R R t MapperPropertyR t parentR) R$ ( R R ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR S s c sÐ | j | j | j } } | r2 t | j _ n s@ rg f d } | j | } n | j d | | rÌ t j | j
} x: | j t D]& }
| j |
| j
j d t q Wn d S( Nc sC s | j } n s/ | | | | S | | | Sd S( N( RN ( R t valueR ( R RR R ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRP h s R ( R& R% R' R> R! R± R+ R, R RK R) RQ R* R$ ( R R- t active_historyRR R R R R% RP RM RS ( ( R RR R sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR/ [ s c C s d S( 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( ( R2 R Rµ t initiator( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt append{ s c C s d S( s4 Receive 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( ( R2 R Rµ R· ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR" s c C s d S( s Receive 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( ( R2 R Rµ t oldvalueR· ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt set¨ s c C s d S( s3 Receive a 'collection init' event.
This event is triggered for a collection-based attribute, when
the initial "empty collection" is first generated for a blank
attribute, as well as for when the collection is replaced with
a new one, such as via a set event.
E.g., given that ``User.addresses`` is a relationship-based
collection, the event is triggered here::
u1 = User()
u1.addresses.append(a1) # <- new collection
and also during replace operations::
u1.addresses = [a2, a3] # <- new collection
:param target: the object instance receiving the event.
If the listener is registered with ``raw=True``, this will
be the :class:`.InstanceState` object.
:param collection: the new collection. This will always be generated
from what was specified as
:paramref:`.RelationshipProperty.collection_class`, and will always
be empty.
:param collection_adpater: the :class:`.CollectionAdapter` that will
mediate internal access to the collection.
.. versionadded:: 1.0.0 the :meth:`.AttributeEvents.init_collection`
and :meth:`.AttributeEvents.dispose_collection` events supersede
the :class:`.collection.linker` hook.
N( ( R2 R Rp t collection_adapter( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt init_collectionÇ s c C s d S( so Receive a 'collection dispose' event.
This event is triggered for a collection-based attribute when
a collection is replaced, that is::
u1.addresses.append(a1)
u1.addresses = [a2, a3] # <- old collection is disposed
The mechanics of the event will typically include that the given
collection is empty, even if it stored objects while being replaced.
.. versionadded:: 1.0.0 the :meth:`.AttributeEvents.init_collection`
and :meth:`.AttributeEvents.dispose_collection` events supersede
the :class:`.collection.linker` hook.
N( ( R2 R Rp t collection_adpater( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt dispose_collectioné s ( R7 R8 R9 R: R
R< t staticmethodR° R= R Rd R/ R¸ R" Rº R¼ R¾ ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR® s 7 "t QueryEventsc B s5 e Z d Z d Z e Z d Z e e d Z RS( sq Represent events within the construction of a :class:`.Query` object.
The events here are intended to be used with an as-yet-unreleased
inspection system for :class:`.Query`. Some very basic operations
are possible now, however the inspection system is intended to allow
complex query manipulations to be automated.
.. versionadded:: 1.0.0
t SomeQueryc C s d S( s¡ Receive the :class:`.Query` object before it is composed into a
core :class:`.Select` object.
This event is intended to allow changes to the query given::
@event.listens_for(Query, "before_compile", retval=True)
def no_deleted(query):
for desc in query.column_descriptions:
if desc['type'] is User:
entity = desc['entity']
query = query.filter(entity.deleted == False)
return query
The event should normally be listened with the ``retval=True``
parameter set, so that the modified query may be returned.
N( ( R2 R¥ ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt before_compile s c sD | j s3 f d } | j | } n | j | d S( Nc s2 s! | d } | | | S | | Sd S( Ni ( ( R R. R¥ ( R R ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRP & s
( R' R+ R, ( R R- R R. RP ( ( R R sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyR/ s
(
R7 R8 R9 R: R R< RÂ R= Rd R/ ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyRÀ ý s
($ R9 t R R R t baseR t inspectR( R R R R R R t scopingR t
attributesR
R¥ R t sqlalchemy.util.compatR R¯ R
Rv R RA t
RefCollectionRe RC Ry Rz R R® RÀ ( ( ( sJ /home/tvault/.virtenv/lib/python2.7/site-packages/sqlalchemy/orm/events.pyt <module>
s2 Z ÿ "C ÿ ÿ m ÿ ®ì