ó H`¾Tc @s›dZddlmZmZddlmZmZmZm Z m Z ddl m Z ddl mZddlmZddlmZdd lZd d lmZmZmZmZd d lmZd d lmZd„Zd„Zdefd„ƒYZed„Z d„Z!de j"e#fd„ƒYZ$d d d e&ded ed„Z'd„Z(de&fd„ƒYZ)de)fd„ƒYZ*de&fd„ƒYZ+d S(s1Public API functions and helpers for declarative.i(tTabletMetaData(tsynonymtmappertcomparable_propertyt interfacest properties(tpolymorphic_union(t_mapper_or_none(t OrderedDict(texciÿÿÿÿNi(t_as_declarativet_declarative_constructort_DeferredMapperConfigt_add_attribute(t_class_resolver(t clsregistrycCsQd|jkr%tjd|ƒ‚n||_||_t||j|jƒdS(s‹Given a class, configure the class declaratively, using the given registry, which can be any dictionary, and MetaData object. t_decl_class_registrys4Class %r already has been instrumented declarativelyN(t__dict__R tInvalidRequestErrorRtmetadataR t__name__(tclstregistryR((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pytinstrument_declaratives   cCs8x1|jdD]"}t|ddƒdk rtSqWtS(svGiven a class, return True if any of the classes it inherits from has a mapped table, otherwise return False. it __table__N(t__mro__tgetattrtNonetTruetFalse(Rtclass_((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pythas_inherited_table*stDeclarativeMetacBseZd„Zd„ZRS(cCs?d|jkr%t|||jƒntj||||ƒdS(NR(RR ttypet__init__(Rt classnametbasestdict_((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyR#5scCst|||ƒdS(N(R(Rtkeytvalue((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyt __setattr__:s(Rt __module__R#R)(((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyR!4s cs‡‡fd†}|S(s&Decorator, make a Python @property a query synonym for a column. A decorator version of :func:`~sqlalchemy.orm.synonym`. The function being decorated is the 'descriptor', otherwise passes its arguments through to synonym():: @synonym_for('col') @property def prop(self): return 'special sauce' The regular ``synonym()`` is also usable directly in a declarative setting and may be convenient for read/write properties:: prop = synonym('col', descriptor=property(_read_prop, _write_prop)) cstˆdˆd|ƒS(Nt map_columnt descriptor(t _orm_synonym(tfn(R+tname(sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pytdecoratePs((R/R+R0((R+R/sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyt synonym_for>scs‡fd†}|S(s(Decorator, allow a Python @property to be used in query criteria. This is a decorator front end to :func:`~sqlalchemy.orm.comparable_property` that passes through the comparator_factory and the function being decorated:: @comparable_using(MyComparatorType) @property def prop(self): return 'special sauce' The regular ``comparable_property()`` is also usable directly in a declarative setting and may be convenient for read/write properties:: prop = comparable_property(MyComparatorType) cs tˆ|ƒS(N(R(R.(tcomparator_factory(sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyR0gs((R2R0((R2sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pytcomparable_usingUst declared_attrcBs eZdZd„Zd„ZRS(sJMark a class-level method as representing the definition of a mapped property or special declarative member name. @declared_attr turns the attribute into a scalar-like property that can be invoked from the uninstantiated class. Declarative treats attributes specifically marked with @declared_attr as returning a construct that is specific to mapping or declarative table configuration. The name of the attribute is that of what the non-dynamic version of the attribute would be. @declared_attr is more often than not applicable to mixins, to define relationships that are to be applied to different implementors of the class:: class ProvidesUser(object): "A mixin that adds a 'user' relationship to classes." @declared_attr def user(self): return relationship("User") It also can be applied to mapped classes, such as to provide a "polymorphic" scheme for inheritance:: class Employee(Base): id = Column(Integer, primary_key=True) type = Column(String(50), nullable=False) @declared_attr def __tablename__(cls): return cls.__name__.lower() @declared_attr def __mapper_args__(cls): if cls.__name__ == 'Employee': return { "polymorphic_on":cls.type, "polymorphic_identity":"Employee" } else: return {"polymorphic_identity":cls.__name__} .. versionchanged:: 0.8 :class:`.declared_attr` can be used with non-ORM or extension attributes, such as user-defined attributes or :func:`.association_proxy` objects, which will be assigned to the class at class construction time. cOs,tt|ƒj|||Ž|j|_dS(N(tsuperR4R#t__doc__(tselftfgettargtkw((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyR# scCs |j|ƒS(N(R8(tdescR7R((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyt__get__¤s(RR*R6R#R<(((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyR4ls2 tBasec Cs¦|p tƒ}|r!||_n|dkr<tjƒ}nt|tƒ rU|fpX|} td|d|ƒ} |rƒ|| d mapped classes when string names are used to identify classes inside of :func:`.relationship` and others. Allows two or more declarative base classes to share the same registry of class names for simplified inter-base relationships. :param metaclass: Defaults to :class:`.DeclarativeMeta`. A metaclass or __metaclass__ compatible callable to use as the meta type of the generated declarative base class. .. seealso:: :func:`.as_declarative` RRR#t__mapper_cls__N(RtbindRtweakreftWeakValueDictionaryt isinstancettupletdict( R?RRRR/t constructortclass_registryt metaclasst lcl_metadataR%t class_dict((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pytdeclarative_base¨s?      c s‡fd†}|S(sø Class decorator for :func:`.declarative_base`. Provides a syntactical shortcut to the ``cls`` argument sent to :func:`.declarative_base`, allowing the base class to be converted in-place to a "declarative" base:: from sqlalchemy.ext.declarative import as_declarative @as_declarative() class Base(object): @declared_attr def __tablename__(cls): return cls.__name__.lower() id = Column(Integer, primary_key=True) class MyMappedClass(Base): # ... All keyword arguments passed to :func:`.as_declarative` are passed along to :func:`.declarative_base`. .. versionadded:: 0.8.3 .. seealso:: :func:`.declarative_base` cs!|ˆd<|jˆdGsR"tpjoin(RR (Rtmappers((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyt_create_polymorphic_unionDs cCs^|j}|jrdSt|jƒ}|j|ƒ}|jd|fƒ|j|jjƒdS(Nt*( t __mapper__twith_polymorphictlisttself_and_descendantsRSt_set_with_polymorphict_set_polymorphic_ontcR"(RtmRRRQ((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyt__declare_first__Ks  (RR*R6t classmethodRSR](((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyRL s"tAbstractConcreteBasecBs#eZdZeZed„ƒZRS(súA helper class for 'concrete' declarative mappings. :class:`.AbstractConcreteBase` will use the :func:`.polymorphic_union` function automatically, against all tables mapped as a subclass to this class. The function is called via the ``__declare_last__()`` function, which is essentially a hook for the :meth:`.after_configured` event. :class:`.AbstractConcreteBase` does not produce a mapped table for the class itself. Compare to :class:`.ConcreteBase`, which does. Example:: from sqlalchemy.ext.declarative import AbstractConcreteBase class Employee(AbstractConcreteBase, Base): pass class Manager(Employee): __tablename__ = 'manager' employee_id = Column(Integer, primary_key=True) name = Column(String(50)) manager_data = Column(String(40)) __mapper_args__ = { 'polymorphic_identity':'manager', 'concrete':True} c Cst|dƒrdStj|j|ƒg}t|jƒƒ}xQ|r‘|jƒ}|j|jƒƒt|ƒ}|dk rA|j |ƒqAqAW|j |ƒ}t ||d|j jƒ|_}xN|jƒD]@}t|ƒ}|rÐ|jrÐ||jkrÐ|j|ƒqÐqÐWdS(NRUtpolymorphic_on(thasattrRt add_classRRWt__subclasses__tpoptextendRRtappendRSRR[R"RUtconcretet __bases__t_set_concrete_base( RRRtstacktklasstmnRQR\tsclstsm((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyR]xs"    " (RR*R6Rt __abstract__R^R](((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyR_WstDeferredReflectioncBsJeZdZed„ƒZed„ƒZed„ƒZed„ƒZRS(s¯ A helper class for construction of mappings based on a deferred reflection step. Normally, declarative can be used with reflection by setting a :class:`.Table` object using autoload=True as the ``__table__`` attribute on a declarative class. The caveat is that the :class:`.Table` must be fully reflected, or at the very least have a primary key column, at the point at which a normal declarative mapping is constructed, meaning the :class:`.Engine` must be available at class declaration time. The :class:`.DeferredReflection` mixin moves the construction of mappers to be at a later point, after a specific method is called which first reflects all :class:`.Table` objects created so far. Classes can define it as such:: from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.ext.declarative import DeferredReflection Base = declarative_base() class MyClass(DeferredReflection, Base): __tablename__ = 'mytable' Above, ``MyClass`` is not yet mapped. After a series of classes have been defined in the above fashion, all tables can be reflected and mappings created using :meth:`.prepare`:: engine = create_engine("someengine://...") DeferredReflection.prepare(engine) The :class:`.DeferredReflection` mixin can be applied to individual classes, used as the base for the declarative base itself, or used in a custom abstract class. Using an abstract base allows that only a subset of classes to be prepared for a particular prepare step, which is necessary for applications that use more than one engine. For example, if an application has two engines, you might use two bases, and prepare each separately, e.g.:: class ReflectedOne(DeferredReflection, Base): __abstract__ = True class ReflectedTwo(DeferredReflection, Base): __abstract__ = True class MyClass(ReflectedOne): __tablename__ = 'mytable' class MyOtherClass(ReflectedOne): __tablename__ = 'myothertable' class YetAnotherClass(ReflectedTwo): __tablename__ = 'yetanothertable' # ... etc. Above, the class hierarchies for ``ReflectedOne`` and ``ReflectedTwo`` can be configured separately:: ReflectedOne.prepare(engine_one) ReflectedTwo.prepare(engine_two) .. versionadded:: 0.8 cCsõtj|ƒ}xß|D]×}|j|j|ƒ|jƒ|jj}|jj}x™|j j ƒD]ˆ}t |t j ƒra|jdk rat |jtƒr°|j|j|ƒqét |jtƒré|jj|j||ƒf7_qéqaqaWqWdS(scReflect all :class:`.Table` objects for all current :class:`.DeferredReflection` subclassesN(R tclasses_for_baset_sa_decl_prepareRNtmapRRURRt_propstvaluesRBRtRelationshipPropertyt secondaryRRt_reflect_tableRt _resolverst_sa_deferred_table_resolver(Rtenginetto_maptthingyRRtrel((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pytprepare×s     cs‡‡‡fd†}|S(Ncs#t|ˆƒ}ˆj|ˆƒ|S(N(RRx(R'tt1(R{RR(sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyt_resolveîs((RR{RR((R{RRsd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyRzìscCs#|dk r|j||ƒndS(N(RRx(RRNR{((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyRrôs c Cs8t|j|jdtdtdtd|d|jƒdS(Ntextend_existingtautoload_replacetautoloadt autoload_withtschema(RR/RRRR†(RttableR{((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyRxýs  (RR*R6R^RRzRrRx(((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyRp“s C (,R6R†RRtormRR-RRRRtorm.utilRtorm.baseRtutilR tR R@tbaseR R R RRRRR R"R!RR1R3t_MappedAttributetpropertyR4RtobjectRJRKRLR_Rp(((sd/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/sqlalchemy/ext/declarative/api.pyts0( "    <  O &7<