JezK
Edit File: decl_api.pyc
� 1��fc @@ s` d Z d d l m Z d d l Z d d l 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 � Z! d e" f d � � YZ# e$ d � Z% d e j& e' f d � � YZ( d e( f d � � YZ) d! � Z* e+ e+ e+ e, d" e e+ e# d# � Z- d$ e, f d% � � YZ. e. � e _/ e j0 d& d' d( f � d) � � Z1 e j2 e# � d* � � Z3 d S(+ s1 Public API functions and helpers for declarative.i ( t absolute_importNi ( t attributes( t clsregistry( t exc( t instrumentation( t interfaces( t mapper( t _inspect_mapped_class( t _add_attribute( t _as_declarative( t _declarative_constructor( t _DeferredMapperConfig( t _del_attribute( t _mapper( t SynonymPropertyi ( t inspection( t util( t MetaData( t hybridmethod( t hybridpropertyc C@ s8 x1 | j d D]" } t | d d � d k r t Sq Wt S( sK Given a class, return True if any of the classes it inherits from has a mapped table, otherwise return False. This is used in declarative mixins to build attributes that behave differently for the base class vs. a subclass in an inheritance hierarchy. .. seealso:: :ref:`decl_mixin_inheritance` i t __table__N( t __mro__t getattrt Nonet Truet False( t clst class_( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt has_inherited_table$ s t DeclarativeMetac B@ s# e Z d � Z d � Z d � Z RS( c K@ s� | j } t | d d � } | d k rf | j d d � } t | t � sZ t j d � � qf | | _ n | j j d t � s� t | | | � n t j | | | | � d S( Nt _sa_registryt registrysi Declarative base class has no 'registry' attribute, or registry is not a sqlalchemy.orm.registry() objectt __abstract__( t __dict__R R t gett isinstanceR R t InvalidRequestErrorR R R t typet __init__( R t classnamet basest dict_t kwt reg( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR& 8 s c C@ s t | | | � d S( N( R ( R t keyt value( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt __setattr__O s c C@ s t | | � d S( N( R ( R R, ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt __delattr__R s ( t __name__t __module__R& R. R/ ( ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR 7 s c @ s � � f d � } | S( s Decorator that produces an :func:`_orm.synonym` attribute in conjunction with a Python descriptor. The function being decorated is passed to :func:`_orm.synonym` as the :paramref:`.orm.synonym.descriptor` parameter:: class MyClass(Base): __tablename__ = 'my_table' id = Column(Integer, primary_key=True) _job_status = Column("job_status", String(50)) @synonym_for("job_status") @property def job_status(self): return "Status: %s" % self._job_status The :ref:`hybrid properties <mapper_hybrids>` feature of SQLAlchemy is typically preferred instead of synonyms, which is a more legacy feature. .. seealso:: :ref:`synonyms` - Overview of synonyms :func:`_orm.synonym` - the mapper-level function :ref:`mapper_hybrids` - The Hybrid Attribute extension provides an updated approach to augmenting attribute behavior more flexibly than can be achieved with synonyms. c @ s t � d � d | �S( Nt map_columnt descriptor( t _orm_synonym( t fn( R2 t name( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt decoratex s ( ( R6 R2 R7 ( ( R2 R6 sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt synonym_forV s "t declared_attrc B@ sA e Z d Z e d � Z d � Z e d � � Z e d � � Z RS( sa Mark a class-level method as representing the definition of a mapped property or special declarative member name. :class:`_orm.declared_attr` is typically applied as a decorator to a class level method, turning the attribute into a scalar-like property that can be invoked from the uninstantiated class. The Declarative mapping process looks for these :class:`_orm.declared_attr` callables as it scans classes, and assumes any attribute marked with :class:`_orm.declared_attr` will be a callable that will produce an object specific to the Declarative mapping or table configuration. :class:`_orm.declared_attr` is usually applicable to mixins, to define relationships that are to be applied to different implementors of the class. It is also used to define :class:`_schema.Column` objects that include the :class:`_schema.ForeignKey` construct, as these cannot be easily reused across different mappings. The example below illustrates both:: class ProvidesUser(object): "A mixin that adds a 'user' relationship to classes." @declared_attr def user_id(self): return Column(ForeignKey("user_account.id")) @declared_attr def user(self): return relationship("User") :class:`_orm.declared_attr` can also 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__} To use :class:`_orm.declared_attr` inside of a Python dataclass as discussed at :ref:`orm_declarative_dataclasses_declarative_table`, it may be placed directly inside the field metadata using a lambda:: @dataclass class AddressMixin: __sa_dataclass_metadata_key__ = "sa" user_id: int = field( init=False, metadata={"sa": declared_attr(lambda: Column(ForeignKey("user.id")))} ) user: User = field( init=False, metadata={"sa": declared_attr(lambda: relationship(User))} ) :class:`_orm.declared_attr` also may be omitted from this form using a lambda directly, as in:: user: User = field( init=False, metadata={"sa": lambda: relationship(User)} ) .. seealso:: :ref:`orm_mixins_toplevel` - illustrates how to use Declarative Mixins which is the primary use case for :class:`_orm.declared_attr` :ref:`orm_declarative_dataclasses_mixin` - illustrates special forms for use with Python dataclasses c C@ s/ t t | � j | � | j | _ | | _ d S( N( t superR9 R& t __doc__t _cascading( t selft fgett cascading( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR& � s c C@ s� t j | � } | d k rc t j d | j j � sV t j d | j j | j f � n | j | � S| j ry | j | � S| j � } | d k s� t � | j } | | k r� | | S| j | � | | <} | Sd S( Ns ^__.+__$sE Unmanaged access of declarative attribute %s from non-mapped class %s( R t manager_of_classR t ret matchR> R0 R t warnt is_mappedt declarative_scant AssertionErrort declared_attr_reg( t descR= R t managerRE R+ t obj( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt __get__� s c K@ s t | � S( N( t _stateful_declared_attr( R R* ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _stateful� s c C@ s | j d t � S( s Mark a :class:`.declared_attr` as cascading. This is a special-use modifier which indicates that a column or MapperProperty-based declared attribute should be configured distinctly per mapped subclass, within a mapped-inheritance scenario. .. warning:: The :attr:`.declared_attr.cascading` modifier has several limitations: * The flag **only** applies to the use of :class:`.declared_attr` on declarative mixin classes and ``__abstract__`` classes; it currently has no effect when used on a mapped class directly. * The flag **only** applies to normally-named attributes, e.g. not any special underscore attributes such as ``__tablename__``. On these attributes it has **no** effect. * The flag currently **does not allow further overrides** down the class hierarchy; if a subclass tries to override the attribute, a warning is emitted and the overridden attribute is skipped. This is a limitation that it is hoped will be resolved at some point. Below, both MyClass as well as MySubClass will have a distinct ``id`` Column object established:: class HasIdMixin(object): @declared_attr.cascading def id(cls): if has_inherited_table(cls): return Column( ForeignKey('myclass.id'), primary_key=True ) else: return Column(Integer, primary_key=True) class MyClass(HasIdMixin, Base): __tablename__ = 'myclass' # ... class MySubClass(MyClass): "" # ... The behavior of the above configuration is that ``MySubClass`` will refer to both its own ``id`` column as well as that of ``MyClass`` underneath the attribute named ``some_id``. .. seealso:: :ref:`declarative_inheritance` :ref:`mixin_inheritance_columns` R? ( RM R ( R ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR? � s <( R0 R1 R; R R& RK R RM R R? ( ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR9 ~ s Q RL c B@ s# e Z d � Z d � Z d � Z RS( c K@ s | | _ d S( N( R* ( R= R* ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR& 9 s c K@ s& | j j � } | j | � t | � S( N( R* t copyt updateRL ( R= R* t new_kw( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyRM < s c C@ s t | | j � S( N( R9 R* ( R= R5 ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt __call__A s ( R0 R1 R& RM RQ ( ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyRL 8 s c C@ s | S( s, Mark a class as providing the feature of "declarative mixin". E.g.:: from sqlalchemy.orm import declared_attr from sqlalchemy.orm import declarative_mixin @declarative_mixin class MyMixin: @declared_attr def __tablename__(cls): return cls.__name__.lower() __table_args__ = {'mysql_engine': 'InnoDB'} __mapper_args__= {'always_refresh': True} id = Column(Integer, primary_key=True) class MyModel(MyMixin, Base): name = Column(String(1000)) The :func:`_orm.declarative_mixin` decorator currently does not modify the given class in any way; it's current purpose is strictly to assist the :ref:`Mypy plugin <mypy_toplevel>` in being able to identify SQLAlchemy declarative mixin classes when no other context is present. .. versionadded:: 1.4.6 .. seealso:: :ref:`orm_mixins_toplevel` :ref:`mypy_declarative_mixins` - in the :ref:`Mypy plugin documentation <mypy_toplevel>` ( ( R ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt declarative_mixinE s 't Basec C@ sY | d k r t j d � n t d | d | d | d | � j d | d | d | d | � S( sZ Construct a base class for declarative class definitions. The new base class will be given a metaclass that produces appropriate :class:`~sqlalchemy.schema.Table` objects and makes the appropriate :func:`~sqlalchemy.orm.mapper` calls based on the information provided declaratively in the class and any subclasses of the class. The :func:`_orm.declarative_base` function is a shorthand version of using the :meth:`_orm.registry.generate_base` method. That is, the following:: from sqlalchemy.orm import declarative_base Base = declarative_base() Is equivalent to:: from sqlalchemy.orm import registry mapper_registry = registry() Base = mapper_registry.generate_base() See the docstring for :class:`_orm.registry` and :meth:`_orm.registry.generate_base` for more details. .. versionchanged:: 1.4 The :func:`_orm.declarative_base` function is now a specialization of the more generic :class:`_orm.registry` class. The function also moves to the ``sqlalchemy.orm`` package from the ``declarative.ext`` package. :param bind: An optional :class:`~sqlalchemy.engine.Connectable`, will be assigned the ``bind`` attribute on the :class:`~sqlalchemy.schema.MetaData` instance. .. deprecated:: 1.4 The "bind" argument to declarative_base is deprecated and will be removed in SQLAlchemy 2.0. :param metadata: An optional :class:`~sqlalchemy.schema.MetaData` instance. All :class:`~sqlalchemy.schema.Table` objects implicitly declared by subclasses of the base will share this MetaData. A MetaData instance will be created if none is provided. The :class:`~sqlalchemy.schema.MetaData` instance will be available via the ``metadata`` attribute of the generated declarative base class. :param mapper: An optional callable, defaults to :func:`~sqlalchemy.orm.mapper`. Will be used to map subclasses to their Tables. :param cls: Defaults to :class:`object`. A type to use as the base for the generated declarative base class. May be a class or tuple of classes. :param name: Defaults to ``Base``. The display name for the generated class. Customizing this is not required, but can improve clarity in tracebacks and debugging. :param constructor: Specify the implementation for the ``__init__`` function on a mapped class that has no ``__init__`` of its own. Defaults to an implementation that assigns \**kwargs for declared fields and relationships to an instance. If ``None`` is supplied, no __init__ will be provided and construction will fall back to cls.__init__ by way of the normal Python semantics. :param class_registry: optional dictionary that will serve as the registry of class names-> mapped classes when string names are used to identify classes inside of :func:`_orm.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:: :class:`_orm.registry` s^ The ``bind`` argument to declarative_base is deprecated and will be removed in SQLAlchemy 2.0.t _bindt metadatat class_registryt constructorR R R6 t metaclassN( R R t warn_deprecated_20R t generate_base( t bindRU R R R6 RW RV RX ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt declarative_baseo s b R c B@ s� e Z d Z d d e d d � Z e d � � Z d � Z d � Z e d � � Z e d � � Z d � Z d � Z d � Z d � Z e d � Z e d � Z d � Z d e d e d � Z d � Z d � Z d � Z d d � Z RS( s� Generalized registry for mapping classes. The :class:`_orm.registry` serves as the basis for maintaining a collection of mappings, and provides configurational hooks used to map classes. The three general kinds of mappings supported are Declarative Base, Declarative Decorator, and Imperative Mapping. All of these mapping styles may be used interchangeably: * :meth:`_orm.registry.generate_base` returns a new declarative base class, and is the underlying implementation of the :func:`_orm.declarative_base` function. * :meth:`_orm.registry.mapped` provides a class decorator that will apply declarative mapping to a class without the use of a declarative base class. * :meth:`_orm.registry.map_imperatively` will produce a :class:`_orm.Mapper` for a class without scanning the class for declarative class attributes. This method suits the use case historically provided by the :func:`_orm.mapper` classical mapping function. .. versionadded:: 1.4 .. seealso:: :ref:`orm_mapping_classes_toplevel` - overview of class mapping styles. c C@ s� | p t � } | r! | | _ n | d k r< t j � } n | | _ t j � | _ t j � | _ | | _ | | _ t � | _ t � | _ t | _ t j � t t j | <Wd QXd S( s� Construct a new :class:`_orm.registry` :param metadata: An optional :class:`_schema.MetaData` instance. All :class:`_schema.Table` objects generated using declarative table mapping will make use of this :class:`_schema.MetaData` collection. If this argument is left at its default of ``None``, a blank :class:`_schema.MetaData` collection is created. :param constructor: Specify the implementation for the ``__init__`` function on a mapped class that has no ``__init__`` of its own. Defaults to an implementation that assigns \**kwargs for declared fields and relationships to an instance. If ``None`` is supplied, no __init__ will be provided and construction will fall back to cls.__init__ by way of the normal Python semantics. :param class_registry: optional dictionary that will serve as the registry of class names-> mapped classes when string names are used to identify classes inside of :func:`_orm.relationship` and others. Allows two or more declarative base classes to share the same registry of class names for simplified inter-base relationships. N( R R[ R t weakreft WeakValueDictionaryt _class_registryt WeakKeyDictionaryt _managerst _non_primary_mappersRU RW t sett _dependentst _dependenciesR t _new_mapperst mapperlibt _CONFIGURE_MUTEXR t _mapper_registries( R= RU RV RW RT t lcl_metadata( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR& s c C@ s# t d � | j D� � j | j � S( s9 read only collection of all :class:`_orm.Mapper` objects.c s@ s | ] } | j Vq d S( N( R ( t .0RI ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pys <genexpr>? s ( t frozensetRa t unionRb ( R= ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt mappers; s c C@ s4 | | k r d S| j j | � | j j | � d S( N( Rd t addRe ( R= R ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _set_depends_onC s c C@ s@ t | _ | j r d Sx# | j | h � D] } t | _ q) Wd S( N( R t _ready_for_configureRf t _recurse_with_dependents( R= R R+ ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _flag_new_mapperI s c c@ sp | } t � } xZ | rk | j � } | j | � | j | j j | � � | V| j | j j | � � q Wd S( N( Rc t popRo RO Rd t difference( R t registriest todot doneR+ ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyRr Q s c c@ sp | } t � } xZ | rk | j � } | j | � | j | j j | � � | V| j | j j | � � q Wd S( N( Rc Rt Ro RO Re Ru ( R Rv Rw Rx R+ ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _recurse_with_dependenciesb s c C@ s6 t j d � t | j � D� d � t | j � D� � S( Nc s@ s: | ]0 } | j r | j j r | j j r | j Vq d S( N( RD R t configuredRq ( Rk RI ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pys <genexpr>w s c s@ s( | ] } | j r | j r | Vq d S( N( Rz Rq ( Rk t npm( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pys <genexpr>~ s ( t itertoolst chaint listRa Rb ( R= ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _mappers_to_configuret s c C@ s t | j | <d S( N( R Rb ( R= t np_mapper( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _add_non_primary_mapper� s c C@ s t j | j | | j � d S( N( R t remove_classR0 R_ ( R= R ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _dispose_cls� s c C@ sK t | j | <| j d k r> | j r> t j d | j � � n | | _ d S( Ns1 Class '%s' already has a primary mapper defined. ( R Ra R R RD R t ArgumentErrorR ( R= RI ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _add_manager� s c C@ s t j | h d | �d S( s] Configure all as-yet unconfigured mappers in this :class:`_orm.registry`. The configure step is used to reconcile and initialize the :func:`_orm.relationship` linkages between mapped classes, as well as to invoke configuration events such as the :meth:`_orm.MapperEvents.before_configured` and :meth:`_orm.MapperEvents.after_configured`, which may be used by ORM extensions or user-defined extension hooks. If one or more mappers in this registry contain :func:`_orm.relationship` constructs that refer to mapped classes in other registries, this registry is said to be *dependent* on those registries. In order to configure those dependent registries automatically, the :paramref:`_orm.registry.configure.cascade` flag should be set to ``True``. Otherwise, if they are not configured, an exception will be raised. The rationale behind this behavior is to allow an application to programmatically invoke configuration of registries while controlling whether or not the process implicitly reaches other registries. As an alternative to invoking :meth:`_orm.registry.configure`, the ORM function :func:`_orm.configure_mappers` function may be used to ensure configuration is complete for all :class:`_orm.registry` objects in memory. This is generally simpler to use and also predates the usage of :class:`_orm.registry` objects overall. However, this function will impact all mappings throughout the running Python process and may be more memory/time consuming for an application that has many registries in use for different purposes that may not be needed immediately. .. seealso:: :func:`_orm.configure_mappers` .. versionadded:: 1.4.0b2 t cascadeN( Rg t _configure_registries( R= R� ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt configure� s 'c C@ s t j | h d | �d S( s� Dispose of all mappers in this :class:`_orm.registry`. After invocation, all the classes that were mapped within this registry will no longer have class instrumentation associated with them. This method is the per-:class:`_orm.registry` analogue to the application-wide :func:`_orm.clear_mappers` function. If this registry contains mappers that are dependencies of other registries, typically via :func:`_orm.relationship` links, then those registries must be disposed as well. When such registries exist in relation to this one, their :meth:`_orm.registry.dispose` method will also be called, if the :paramref:`_orm.registry.dispose.cascade` flag is set to ``True``; otherwise, an error is raised if those registries were not already disposed. .. versionadded:: 1.4.0b2 .. seealso:: :func:`_orm.clear_mappers` R� N( Rg t _dispose_registries( R= R� ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt dispose� s c C@ sO d | j k r% | j } | j � n | j } | j | � t j j | � d S( NR ( R! R t _set_dispose_flagsR R� R t _instrumentation_factoryt unregister( R= RI R R ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _dispose_manager_and_mapper� s RS c C@ s� | j } t | t � r" | f p% | } t d | d | � } t | t � r\ | j | d <n | j ru | j | d <n t | d <| r� | | d <n t | d � r� d � } | | d <n | | | | � S( sa Generate a declarative base class. Classes that inherit from the returned class object will be automatically mapped using declarative mapping. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() Base = mapper_registry.generate_base() class MyClass(Base): __tablename__ = "my_table" id = Column(Integer, primary_key=True) The above dynamically generated class is equivalent to the non-dynamic example below:: from sqlalchemy.orm import registry from sqlalchemy.orm.decl_api import DeclarativeMeta mapper_registry = registry() class Base(metaclass=DeclarativeMeta): __abstract__ = True registry = mapper_registry metadata = mapper_registry.metadata __init__ = mapper_registry.constructor The :meth:`_orm.registry.generate_base` method provides the implementation for the :func:`_orm.declarative_base` function, which creates the :class:`_orm.registry` and base class all at once. See the section :ref:`orm_declarative_mapping` for background and examples. :param mapper: An optional callable, defaults to :func:`~sqlalchemy.orm.mapper`. This function is used to generate new :class:`_orm.Mapper` objects. :param cls: Defaults to :class:`object`. A type to use as the base for the generated declarative base class. May be a class or tuple of classes. :param name: Defaults to ``Base``. The display name for the generated class. Customizing this is not required, but can improve clarity in tracebacks and debugging. :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:: :ref:`orm_declarative_mapping` :func:`_orm.declarative_base` R RU R; R& R t __mapper_cls__t __class_getitem__c S@ s | S( N( ( R R, ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR� 8 s ( RU R# t tuplet dictR% R; RW R t hasattr( R= R R R6 RX RU R( t class_dictR� ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyRZ � s G c C@ s t | | | j � | S( sL Class decorator that will apply the Declarative mapping process to a given class. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() @mapper_registry.mapped class Foo: __tablename__ = 'some_table' id = Column(Integer, primary_key=True) name = Column(String) See the section :ref:`orm_declarative_mapping` for complete details and examples. :param cls: class to be mapped. :return: the class that was passed. .. seealso:: :ref:`orm_declarative_mapping` :meth:`_orm.registry.generate_base` - generates a base class that will apply Declarative mapping to subclasses automatically using a Python metaclass. ( R R! ( R= R ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt mapped@ s !c @ s � � f d � } | S( s� Class decorator which will invoke :meth:`_orm.registry.generate_base` for a given base class. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() @mapper_registry.as_declarative_base() 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 :meth:`_orm.registry.as_declarative_base` are passed along to :meth:`_orm.registry.generate_base`. c @ s$ | � d <| j � d <� j � � S( NR R6 ( R0 RZ ( R ( R* R= ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR7 � s ( ( R= R* R7 ( ( R* R= sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt as_declarative_based s c C@ s t | | | j � S( s� Map a class declaratively. In this form of mapping, the class is scanned for mapping information, including for columns to be associated with a table, and/or an actual table object. Returns the :class:`_orm.Mapper` object. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() class Foo: __tablename__ = 'some_table' id = Column(Integer, primary_key=True) name = Column(String) mapper = mapper_registry.map_declaratively(Foo) This function is more conveniently invoked indirectly via either the :meth:`_orm.registry.mapped` class decorator or by subclassing a declarative metaclass generated from :meth:`_orm.registry.generate_base`. See the section :ref:`orm_declarative_mapping` for complete details and examples. :param cls: class to be mapped. :return: a :class:`_orm.Mapper` object. .. seealso:: :ref:`orm_declarative_mapping` :meth:`_orm.registry.mapped` - more common decorator interface to this function. :meth:`_orm.registry.map_imperatively` ( R R! ( R= R ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt map_declaratively� s -c K@ s t | | | | � S( s� Map a class imperatively. In this form of mapping, the class is not scanned for any mapping information. Instead, all mapping constructs are passed as arguments. This method is intended to be fully equivalent to the classic SQLAlchemy :func:`_orm.mapper` function, except that it's in terms of a particular registry. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() my_table = Table( "my_table", mapper_registry.metadata, Column('id', Integer, primary_key=True) ) class MyClass: pass mapper_registry.map_imperatively(MyClass, my_table) See the section :ref:`orm_imperative_mapping` for complete background and usage examples. :param class\_: The class to be mapped. Corresponds to the :paramref:`_orm.mapper.class_` parameter. :param local_table: the :class:`_schema.Table` or other :class:`_sql.FromClause` object that is the subject of the mapping. Corresponds to the :paramref:`_orm.mapper.local_table` parameter. :param \**kw: all other keyword arguments are passed to the :func:`_orm.mapper` function directly. .. seealso:: :ref:`orm_imperative_mapping` :ref:`orm_declarative_mapping` ( R ( R= R t local_tableR* ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt map_imperatively� s 1N( R0 R1 R; R R R& t propertyRn Rp Rs t classmethodRr Ry R R� R� R� R R� R� R� t objectR RZ R� R� R� R� ( ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyR � s2 0 ) [ $ # /R[ s 2.0s\ The ``bind`` argument to as_declarative is deprecated and will be removed in SQLAlchemy 2.0.c K@ sZ | j d d � | j d d � | j d d � } } } t d | d | d | � j | � S( s� Class decorator which will adapt a given class into a :func:`_orm.declarative_base`. This function makes use of the :meth:`_orm.registry.as_declarative_base` method, by first creating a :class:`_orm.registry` automatically and then invoking the decorator. E.g.:: from sqlalchemy.orm 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): # ... .. seealso:: :meth:`_orm.registry.as_declarative_base` R[ RU RV RT N( Rt R R R� ( R* R[ RU RV ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt as_declarative� s $c C@ s` t | � } | d k r\ t j | � r\ t j | � t j | d d t j | � �� q\ n | S( Nt msgsO Class %s has a deferred mapping on it. It is not yet usable as a mapped class.( R R R t has_clst raise_unmapped_for_clst orm_exct UnmappedClassErrort _safe_cls_name( R t mp( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt _inspect_decl_meta s (4 R; t __future__R R| RA R] t R R R R� R R R Rg t baseR t decl_baseR R R R R R t descriptor_propsR R4 R R t sql.schemaR R R R R% R R R8 t _MappedAttributeR� R9 RL RR R R� R\ R t _legacy_registryt deprecated_paramsR� t _inspectsR� ( ( ( sJ /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/orm/decl_api.pyt <module> s\ ( � + n� � +