H`Tc@@s0dZddlmZddlmZmZmZddlm Z ddl m Z ddl m Z mZmZmZmZmZdd l mZmZdd lmZdd l Z dZdeefdYZde jfdYZdefdYZdefdYZdefdYZd S( s Contains various base classes used throughout the ORM. Defines the now deprecated ORM extension classes as well as ORM internals. Other than the deprecated extensions, this module and the classes within should be considered mostly private. i(tabsolute_importi(texctutiltinspect(t operators(tdequei(t ONETOMANYt MANYTOONEt MANYTOMANYt EXT_CONTINUEtEXT_STOPt NOT_EXTENSION(t_InspectionAttrt_MappedAttribute(t PathRegistryNtAttributeExtensionR R RRRR tLoaderStrategytMapperExtensiont MapperOptiontMapperPropertytPropComparatortSessionExtensiontStrategizedPropertycB@seZdZeZeZdZdZdddZ dZ dZ e jdZeZeZdZedZd Zd Zd Zd Zd ZdZRS(s[Manage the relationship of a ``Mapper`` to a single class attribute, as well as that attribute as it appears on individual instances of the class, including attribute instrumentation, attribute access, loading behavior, and dependency calculations. The most common occurrences of :class:`.MapperProperty` are the mapped :class:`.Column`, which is represented in a mapping as an instance of :class:`.ColumnProperty`, and a reference to another class produced by :func:`.relationship`, represented in the mapping as an instance of :class:`.RelationshipProperty`. cK@sdS(sCalled 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((tselftcontexttentitytpathtadaptertkwargs((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytsetupJscC@sdS(sHReturn a 3-tuple consisting of three row processing functions. N(NNN(tNone(RRRtmappertrowR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytcreate_row_processorTscC@s tdS(sIterate 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. See PropertyLoader for the related instance implementation. ((titer(Rttype_tstatetvisited_instancesthalt_on((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytcascade_iterator[s cC@s ||_dS(N(tparent(RR(tinit((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt set_parentjscC@s tdS(N(tNotImplementedError(RR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytinstrument_classmscC@siS(sOInfo dictionary associated with the object, allowing user-defined data to be associated with this :class:`.MapperProperty`. The dictionary is generated when first accessed. Alternatively, it can be specified as a constructor argument to the :func:`.column_property`, :func:`.relationship`, or :func:`.composite` functions. .. versionadded:: 0.8 Added support for .info to all :class:`.MapperProperty` subclasses. .. seealso:: :attr:`.QueryableAttribute.info` :attr:`.SchemaItem.info` ((R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytinfopscC@s t|_|jt|_dS(sCalled after all mappers are created to assemble relationships between mappers and perform other post-mapper-creation initialization steps. N(tTruet_configure_startedtdo_initt_configure_finished(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR)s  cC@st|jj|jS(sReturn 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 (tgetattrR(tclass_tkey(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytclass_attributescC@sdS(sPerform subclass-specific initialization post-mapper-creation steps. This is a template method called by the ``MapperProperty`` object's init() method. N((R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR0s cC@sdS(sdPerform instrumentation adjustments that need to occur after init() has completed. N((RR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytpost_instrument_classscC@s |jj S(s-Return True if this ``MapperProperty``'s mapper is the primary mapper for its class. This flag is used to indicate that the ``MapperProperty`` can define attribute instrumentation for the class at the class level (as opposed to the individual instance level). (R(t non_primary(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt is_primarys cC@sdS(sdMerge the attribute represented by this ``MapperProperty`` from source to destination objectN((Rtsessiont source_statet source_dictt dest_statet dest_dicttloadt _recursive((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytmergescK@s||j|S(s{Return a compare operation for the columns represented by this ``MapperProperty`` to the given value, which may be a column value or an instance. 'operator' is an operator from the operators module, or from sql.Comparator. By default uses the PropComparator attached to this MapperProperty under the attribute name "comparator". (t comparator(Rtoperatortvaluetkw((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytcompares cC@s)d|jjt|t|ddfS(Ns<%s at 0x%x; %s>R4sno key(t __class__t__name__tidR2(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt__repr__s N(RGt __module__t__doc__t frozensettcascadeR.t is_propertyRR!RR'R*R,Rtmemoized_propertyR-tFalseR/R1R)tpropertyR5R0R6R8R@RERI(((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR2s(          cB@seZdZd dZdZdZdZedZ e j dZ e dZe dZe d Zd Zd d Zd d ZRS(sY Defines boolean, comparison, and other 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. See also: :class:`.ColumnProperty.Comparator` :class:`.RelationshipProperty.Comparator` :class:`.CompositeProperty.Comparator` :class:`.ColumnOperators` :ref:`types_operators` :attr:`.TypeEngine.comparator_factory` cC@s&||_|_||_||_dS(N(tpropRQt _parentmappert_adapt_to_entity(RRRt parentmappertadapt_to_entity((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt__init__<s cC@std|dS(Ns%r(R+(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt__clause_element__AscC@s |jS(N(RX(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt_query_clause_elementDscC@s|j|j|j|S(sReturn a copy of this PropComparator which will use the given :class:`.AliasedInsp` to produce corresponding expressions. (RFRRRS(RRV((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRVGscC@s!|jdkrdS|jjSdS(srProduce a callable that adapts column expressions to suit an aliased version of this comparator. N(RTRt_adapt_element(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRMscC@s |jjS(N(RQR-(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR-XscK@s|j||S(N(tany(tatbR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytany_op\scK@s|j||S(N(thas(R\R]R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pythas_op`scC@s |j|S(N(tof_type(R\R3((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt of_type_opdscC@s|jtj|S(sRedefine this object in terms of a polymorphic subclass. 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. (toperateRRb(RR3((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRahscK@s|jtj||S(sReturn 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. (RcRR^(Rt criterionR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR[{scK@s|jtj||S(sReturn 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. (RcRR`(RRdR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR_sN(RGRJRKRRWRXRYRVRQRRROR-t staticmethodR^R`RbRaR[R_(((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRsW       cB@seZdZd ZdZdZdZdZdZ dZ dZ e j eZedZed ZRS( sA 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. cC@s_d}tj||}x@|j|j|jfD]&}||jkr1|j|}Pq1q1W|S(N(Rtdictt __getitem__t _loader_keyt_wildcard_path_loader_keyt_default_path_loader_keyt attributes(RRRR>t search_pathtpath_key((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt_get_context_loaders cC@sYy|j|SWnCtk rT|j|}|||j|<|j|<}|SXdS(N(t _strategiestKeyErrort_strategy_lookup(RR4tclststrategy((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt _get_strategys  "cC@s|j|jdS(Ni(Rtt_strategy_keys(RRr((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt_get_strategy_by_clsscK@s_|j||}|r6|jr6|j|j}n |j}|j||||||dS(N(RnRsRtt setup_query(RRRRRRtloadertstrat((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRs  cC@s[|j||}|r6|jr6|j|j}n |j}|j||||||S(N(RnRsRtR!(RRRRR RRxRy((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR!s  cC@s"i|_|j|j|_dS(N(RoRvtstrategy_classRs(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR0s cC@s9|jr5|jj|j r5|jj|ndS(N(R8t class_managert_attr_has_implR4Rstinit_class_attribute(RR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR6s c @sfd}|S(Nc@sFg|_ttj}|j|<|jj||S(N(RuttupletsortedtitemsRotappend(tdec_clsR4(RDRr(s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytdecorates  ((RrRDR((RDRrs_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt strategy_forscG@smxP|jD]E}||jkr |j|}y ||SWqOtk rKqOXq q Wtd||fdS(Nscan't locate strategy for %s %s(t__mro__RoRpt Exception(RrR4tprop_clst strategies((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRqs    N(RGRJRKRtstrategy_wildcard_keyRnRtRvRR!R0R6t collectionst defaultdictRfRot classmethodRRq(((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRs      cB@s&eZdZeZdZdZRS(s#Describe a modification to a Query.cC@sdS(N((Rtquery((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt process_queryscC@s|j|dS(ssame as process_query(), except that this option may not apply to the given query. Used when secondary loaders resend existing options to a new Query.N(R(RR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pytprocess_query_conditionally s(RGRJRKRPtpropagate_to_loadersRR(((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRs cB@s;eZdZdZdZdZdZdZRS(sDescribe 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. Simple column attributes may add their represented column to the list of selected columns, *eager loading* properties may add ``LEFT OUTER JOIN`` clauses 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. cC@s4||_t|_|jj|_|jj|_dS(N(tparent_propertyRPtis_class_levelR(R4(RR(((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRW+s  cC@sdS(N((RR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR}1scK@sdS(N((RRRRtloadoptRR((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRw4scC@sdS(sReturn row processing functions which fulfill the contract specified by MapperProperty.create_row_processor. StrategizedProperty delegates its create_row_processor method directly to this method. N(NNN(R(RRRRRR R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyR!7scC@s t|jS(N(tstrR(R((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyt__str__As(RGRJRKRWR}RwR!R(((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyRs     (Rs EXT_CONTINUEsEXT_STOPs ONETOMANYs MANYTOMANYs MANYTOONEs NOT_EXTENSIONsLoaderStrategyRs MapperOptionsMapperPropertysPropComparatorRsStrategizedProperty(RKt __future__RtRtsa_excRRtsqlRRRtbaseRRRR R R R R t path_registryRt__all__RtColumnOperatorsRRtobjectRR(((s_/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/orm/interfaces.pyts6. ^