o y\Al@s(dZddlmZddlmZddlmZddlmZddlmZddlm Z dd lm Z dd lm Z dd lm Z dd lmZdd lmZddlmZGdddeZejjdddGdddeZejjdddGdddeZejjdddGdddeZejjdddGdddeZdS)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@seZdZdZdZddZdS)DescriptorPropertyzS:class:`.MapperProperty` which proxies access to a user-defined descriptor.NcsGfdddt}jdur!tjjd}|r!|_jdur@fdd}fdd}fdd}t|||d _tjj jjjfd d j d }|j|_ j j|dS) Ncs@eZdZdZdZdZddZedrej ffdd Z dSdS) z7DescriptorProperty.instrument_class.._ProxyImplFTcSs ||_dSNkey)selfrrQ/var/www/html/env/lib/python3.10/site-packages/sqlalchemy/orm/descriptor_props.py__init__* z@DescriptorProperty.instrument_class.._ProxyImpl.__init__ get_historycs|||Sr)r)rstatedict_passiveproprrr/szCDescriptorProperty.instrument_class.._ProxyImpl.get_historyN) __name__ __module__ __qualname__accepts_scalar_loaderexpire_missing collectionrhasattrr PASSIVE_OFFrrrrr _ProxyImpl%s r&cst|j|dSr)setattrname)objvaluerrrfset;z1DescriptorProperty.instrument_class..fsetcst|jdSr)delattrr(r)r+rrfdel>z1DescriptorProperty.instrument_class..fdelcs t|jSr)getattrr(r/r+rrfgetA z1DescriptorProperty.instrument_class..fget)r3r,r0cs Sr)_comparator_factoryr)mapperrrrJs z5DescriptorProperty.instrument_class..)docoriginal_property)object descriptorr2class_r_is_userland_descriptorpropertyrcreate_proxied_attributeparentr8impl class_managerinstrument_attribute)rr6r&descr,r0r3 proxy_attrr)r6rrrinstrument_class"s*         z#DescriptorProperty.instrument_class)rrr __doc__r8rFrrrrrs rzsqlalchemy.orm.propertiesT) add_to_allcseZdZdZfddZfddZddZdd Zej d d Z ej d d Z e ddZ ddZddZej ddZejfddZddZGdddejZGdddeZddZZS) 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` cstt|||_||_|dd|_|dd|_|dd|_| d|j j |_ d|vr5| d|_ t||dS)apReturn 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. .. deprecated:: 0.7 :class:`.AttributeExtension` is deprecated in favor of the :class:`.AttributeEvents` listener interface. The :paramref:`.composite.extension` parameter will be removed in a future release. active_historyFdeferredgroupNcomparator_factoryinfo)superrIrattrscomposite_classgetrJrKrLpop __class__ ComparatorrMrNr set_creation_order_create_descriptor)rr<rPkwargsrTrrr`s8   zCompositeProperty.__init__cstt|||dSr)rOrIrF_setup_event_handlersrr6rYrrrFs z"CompositeProperty.instrument_classcCs |dS)zInitialization which occurs after the :class:`.CompositeProperty` has been associated with its parent mapper. N)_setup_arguments_on_columnsr+rrrdo_inits zCompositeProperty.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|vr;fddjD}j|vr;|jdus(t|s;j||j<|jj |djg| jdS)Ncsg|]}t|qSr)r2.0rinstancerr s zFCompositeProperty._create_descriptor..fget..) r instance_dictinstance_stater_attribute_keysr issupersetrQmanagerdispatchrefreshrR)rarrvaluesr+r`rr3s     z2CompositeProperty._create_descriptor..fgetcst|}t|}|jj}|jtj}|jjD] }|||||j }q||j<|dur>j D]}t ||dq3dSt j | D] \}}t |||qFdSr)rrcrdrgrrRNO_VALUErhsetrArer'zip__composite_values__)rar*rrattrpreviousfnrr+rrr,s        z2CompositeProperty._create_descriptor..fsetcs^t|}t|}|jtj}|jj}|j|||j j D]}t ||dq$dSr) rrdrcrSrrkrgrhremoverArer')rarrrprorr+rrr0s    z2CompositeProperty._create_descriptor..fdelN)r>r;)rr3r,r0rr+rrWs    z$CompositeProperty._create_descriptorcsfddjDS)Ncg|] }tjj|jqSr)r2r@r<rr_rr+rrrbz:CompositeProperty._comparable_elements..propsr+rr+r_comparable_elementssz&CompositeProperty._comparable_elementscCsxg}|jD]4}t|tr|jj|dd}nt|tjr"|jj|}nt|tj r,|j }nt d|f| |q|S)NF)_configure_mappersz[Composite expects Column objects or mapped attributes/attribute names as arguments, got: %r)rP isinstancestrr@ get_propertyr Column_columntopropertyrInstrumentedAttributer>sa_exc ArgumentErrorappend)rrwrorrrrrws     zCompositeProperty.propscCdd|jDS)NcSsg|] }t|tjr|qSr)rzr r})r_arrrrbruz-CompositeProperty.columns..)rPr+rrrcolumnszCompositeProperty.columnscCs4|jD]}|j|_|jr|j|_d|_|j|_qdS)zwPropagate configuration arguments made on this composite to the target columns, for those that apply. ))rKT) instrumentTN)rwrJrK strategy_keyrL)rrrrrr\ s  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.c||dddS)NF is_refreshrrargs_load_refresh_handlerrr load_handlerr-z=CompositeProperty._setup_event_handlers..load_handlercr)NTrrrrrrrefresh_handlerr-z@CompositeProperty._setup_event_handlers..refresh_handlercsVj}|s j|vr dSjD] }||vrdSqjfddjD|j<dS)Ncsg|]}j|qSr)dictr^rrrrb,zZCompositeProperty._setup_event_handlers.._load_refresh_handler..)rrrerQ)rrrrkr+rrrs zFCompositeProperty._setup_event_handlers.._load_refresh_handlercs0|dus tj|r|jjddSdSr)rlre intersectionrrSr)rkeysr+rrexpire_handler/sz?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)rrSr)r6 connectionrr+rrinsert_update_handler3szFCompositeProperty._setup_event_handlers..insert_update_handler after_insertT)raw after_updateload)r propagateriexpireN)r listenr@)rrrrrr)rrrrZs(           z'CompositeProperty._setup_event_handlerscCr)NcSsg|]}|jqSrrrtrrrrbQsz5CompositeProperty._attribute_keys..rvr+rrrreOrz!CompositeProperty._attribute_keysc Csg}g}d}|jD]5}|j}|j|j||} | rd}| } | r*|| n|d| j r9|| j q |dq |rPt |j |gd|j |gSt d|j |gdS)z>Provided for userland code that uses attributes.get_history().FTNr) rwrrgrAr has_changes non_deletedextendrdeletedrHistoryrQ) rrrraddedr has_historyrrhistrrrrrSs,      zCompositeProperty.get_historycC |||SrrMr[rrrr5sr4z%CompositeProperty._comparator_factorycs$eZdZfddZddZZS)z!CompositeProperty.CompositeBundlecs&||_ttj|j|jg|RdSr)r>rOrICompositeBundlerr)r property_exprrYrrrws   z*CompositeProperty.CompositeBundle.__init__csfdd}|S)NcsjjfddDS)Ncsg|]}|qSrr)r_procrowrrrbszXCompositeProperty.CompositeBundle.create_row_processor..proc..)r>rQrprocsrrrr~szDCompositeProperty.CompositeBundle.create_row_processor..procr)rrrlabelsrrrrcreate_row_processor}sz6CompositeProperty.CompositeBundle.create_row_processor)rrr rr __classcell__rrrYrrvs 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__r+rrrclausessz$CompositeProperty.Comparator.clausescCstj|jddiS)NrLF)r ClauseListrxr+rrrrs z/CompositeProperty.Comparator.__clause_element__cCst|j|Sr)rIrrrr+rrr_query_clause_elements z2CompositeProperty.Comparator._query_clause_elementcCsT|durdd|jjD}nt||jjr|}n td|j|ft|j|S)NcSsg|]}dqSrrr^rrrrbszDCompositeProperty.Comparator._bulk_update_tuples..z)Can't UPDATE composite attribute %s to %r) rrerzrQrnrrrmrx)rr*rjrrr_bulk_update_tupless  z0CompositeProperty.Comparator._bulk_update_tuplescs$jrfddjjDSjjS)Ncrsr)r2_adapt_to_entityentityrrtr+rrrbszECompositeProperty.Comparator._comparable_elements..)rrrxr+rr+rrxs  z1CompositeProperty.Comparator._comparable_elementscs^|durdgtjj}n|}ddtjj|D}jr*fdd|D}tj|S)NcSsg|]\}}||kqSrr)r_rbrrrrbs z7CompositeProperty.Comparator.__eq__..csg|]}|qSr)adapter)r_xr+rrrbr)lenrrxrnrmrr and_)rotherrj comparisonsrr+r__eq__s  z#CompositeProperty.Comparator.__eq__cCst||Sr)r not_r)rrrrr__ne__r1z#CompositeProperty.Comparator.__ne__)rrr rG__hash__r>rrrrr memoized_propertyrxrrrrrrrUs   rUcCst|jjjd|jS)N.)r{r@r<rrr+rrr__str__szCompositeProperty.__str__)rrr rGrrFr]rWr rrxrwr>rr\rZrerr%rr5rBundlerrrUrrrrrYrrIRs* H;    :  IrIcs(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. cCs:d}|jD]}|j|j}t|ts|j}|Sq|Sr)r@iterate_to_root_propsrrzrrM)rr6comparator_callablemprrrr5s  z-ConcreteInheritedProperty._comparator_factorycs<ttfddGfdddt}|_dS)Ncstdjjjf)NzgConcrete %s does not implement attribute %r at the instance level. Add this property explicitly to %s.)AttributeErrorr@rrr+rrwarns z0ConcreteInheritedProperty.__init__..warncs2eZdZfddZfddZfddZdS)zDConcreteInheritedProperty.__init__..NoninheritedConcretePropc dSrr)sr)r*rrr__set__rzLConcreteInheritedProperty.__init__..NoninheritedConcreteProp.__set__crrr)rr)rrr __delete__rzOConcreteInheritedProperty.__init__..NoninheritedConcreteProp.__delete__cs|durjSdSr)r;)rr)ownerrrrr__get__s zLConcreteInheritedProperty.__init__..NoninheritedConcreteProp.__get__N)rrr rrrrrrrNoninheritedConcreteProps  r)rOrrr:r;)rrrYrrrs  z"ConcreteInheritedProperty.__init__)rrr rGr5rrrrrYrrs rcsFeZdZ     d fdd ZejddZddZdd ZZ S) SynonymPropertyNcsRtt|||_||_||_||_|p|r|jpd|_|r"||_ 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) rOrrr( map_columnr;rMrGr8rNr rV)rr(rr;rMr8rNrYrrr slzSynonymProperty.__init__cCsHt|jj|j}t|drt|jts!t d|jjj |j|f|jS)Nr>zGsynonym() attribute "%s.%s" only supports ORM mapped attributes, got %r) r2r@r<r(r$rzr>rrInvalidRequestErrorr)rrorrr_proxied_propertys z!SynonymProperty._proxied_propertycCs,|j}|jr|||}|S|||}|Sr)rrM)rr6rcomprrrr5s   z#SynonymProperty._comparator_factorycCs|jrW|j|jjvrtd|j|jj|jf|jj|j|jvr?|j|jj|jj|jkr?td|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)init setparent)rr mapped_tablecrrr( descriptionr~rColumnProperty_configure_property_mapped_by_synonymr@)rr@rrrrr set_parents.  zSynonymProperty.set_parent)NNNNN) rrr rr rrr5rrrrrYrrs{   rcs,eZdZdZ dfdd ZddZZS)ComparablePropertyz;Instruments a Python property for use in query expressions.NcsFtt|||_||_|p|r|jpd|_|r||_t |dS)ak Provides a method of applying a :class:`.PropComparator` to any Python descriptor attribute. .. deprecated:: 0.7 :func:`.comparable_property` is superseded by the :mod:`~sqlalchemy.ext.hybrid` extension. See the example at :ref:`hybrid_custom_comparators`. 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) rOrrr;rMrGr8rNr rV)rrMr;r8rNrYrrrsFzComparableProperty.__init__cCrrrr[rrrr5 r4z&ComparableProperty._comparator_factory)NNN)rrr rGrr5rrrrYrrs NrN)rGrrr interfacesrrr rr r rr r rr langhelpersdependency_forrIrrrrrrrs4            650