JezK
Edit File: interfaces.pyc
� 1��fc @@ s d Z d d l m Z d d l Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d d d d d d d! d" d# d$ d% d& f Z d' e j f d( � � YZ d) e j! f d* � � YZ" d+ e" f d, � � YZ# d- e j$ f d. � � YZ% e j& d$ e e e e j' f d/ � � Y� Z( e j& d% e j) f d0 � � Y� Z* d& e( f d1 � � YZ+ d2 e f d3 � � YZ, d4 e e, f d5 � � YZ- d# e- f d6 � � YZ. d7 e- f d8 � � YZ/ d9 e, f d: � � YZ0 e j1 d; d< d= e2 �d" e, f d> � � Y� Z3 d! e4 f d? � � YZ5 d S(@ s� Contains various base classes used throughout the ORM. Defines some key base classes prominent within the internals. This module and the classes within are mostly private, though some attributes are exposed when inspecting mappings. i ( t absolute_importNi ( t exc( t path_registry( t _MappedAttribute( t EXT_CONTINUE( t EXT_SKIP( t EXT_STOP( t InspectionAttr( t InspectionAttrInfo( t MANYTOMANY( t MANYTOONE( t NOT_EXTENSION( t ONETOMANYi ( t inspect( t inspection( t util( t operators( t roles( t visitors( t ExecutableOption( t HasCacheKeyR R R R R R R t LoaderStrategyt MapperOptiont LoaderOptiont MapperPropertyt PropComparatort StrategizedPropertyt ORMStatementRolec B@ s e Z d Z RS( s? Executable SQL or text() construct, including ORM aware objects( t __name__t __module__t _role_name( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR > s t ORMColumnsClauseRolec B@ s e Z d Z RS( s7 ORM mapped entity, aliased entity, or Column expression( R R R ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR D s t ORMEntityColumnsClauseRolec B@ s e Z d Z RS( s ORM mapped or aliased entity( R R R ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR H s t ORMFromClauseRolec B@ s e Z d Z RS( s5 ORM mapped entity, aliased entity, or FROM expression( R R R ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR! L s c B@ s� e Z d Z d Z d e j j f d e j j f g Z e � Z e Z e d � � Z d � Z d � Z d � Z d d � Z d � Z d � Z d � Z d � Z e d � � Z d � Z d � Z d � Z d � Z RS( s� Represent a particular class attribute mapped by :class:`_orm.Mapper`. The most common occurrences of :class:`.MapperProperty` are the mapped :class:`_schema.Column`, which is represented in a mapping as an instance of :class:`.ColumnProperty`, and a reference to another class produced by :func:`_orm.relationship`, represented in the mapping as an instance of :class:`.RelationshipProperty`. t _configure_startedt _configure_finishedt parentt keyt infoc C@ s t � � d S( s� True if this MapperProperty refers to a mapped entity. Should only be True for RelationshipProperty, False for all others. N( t NotImplementedError( t self( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt _links_to_entity{ s c C@ s i S( s� Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.InspectionAttr`. The dictionary is generated when first accessed. Alternatively, it can be specified as a constructor argument to the :func:`.column_property`, :func:`_orm.relationship`, or :func:`.composite` functions. .. versionchanged:: 1.0.0 :attr:`.MapperProperty.info` is also available on extension types via the :attr:`.InspectionAttrInfo.info` attribute, so that it can apply to a wider variety of ORM and extension constructs. .. seealso:: :attr:`.QueryableAttribute.info` :attr:`.SchemaItem.info` ( ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt _memoized_attr_info� s c K@ s d S( s Called by Query for the purposes of constructing a SQL statement. Each MapperProperty associated with the target mapper processes the statement referenced by the query context, adding columns and/or criterion as appropriate. N( ( R( t contextt query_entityt patht adaptert kwargs( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt setup� t c C@ s d S( sc Produce row processing functions and append to the given set of populators lists. N( ( R( R+ R, R- t mappert resultR. t populators( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt create_row_processor� R1 c C@ s t d � S( s� Iterate through instances related to the given instance for a particular 'cascade', starting with this MapperProperty. Return an iterator3-tuples (instance, mapper, state). Note that the 'cascade' collection on this MapperProperty is checked first for the given type before cascade_iterator is called. This method typically only applies to RelationshipProperty. ( ( t iter( R( t type_t statet dict_t visited_statest halt_on( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt cascade_iterator� s c C@ s | | _ d S( s� Set the parent mapper that references this MapperProperty. This method is overridden by some subclasses to perform extra setup when the mapper is first known. N( R$ ( R( R$ t init( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt set_parent� s c C@ s d S( sI Hook called by the Mapper to the property to initiate instrumentation of the class attribute managed by this MapperProperty. The MapperProperty here will typically call out to the attributes module to set up an InstrumentedAttribute. This step is the first of two steps to set up an InstrumentedAttribute, and is called early in the mapper setup process. The second step is typically the init_class_attribute step, called from StrategizedProperty via the post_instrument_class() hook. This step assigns additional state to the InstrumentedAttribute (specifically the "impl") which has been determined after the MapperProperty has determined what kind of persistence management it needs to do (e.g. scalar, object, collection, etc). N( ( R( R2 ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt instrument_class� R1 c C@ s t | _ t | _ d S( N( t FalseR" R# ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt __init__� s c C@ s t | _ | j � t | _ d S( s� Called after all mappers are created to assemble relationships between mappers and perform other post-mapper-creation initialization steps. N( t TrueR" t do_initR# ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR= � s c C@ s t | j j | j � S( s� Return the class-bound descriptor corresponding to this :class:`.MapperProperty`. This is basically a ``getattr()`` call:: return getattr(self.parent.class_, self.key) I.e. if this :class:`.MapperProperty` were named ``addresses``, and the class to which it is mapped is ``User``, this sequence is possible:: >>> from sqlalchemy import inspect >>> mapper = inspect(User) >>> addresses_property = mapper.attrs.addresses >>> addresses_property.class_attribute is User.addresses True >>> User.addresses.property is addresses_property True ( t getattrR$ t class_R% ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt class_attribute� s c C@ s d S( s� Perform subclass-specific initialization post-mapper-creation steps. This is a template method called by the ``MapperProperty`` object's init() method. N( ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRC R1 c C@ s d S( s Perform instrumentation adjustments that need to occur after init() has completed. The given Mapper is the Mapper invoking the operation, which may not be the same Mapper as self.parent in an inheritance scenario; however, Mapper will always at least be a sub-mapper of self.parent. This method is typically used by StrategizedProperty, which delegates it to LoaderStrategy.init_class_attribute() to perform final setup on the class-bound InstrumentedAttribute. N( ( R( R2 ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt post_instrument_class R1 c C@ s d S( so Merge the attribute represented by this ``MapperProperty`` from source to destination object. N( ( R( t sessiont source_statet source_dictt dest_statet dest_dictt loadt _recursivet _resolve_conflict_map( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt merge R1 c C@ s) d | j j t | � t | d d � f S( Ns <%s at 0x%x; %s>R% s no key( t __class__R t idRD ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt __repr__, s ( R" R# R$ R% R& N( R R t __doc__t __slots__R t ExtendedInternalTraversalt dp_has_cache_keyt dp_stringt _cache_key_traversalt frozensett cascadeRB t is_propertyt propertyR) R* R0 R5 t NoneR< R> R? RA R= RF RC RG RP RS ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR P s0 c B@ s� e Z d Z d Z d Z d d � Z d � Z d � Z d � Z e d � � Z e d � � Z e d � � Z e d � � Z e d � � Z e d � � Z e d � � Z d � Z d � Z d d � Z d d � Z RS( sU Defines SQL operators for :class:`.MapperProperty` objects. SQLAlchemy allows for operators to be redefined at both the Core and ORM level. :class:`.PropComparator` is the base class of operator redefinition for ORM-level operations, including those of :class:`.ColumnProperty`, :class:`.RelationshipProperty`, and :class:`.CompositeProperty`. .. note:: With the advent of Hybrid properties introduced in SQLAlchemy 0.7, as well as Core-level operator redefinition in SQLAlchemy 0.8, the use case for user-defined :class:`.PropComparator` instances is extremely rare. See :ref:`hybrids_toplevel` as well as :ref:`types_operators`. User-defined subclasses of :class:`.PropComparator` may be created. The built-in Python comparison and math operator methods, such as :meth:`.operators.ColumnOperators.__eq__`, :meth:`.operators.ColumnOperators.__lt__`, and :meth:`.operators.ColumnOperators.__add__`, can be overridden to provide new operator behavior. The custom :class:`.PropComparator` is passed to the :class:`.MapperProperty` instance via the ``comparator_factory`` argument. In each case, the appropriate subclass of :class:`.PropComparator` should be used:: # definition of custom PropComparator subclasses from sqlalchemy.orm.properties import \ ColumnProperty,\ CompositeProperty,\ RelationshipProperty class MyColumnComparator(ColumnProperty.Comparator): def __eq__(self, other): return self.__clause_element__() == other class MyRelationshipComparator(RelationshipProperty.Comparator): def any(self, expression): "define the 'any' operation" # ... class MyCompositeComparator(CompositeProperty.Comparator): def __gt__(self, other): "redefine the 'greater than' operation" return sql.and_(*[a>b for a, b in zip(self.__clause_element__().clauses, other.__composite_values__())]) # application of custom PropComparator subclasses from sqlalchemy.orm import column_property, relationship, composite from sqlalchemy import Column, String class SomeMappedClass(Base): some_column = column_property(Column("some_column", String), comparator_factory=MyColumnComparator) some_relationship = relationship(SomeOtherClass, comparator_factory=MyRelationshipComparator) some_composite = composite( Column("a", String), Column("b", String), comparator_factory=MyCompositeComparator ) Note that for column-level operator redefinition, it's usually simpler to define the operators at the Core level, using the :attr:`.TypeEngine.comparator_factory` attribute. See :ref:`types_operators` for more detail. .. seealso:: :class:`.ColumnProperty.Comparator` :class:`.RelationshipProperty.Comparator` :class:`.CompositeProperty.Comparator` :class:`.ColumnOperators` :ref:`types_operators` :attr:`.TypeEngine.comparator_factory` t propR] t _parententityt _adapt_to_entityt orm_prop_comparatorc C@ s, | | _ | _ | p | | _ | | _ d S( N( R_ R] R` Ra ( R( R_ t parentmappert adapt_to_entity( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRA � s c C@ s t d | � � d S( Ns %r( R' ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt __clause_element__� s c C@ s | j � | f g S( s� Receive a SQL expression that represents a value in the SET clause of an UPDATE statement. Return a tuple that can be passed to a :class:`_expression.Update` construct. ( Re ( R( t value( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt _bulk_update_tuples� s c C@ s | j | j | j | � S( s� Return a copy of this PropComparator which will use the given :class:`.AliasedInsp` to produce corresponding expressions. ( RQ R_ R` ( R( Rd ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRd � s c C@ s t | j � j S( sZ legacy; this is renamed to _parententity to be compatible with QueryableAttribute.( R R` R2 ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt _parentmapper� s c C@ s t j i d d 6| j d 6� S( Nt ormt compile_state_plugint plugin_subject( R t immutabledictRh ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt _propagate_attrs� s c C@ s! | j d k r d S| j j Sd S( sr Produce a callable that adapts column expressions to suit an aliased version of this comparator. N( Ra R^ t _adapt_element( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR. � s c C@ s | j j S( N( R] R& ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR& � s c K@ s | j | | � S( N( t any( t at bR/ ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt any_op� s c K@ s | j | | � S( N( t has( Rp Rq R/ ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt has_op� s c C@ s | j | � S( N( t of_type( Rp RE ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt of_type_op� s c C@ s | j t j | � S( s~ Redefine this object in terms of a polymorphic subclass, :func:`_orm.with_polymorphic` construct, or :func:`_orm.aliased` construct. Returns a new PropComparator from which further criterion can be evaluated. e.g.:: query.join(Company.employees.of_type(Engineer)).\ filter(Engineer.name=='foo') :param \class_: a class or mapper indicating that criterion will be against this specific subclass. .. seealso:: :ref:`queryguide_join_onclause` - in the :ref:`queryguide_toplevel` :ref:`inheritance_of_type` ( t operateR Rv ( R( RE ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRu � s c G@ s | j t j | � S( s? Add additional criteria to the ON clause that's represented by this relationship attribute. E.g.:: stmt = select(User).join( User.addresses.and_(Address.email_address != 'foo') ) stmt = select(User).options( joinedload(User.addresses.and_(Address.email_address != 'foo')) ) .. versionadded:: 1.4 .. seealso:: :ref:`orm_queryguide_join_on_augmented` :ref:`loader_option_criteria` :func:`.with_loader_criteria` ( Rw R t and_( R( t criteria( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRx � s c K@ s | j t j | | � S( s� Return true if this collection contains any member that meets the given criterion. The usual implementation of ``any()`` is :meth:`.RelationshipProperty.Comparator.any`. :param criterion: an optional ClauseElement formulated against the member class' table or attributes. :param \**kwargs: key/value pairs corresponding to member class attribute names which will be compared via equality to the corresponding values. ( Rw R Rr ( R( t criterionR/ ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRo s c K@ s | j t j | | � S( s� Return true if this element references a member which meets the given criterion. The usual implementation of ``has()`` is :meth:`.RelationshipProperty.Comparator.has`. :param criterion: an optional ClauseElement formulated against the member class' table or attributes. :param \**kwargs: key/value pairs corresponding to member class attribute names which will be compared via equality to the corresponding values. ( Rw R Rt ( R( Rz R/ ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRs $ s ( R_ R] R` Ra N( R R RT RU t __visit_name__R^ RA Re Rg Rd R] Rh Rm R. R& t staticmethodRr Rt Rv Ru Rx Ro Rs ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR 4 s$ W c B@ s� e Z d Z d Z e Z d Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z e j e � Z e d � � Z e d � � Z RS( s� A MapperProperty which uses selectable strategies to affect loading behavior. There is a single strategy selected by default. Alternate strategies can be selected at Query time through the usage of ``StrategizedOption`` objects via the Query.options() method. The mechanics of StrategizedProperty are used for every Query invocation for every mapped attribute participating in that Query, to determine first how the attribute will be rendered in SQL and secondly how the attribute will retrieve a value from a result row and apply it to a mapped object. The routines here are very performance-critical. t _strategiest strategyt _wildcard_tokent _default_path_loader_keyc C@ s d | j t j f f S( Ns %s:%s( t strategy_wildcard_keyR t _WILDCARD_TOKEN( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt _memoized_attr__wildcard_tokenQ s c C@ s d d | j t j f f f S( Nt loaders %s:%s( R� R t _DEFAULT_TOKEN( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt' _memoized_attr__default_path_loader_keyW s c C@ sW d } | | } x@ | j | j | j f D]& } | | j k r) | j | } Pq) q) W| S( N( R^ t _loader_keyt _wildcard_path_loader_keyR� t attributes( R( R+ R- RM t search_patht path_key( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt _get_context_loader` s c C@ sS y | j | SWn t k r" n X| j | | � } | | | � | j | <} | S( N( R} t KeyErrort _strategy_lookup( R( R% t clsR~ ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt _get_strategyr s c K@ s_ | j | | � } | r6 | j r6 | j | j � } n | j } | j | | | | | | � d S( N( R� R~ R� t setup_query( R( R+ R, R- R. R/ R� t strat( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR0 � s c C@ se | j | | � } | r6 | j r6 | j | j � } n | j } | j | | | | | | | | � d S( N( R� R~ R� R5 ( R( R+ R, R- R2 R3 R. R4 R� R� ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR5 � s c C@ s" i | _ | j | j � | _ d S( N( R} R� t strategy_keyR~ ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRC � s c C@ s: | j j r6 | j j | j � r6 | j j | � n d S( N( R$ t non_primaryt class_managert _attr_has_implR% R~ t init_class_attribute( R( R2 ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRG � s c @ s � � f d � } | S( Nc @ sX d | j k r g | _ n t t � j � � � } | � j � | <| j j | � | S( Nt _strategy_keys( t __dict__R� t tuplet sortedt itemst _all_strategiest append( t dec_clsR% ( R� t kw( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt decorate� s ( ( R� R� R� ( ( R� R� sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt strategy_for� s c G@ s� | j j xP | j D]E } | | j k r | j | } y | | SWqY t k rU qY Xq q WxI | j j � D], \ } } | | k rm | } | | } Pqm qm Wd } d } t j | | | | | � � d S( N( R$ t _with_polymorphic_mapperst __mro__R� R� R� R^ t orm_exct LoaderStrategyException( R� t requesting_propertyR% t prop_clst strategiest property_typet stratst intended_property_typet actual_strategy( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� � s* ( R} R~ R R� N( R R RT RU RB t inherit_cacheR^ R� R� R� R� R� R0 R5 RC RG t collectionst defaultdictt dictR� t classmethodR� R� ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR 7 s$ t ORMOptionc B@ s; e Z d Z d Z e Z e Z e Z e Z e Z d � Z RS( s� Base class for option objects that are passed to ORM queries. These options may be consumed by :meth:`.Query.options`, :meth:`.Select.options`, or in a more general sense by any :meth:`.Executable.options` method. They are interpreted at statement compile time or execution time in modern use. The deprecated :class:`.MapperOption` is consumed at ORM query construction time. .. versionadded:: 1.4 c C@ s | d k r | S| Sd S( sf given "self" which is an option from a cached query, as well as the corresponding option from the uncached version of the same query, return the option we should use in a new query, in the context of a loader strategy being asked to load related rows on behalf of that cached query, which is assumed to be building a new query based on entities passed to us from the cached query. Currently this routine chooses between "self" and "uncached" without manufacturing anything new. If the option is itself a loader strategy option which has a path, that path needs to match to the entities being passed to us by the cached query, so the :class:`_orm.Load` subclass overrides this to return "self". For all other options, we return the uncached form which may have changing state, such as a with_loader_criteria() option which will very often have new state. This routine could in the future involve generating a new option based on both inputs if use cases arise, such as if with_loader_criteria() needed to match up to ``AliasedClass`` instances given in the parent query. However, longer term it might be better to restructure things such that ``AliasedClass`` entities are always matched up on their cache key, instead of identity, in things like paths and such, so that this whole issue of "the uncached option does not match the entities" goes away. However this would make ``PathRegistry`` more complicated and difficult to debug as well as potentially less performant in that it would be hashing enormous cache keys rather than a simple AliasedInsp. UNLESS, we could get cache keys overall to be reliably hashed into something like an md5 key. .. versionadded:: 1.4.41 N( R^ ( R( R+ t uncached_opt( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt' _adapt_cached_option_to_uncached_option� s # ( ( R R RT RU R@ t _is_legacy_optiont propagate_to_loaderst _is_compile_statet _is_criteria_optiont _is_strategy_optionR� ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� � s t CompileStateOptionc B@ s& e Z d Z e Z d � Z d � Z RS( s� base for :class:`.ORMOption` classes that affect the compilation of a SQL query and therefore need to be part of the cache key. .. note:: :class:`.CompileStateOption` is generally non-public and should not be used as a base class for user-defined options; instead, use :class:`.UserDefinedOption`, which is easier to use as it does not interact with ORM compilation internals or caching. :class:`.CompileStateOption` defines an internal attribute ``_is_compile_state=True`` which has the effect of the ORM compilation routines for SELECT and other statements will call upon these options when a SQL string is being compiled. As such, these classes implement :class:`.HasCacheKey` and need to provide robust ``_cache_key_traversal`` structures. The :class:`.CompileStateOption` class is used to implement the ORM :class:`.LoaderOption` and :class:`.CriteriaOption` classes. .. versionadded:: 1.4.28 c C@ s d S( s7 Apply a modification to a given :class:`.CompileState`.N( ( R( t compile_state( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt process_compile_state8 R1 c C@ s d S( s� Apply a modification to a given :class:`.CompileState`, given entities that were replaced by with_only_columns() or with_entities(). .. versionadded:: 1.4.19 N( ( R( R� t mapper_entities( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt' process_compile_state_replaced_entities; R1 ( R R RT RB R� R� R� ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� s c B@ s e Z d Z d � Z d � Z RS( sh Describe a loader modification to an ORM statement at compilation time. .. versionadded:: 1.4 c C@ s | j | � d S( s� Apply a modification to a given :class:`.CompileState`, given entities that were replaced by with_only_columns() or with_entities(). .. versionadded:: 1.4.19 N( R� ( R( R� R� ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� N s c C@ s d S( s7 Apply a modification to a given :class:`.CompileState`.N( ( R( R� ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� Z R1 ( R R RT R� R� ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR G s t CriteriaOptionc B@ s& e Z d Z e Z d � Z d � Z RS( st Describe a WHERE criteria modification to an ORM statement at compilation time. .. versionadded:: 1.4 c C@ s d S( s7 Apply a modification to a given :class:`.CompileState`.N( ( R( R� ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� h R1 c C@ s d S( s_ update additional entity criteria options in the given attributes dictionary. N( ( R( R� ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt get_global_criteriak R1 ( R R RT RB R� R� R� ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� ^ s t UserDefinedOptionc B@ s& e Z d Z e Z e Z d d � Z RS( s~ Base class for a user-defined option that can be consumed from the :meth:`.SessionEvents.do_orm_execute` event hook. c C@ s | | _ d S( N( t payload( R( R� ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRA � s N( R R RT R@ R� R� R^ RA ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� r s s 1.4sK The :class:`.MapperOption class is deprecated and will be removed in a future release. For modifications to queries on a per-execution basis, use the :class:`.UserDefinedOption` class to establish state within a :class:`.Query` or other Core statement, then use the :meth:`.SessionEvents.before_orm_execute` hook to consume them.t constructorc B@ s, e Z d Z e Z e Z d � Z d � Z RS( s" Describe a modification to a Queryc C@ s d S( s8 Apply a modification to the given :class:`_query.Query`.N( ( R( t query( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt process_query� R1 c C@ s | j | � d S( so same as process_query(), except that this option may not apply to the given query. This is typically applied during a lazy load or scalar refresh operation to propagate options stated in the original Query to the new Query being used for the load. It occurs for those options that specify propagate_to_loaders=True. N( R� ( R( R� ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt process_query_conditionally� s ( R R RT RB R� R@ R� R� R� ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR � s c B@ sA e Z d Z d Z d � Z d � Z d � Z d � Z d � Z RS( s� Describe the loading behavior of a StrategizedProperty object. The ``LoaderStrategy`` interacts with the querying process in three ways: * it controls the configuration of the ``InstrumentedAttribute`` placed on a class to handle the behavior of the attribute. this may involve setting up class-level callable functions to fire off a select operation when the attribute is first accessed (i.e. a lazy load) * it processes the ``QueryContext`` at statement construction time, where it can modify the SQL statement that is being produced. For example, simple column attributes will add their represented column to the list of selected columns, a joined eager loader may establish join clauses to add to the statement. * It produces "row processor" functions at result fetching time. These "row processor" functions populate a particular attribute on a particular mapped instance. t parent_propertyt is_class_levelR$ R% R� t strategy_optsc C@ sL | | _ t | _ | j j | _ | j j | _ | | _ t | � | _ d S( N( R� R@ R� R$ R% R� R� R� ( R( R$ R� ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRA � s c C@ s d S( N( ( R( R2 ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� � s c K@ s d S( s� Establish column and other state for a given QueryContext. This method fulfills the contract specified by MapperProperty.setup(). StrategizedProperty delegates its setup() method directly to this method. N( ( R( R� R, R- t loadoptR. R/ ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR� � R1 c C@ s d S( s Establish row processing functions for a given QueryContext. This method fulfills the contract specified by MapperProperty.create_row_processor(). StrategizedProperty delegates its create_row_processor() method directly to this method. N( ( R( R+ R, R- R� R2 R3 R. R4 ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR5 � R1 c C@ s t | j � S( N( t strR� ( R( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt __str__� s ( R� R� R$ R% R� R� ( R R RT RU RA R� R� R5 R� ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR � s (6 RT t __future__R R� R1 R R� R t baseR R R R R R R R R R R R R t sqlR R R t sql.baseR t sql.traversalsR t __all__t StatementRoleR t ColumnsClauseRoleR R t StrictFromClauseRoleR! t _self_inspectst MemoizedSlotsR t ColumnOperatorsR R R� R� R R� R� t deprecated_clsR^ R t objectR ( ( ( sL /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt <module> sp "� � �H)