U x^n@s4dZddlmZddlmZddlmZddlmZddlmZddlm Z dd lm Z dd lm Z dd lm Z dd lmZdd lmZddlmZGdddeZejjdddGdddeZejjdddGdddeZejjdddGdddeZejjdddeddGdddeZdS)zDescriptor properties are more "auxiliary" properties that exist as configurational elements, but don't participate as actively in the load/persist ORM loop. ) attributes) properties)query)MapperProperty)PropComparator) _none_set)event)exc)schema)sql)util) expressionc@s eZdZdZdZdZddZdS)DescriptorPropertyzS:class:`.MapperProperty` which proxies access to a user-defined descriptor.NFcsGfdddt}jdkrBtjjd}|rB|_jdkrfdd}fdd}fdd}t|||d _tjj jjjfd d j d }|j|_ j j|dS) NcsLeZdZdZdZdZefddZddZe drHe j ffdd Z d S) z7DescriptorProperty.instrument_class.._ProxyImplFTcsjSN) uses_objectsselfpropG/tmp/pip-install-dq5v43_d/SQLAlchemy/sqlalchemy/orm/descriptor_props.pyr,szDDescriptorProperty.instrument_class.._ProxyImpl.uses_objectscSs ||_dSrkey)rrrrr__init__0sz@DescriptorProperty.instrument_class.._ProxyImpl.__init__ get_historycs|||Sr)r)rstatedict_passiverrrr5szCDescriptorProperty.instrument_class.._ProxyImpl.get_historyN) __name__ __module__ __qualname__Zaccepts_scalar_loaderZexpire_missingZ collectionpropertyrrhasattrr PASSIVE_OFFrrrrr _ProxyImpl's r%cst|j|dSr)setattrname)objvaluerrrfsetAsz1DescriptorProperty.instrument_class..fsetcst|jdSr)delattrr'r(rrrfdelDsz1DescriptorProperty.instrument_class..fdelcs t|jSr)getattrr'r,rrrfgetGsz1DescriptorProperty.instrument_class..fget)r/r*r-cs Sr)_comparator_factoryr)mapperrrrPz5DescriptorProperty.instrument_class..)docZoriginal_property)object descriptorr.class_rZ_is_userland_descriptorr"rZcreate_proxied_attributeparentr4implZ class_managerZinstrument_attribute)rr1r%descr*r-r/Z proxy_attrr)r1rrrinstrument_class$s*         z#DescriptorProperty.instrument_class)rr r!__doc__r4rr;rrrrrsrzsqlalchemy.orm.propertiesT)Z add_to_allcseZdZdZejddfddZfddZdd Zd d Z ej d d Z ej ddZ e ddZddZddZej ddZejfddZddZGdddejZGdddeZd d!ZZS)"CompositePropertyzDefines a "composite" mapped attribute, representing a collection of columns as one attribute. :class:`.CompositeProperty` is constructed using the :func:`.composite` function. .. seealso:: :ref:`mapper_composite` )0.7z:class:`.AttributeExtension` is deprecated in favor of the :class:`.AttributeEvents` listener interface. The :paramref:`.composite.extension` parameter will be removed in a future release.) extensioncstt|||_||_|dd|_|dd|_|dd|_| d|j j |_ d|krj| d|_ t||dS)aQReturn a composite column-based property for use with a Mapper. See the mapping documentation section :ref:`mapper_composite` for a full usage example. The :class:`.MapperProperty` returned by :func:`.composite` is the :class:`.CompositeProperty`. :param class\_: The "composite type" class, or any classmethod or callable which will produce a new instance of the composite object given the column values in order. :param \*cols: List of Column objects to be mapped. :param active_history=False: When ``True``, indicates that the "previous" value for a scalar attribute should be loaded when replaced, if not already loaded. See the same flag on :func:`.column_property`. :param group: A group name for this property when marked as deferred. :param deferred: When True, the column property is "deferred", meaning that it does not load immediately, and is instead loaded when the attribute is first accessed on an instance. See also :func:`~sqlalchemy.orm.deferred`. :param comparator_factory: a class which extends :class:`.CompositeProperty.Comparator` which provides custom SQL clause generation for comparison operations. :param doc: optional string that will be applied as the doc on the class-bound descriptor. :param info: Optional data dictionary which will be populated into the :attr:`.MapperProperty.info` attribute of this object. :param extension: an :class:`.AttributeExtension` instance, or list of extensions, which will be prepended to the list of attribute listeners for the resulting descriptor placed on the class. active_historyFdeferredgroupNcomparator_factoryinfo)superr=rattrscomposite_classgetr@rArBpop __class__ ComparatorrCrDr set_creation_order_create_descriptor)rr7rFkwargsrJrrrfs:  zCompositeProperty.__init__cstt|||dSr)rEr=r;_setup_event_handlersrr1rOrrr;sz"CompositeProperty.instrument_classcCs |dS)zInitialization which occurs after the :class:`.CompositeProperty` has been associated with its parent mapper. N)_setup_arguments_on_columnsrrrrdo_initszCompositeProperty.do_initcs6fdd}fdd}fdd}t|||_dS)ztCreate the Python descriptor that will serve as the access point on instances of the mapped class. cst}t}j|krvfddjD}j|krv|jdk sPt|svj||j<|jj |djg| jdS)Ncsg|]}t|qSr)r..0rinstancerr szFCompositeProperty._create_descriptor..fget..) r instance_dictinstance_stater_attribute_keysr issupersetrGmanagerdispatchrefreshrH)rWrrvaluesrrVrr/s     z2CompositeProperty._create_descriptor..fgetcst|}t|}|jj}|jtj}|jjD]}|||||j }q8||j<|dkrzj D]}t ||dqfn&t j | D]\}}t |||qdSr)rrYrZr]rrHNO_VALUEr^setr9r[r&zip__composite_values__)rWr)rrattrpreviousfnrrrrr*s       z2CompositeProperty._create_descriptor..fsetcs^t|}t|}|jtj}|jj}|j|||j j D]}t ||dqHdSr) rrZrYrIrrar]r^remover9r[r&)rWrrrfrerrrrr-s    z2CompositeProperty._create_descriptor..fdelN)r"r6)rr/r*r-rrrrMs   z$CompositeProperty._create_descriptorcsfddjDS)Ncsg|]}tjj|jqSr)r.r8r7rrUrrrrrXsz:CompositeProperty._comparable_elements..propsrrrr_comparable_elementssz&CompositeProperty._comparable_elementscCsxg}|jD]h}t|tr*|jj|dd}n>t|tjrD|jj|}n$t|tj rX|j }nt d|f| |q |S)NF)Z_configure_mappersz[Composite expects Column objects or mapped attributes/attribute names as arguments, got: %r)rF isinstancestrr8Z get_propertyr Column_columntopropertyrZInstrumentedAttributer"sa_exc ArgumentErrorappend)rrkrerrrrrks     zCompositeProperty.propscCsdd|jDS)NcSsg|]}t|tjr|qSr)rmr ro)rUarrrrXs z-CompositeProperty.columns..)rFrrrrcolumns szCompositeProperty.columnscCs4|jD](}|j|_|jr&|j|_d|_|j|_qdS)zwPropagate configuration arguments made on this composite to the target columns, for those that apply. ))rAT)Z instrumentTN)rkr@rAZ strategy_keyrB)rrrrrrRs  z-CompositeProperty._setup_arguments_on_columnscsfdd}fdd}fddfdd}fd d }tjjd |d d tjjd|d d tjjd|d d dtjjd|d d dtjjd|d d ddS)z>Establish events that populate/expire the composite attribute.cs||dddS)NF is_refreshrrargs_load_refresh_handlerrr load_handler sz=CompositeProperty._setup_event_handlers..load_handlercs||dddS)NTrvrrxrzrrrefresh_handler#sz@CompositeProperty._setup_event_handlers..refresh_handlercsVj}|sj|krdSjD]}||krdSqjfddjD|j<dS)Ncsg|]}j|qSr)dictrTrrrrX4szZCompositeProperty._setup_event_handlers.._load_refresh_handler..)r~rr[rG)rryrwrkrrrr{&s zFCompositeProperty._setup_event_handlers.._load_refresh_handlercs,|dkstj|r(|jjddSr)rbr[ intersectionr~rIr)rkeysrrrexpire_handler7sz?CompositeProperty._setup_event_handlers..expire_handlercs|jjddS)zAfter an insert or update, some columns may be expired due to server side defaults, or re-populated due to client side defaults. Pop out the composite value here so that it recreates. N)r~rIr)r1 connectionrrrrinsert_update_handler;szFCompositeProperty._setup_event_handlers..insert_update_handlerZ after_insertT)rawZ after_updateload)r propagater_ZexpireN)r listenr8)rr|r}rrr)r{rrrPsL     z'CompositeProperty._setup_event_handlerscCsdd|jDS)NcSsg|] }|jqSrrrirrrrXYsz5CompositeProperty._attribute_keys..rjrrrrr[Wsz!CompositeProperty._attribute_keysc Csg}g}d}|jD]j}|j}|j|j||} | rProvided for userland code that uses attributes.get_history().FTNr) rkrr]r9rZ has_changes non_deletedextendrsdeletedrZHistoryrG) rrrraddedrZ has_historyrrhistrrrrr[s,      zCompositeProperty.get_historycCs |||SrrCrQrrrr0{sz%CompositeProperty._comparator_factorycs$eZdZfddZddZZS)z!CompositeProperty.CompositeBundlecs$||_ttj|j|jf|dSr)r"rEr=CompositeBundlerr)rZ property_exprrOrrrs  z*CompositeProperty.CompositeBundle.__init__csfdd}|S)NcsjjfddDS)Ncsg|] }|qSrr)rUprocrowrrrXszXCompositeProperty.CompositeBundle.create_row_processor..proc..)r"rGrprocsrrrrszDCompositeProperty.CompositeBundle.create_row_processor..procr)rrrlabelsrrrrcreate_row_processorsz6CompositeProperty.CompositeBundle.create_row_processor)rr r!rr __classcell__rrrOrr~s rc@sVeZdZdZdZeddZddZddZd d Z e j d d Z d dZ ddZdS)zCompositeProperty.ComparatoraProduce boolean, comparison, and other operators for :class:`.CompositeProperty` attributes. See the example in :ref:`composite_operations` for an overview of usage , as well as the documentation for :class:`.PropComparator`. .. seealso:: :class:`.PropComparator` :class:`.ColumnOperators` :ref:`types_operators` :attr:`.TypeEngine.comparator_factory` NcCs|Sr)__clause_element__rrrrclausessz$CompositeProperty.Comparator.clausescCstj|jddiS)NrBF)rZ ClauseListrlrrrrrs z/CompositeProperty.Comparator.__clause_element__cCst|j|Sr)r=rrrrrrr_query_clause_elementsz2CompositeProperty.Comparator._query_clause_elementcCsT|dkrdd|jjD}n,t||jjr4|}ntd|j|ft|j|S)NcSsg|]}dqSrrrTrrrrXszDCompositeProperty.Comparator._bulk_update_tuples..z)Can't UPDATE composite attribute %s to %r) rr[rmrGrdrqrrrcrl)rr)r`rrr_bulk_update_tupless z0CompositeProperty.Comparator._bulk_update_tuplescs(jrfddjjDSjjSdS)Ncsg|]}tjj|jqSr)r._adapt_to_entityentityrrirrrrXszECompositeProperty.Comparator._comparable_elements..)rrrlrrrrrls  z1CompositeProperty.Comparator._comparable_elementscs^|dkrdgtjj}n|}ddtjj|D}jrTfdd|D}tj|S)NcSsg|]\}}||kqSrr)rUrtbrrrrXsz7CompositeProperty.Comparator.__eq__..csg|]}|qSr)adapter)rUxrrrrXs)lenrrlrdrcrr and_)rotherr`Z comparisonsrrr__eq__s z#CompositeProperty.Comparator.__eq__cCst||Sr)r not_r)rrrrr__ne__sz#CompositeProperty.Comparator.__ne__)rr r!r<__hash__r"rrrrr memoized_propertyrlrrrrrrrKs    rKcCst|jjjd|jS)N.)rnr8r7rrrrrr__str__szCompositeProperty.__str__)rr r!r<r Zdeprecated_paramsrr;rSrMrrlrkr"rurRrPr[rr$rr0rZBundlerrrKrrrrrOrr=Xs.  A ;    :  Ir=cs(eZdZdZddZfddZZS)ConcreteInheritedPropertya4A 'do nothing' :class:`.MapperProperty` that disables an attribute on a concrete subclass that is only present on the inherited mapper, not the concrete classes' mapper. Cases where this occurs include: * When the superclass mapper is mapped against a "polymorphic union", which includes all attributes from all subclasses. * When a relationship() is configured on an inherited mapper, but not on the subclass mapper. Concrete mappers require that relationship() is configured explicitly on each subclass. cCs8d}|jD]$}|j|j}t|ts|j}q4q|Sr)r8Ziterate_to_rootZ_propsrrmrrC)rr1Zcomparator_callablemprrrr0s  z-ConcreteInheritedProperty._comparator_factorycs<ttfddGfdddt}|_dS)NcstdjjjfdS)NzgConcrete %s does not implement attribute %r at the instance level. Add this property explicitly to %s.)AttributeErrorr8rrrrrwarns z0ConcreteInheritedProperty.__init__..warncs2eZdZfddZfddZfddZdS)zDConcreteInheritedProperty.__init__..NoninheritedConcretePropcs dSrr)sr(r)rrr__set__szLConcreteInheritedProperty.__init__..NoninheritedConcreteProp.__set__cs dSrr)rr(rrr __delete__szOConcreteInheritedProperty.__init__..NoninheritedConcreteProp.__delete__cs|dkrjSdSr)r6)rr(ownerrrrr__get__szLConcreteInheritedProperty.__init__..NoninheritedConcreteProp.__get__N)rr r!rrrrrrrNoninheritedConcreteProps  r)rErrr5r6)rrrOrrrs  z"ConcreteInheritedProperty.__init__)rr r!r<r0rrrrrOrrs rcsPeZdZdfdd ZeddZejddZdd Z d d Z d d Z Z S)SynonymPropertyNcsRtt|||_||_||_||_|p6|r4|jp6d|_|rD||_ t |dS)a}Denote an attribute name as a synonym to a mapped property, in that the attribute will mirror the value and expression behavior of another attribute. e.g.:: class MyClass(Base): __tablename__ = 'my_table' id = Column(Integer, primary_key=True) job_status = Column(String(50)) status = synonym("job_status") :param name: the name of the existing mapped property. This can refer to the string name ORM-mapped attribute configured on the class, including column-bound attributes and relationships. :param descriptor: a Python :term:`descriptor` that will be used as a getter (and potentially a setter) when this attribute is accessed at the instance level. :param map_column: **For classical mappings and mappings against an existing Table object only**. if ``True``, the :func:`.synonym` construct will locate the :class:`.Column` object upon the mapped table that would normally be associated with the attribute name of this synonym, and produce a new :class:`.ColumnProperty` that instead maps this :class:`.Column` to the alternate name given as the "name" argument of the synonym; in this way, the usual step of redefining the mapping of the :class:`.Column` to be under a different name is unnecessary. This is usually intended to be used when a :class:`.Column` is to be replaced with an attribute that also uses a descriptor, that is, in conjunction with the :paramref:`.synonym.descriptor` parameter:: my_table = Table( "my_table", metadata, Column('id', Integer, primary_key=True), Column('job_status', String(50)) ) class MyClass(object): @property def _job_status_descriptor(self): return "Status: %s" % self._job_status mapper( MyClass, my_table, properties={ "job_status": synonym( "_job_status", map_column=True, descriptor=MyClass._job_status_descriptor) } ) Above, the attribute named ``_job_status`` is automatically mapped to the ``job_status`` column:: >>> j1 = MyClass() >>> j1._job_status = "employed" >>> j1.job_status Status: employed When using Declarative, in order to provide a descriptor in conjunction with a synonym, use the :func:`sqlalchemy.ext.declarative.synonym_for` helper. However, note that the :ref:`hybrid properties ` feature should usually be preferred, particularly when redefining attribute behavior. :param info: Optional data dictionary which will be populated into the :attr:`.InspectionAttr.info` attribute of this object. .. versionadded:: 1.0.0 :param comparator_factory: A subclass of :class:`.PropComparator` that will provide custom comparison behavior at the SQL expression level. .. note:: For the use case of providing an attribute which redefines both Python-level and SQL-expression level behavior of an attribute, please refer to the Hybrid attribute introduced at :ref:`mapper_hybrids` for a more effective technique. .. seealso:: :ref:`synonyms` - Overview of synonyms :func:`.synonym_for` - a helper oriented towards Declarative :ref:`mapper_hybrids` - The Hybrid Attribute extension provides an updated approach to augmenting attribute behavior more flexibly than can be achieved with synonyms. N) rErrr' map_columnr6rCr<r4rDr rL)rr'rr6rCr4rDrOrrrslzSynonymProperty.__init__cCst|jj|jjjSr)r.r8r7r'r9rrrrrrszSynonymProperty.uses_objectscCsHt|jj|j}t|dr&t|jtsBt d|jjj |j|f|jS)Nr"zGsynonym() attribute "%s.%s" only supports ORM mapped attributes, got %r) r.r8r7r'r#rmr"rrqZInvalidRequestErrorr)rrerrr_proxied_propertys z!SynonymProperty._proxied_propertycCs*|j}|jr|||}n |||}|Sr)rrC)rr1rcomprrrr0s  z#SynonymProperty._comparator_factorycOst|jj|j}|jj||Sr)r.r8r7r'r9r)rargkwrerrrrszSynonymProperty.get_historycCs|jr|j|jjkr2td|j|jj|jfnN|jj|j|jkr|j|jj|jj|jkrtd|j|j|j|jft |jj|j}|j |j||dd|j|_ ||_ dS)Nz>Can't compile synonym '%s': no column on table '%s' named '%s'zpCan't call map_column=True for synonym %r=%r, a ColumnProperty already exists keyed to the name %r for column %rT)initZ setparent)rrZpersist_selectablecrqrrr' descriptionrprZColumnPropertyZ_configure_propertyZ_mapped_by_synonymr8)rr8rrrrr set_parents>   zSynonymProperty.set_parent)NNNNN) rr r!rr"rr rrr0rrrrrrOrrsx   rr>z:func:`.comparable_property` is deprecated and will be removed in a future release. Please refer to the :mod:`~sqlalchemy.ext.hybrid` extension.cs*eZdZdZdfdd ZddZZS)ComparablePropertyz;Instruments a Python property for use in query expressions.NcsFtt|||_||_|p*|r(|jp*d|_|r8||_t |dS)a Provides a method of applying a :class:`.PropComparator` to any Python descriptor attribute. Allows any Python descriptor to behave like a SQL-enabled attribute when used at the class level in queries, allowing redefinition of expression operator behavior. In the example below we redefine :meth:`.PropComparator.operate` to wrap both sides of an expression in ``func.lower()`` to produce case-insensitive comparison:: from sqlalchemy.orm import comparable_property from sqlalchemy.orm.interfaces import PropComparator from sqlalchemy.sql import func from sqlalchemy import Integer, String, Column from sqlalchemy.ext.declarative import declarative_base class CaseInsensitiveComparator(PropComparator): def __clause_element__(self): return self.prop def operate(self, op, other): return op( func.lower(self.__clause_element__()), func.lower(other) ) Base = declarative_base() class SearchWord(Base): __tablename__ = 'search_word' id = Column(Integer, primary_key=True) word = Column(String) word_insensitive = comparable_property(lambda prop, mapper: CaseInsensitiveComparator( mapper.c.word, mapper) ) A mapping like the above allows the ``word_insensitive`` attribute to render an expression like:: >>> print SearchWord.word_insensitive == "Trucks" lower(search_word.word) = lower(:lower_1) :param comparator_factory: A PropComparator subclass or factory that defines operator behavior for this property. :param descriptor: Optional when used in a ``properties={}`` declaration. The Python descriptor or property to layer comparison behavior on top of. The like-named descriptor will be automatically retrieved from the mapped class if left blank in a ``properties`` declaration. :param info: Optional data dictionary which will be populated into the :attr:`.InspectionAttr.info` attribute of this object. .. versionadded:: 1.0.0 N) rErrr6rCr<r4rDr rL)rrCr6r4rDrOrrrsBzComparableProperty.__init__cCs |||SrrrQrrrr0#sz&ComparableProperty._comparator_factory)NNN)rr r!r<rr0rrrrOrrs JrN)r<rrrZ interfacesrrr rr r rqr r rrZ langhelpersZdependency_forr=rrZdeprecated_clsrrrrrs:            <5?