Edit File: mapper.cpython-37.pyc
B ��4]X� � @ s d Z ddlmZ ddlmZ ddlmZ ddlZddlZddl Z ddl m Z ddl m Z dd l mZ dd l mZ dd l mZ dd l mZ dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm Z ddl m Z ddl m Z ddl m Z! ddl m"Z" ddl m#Z# ddl m$Z$ dd l m%Z% dd l mZ dd l%m&Z& dd l%m'Z' dd l%mZ( dd l%m)Z) e �*� Z+d a,e�-� Z.e�/d!�Z0ej1�2� Z3e"j4e#j5G d"d#� d#e ���Z6d$d%� Z7d&d'� Z8d(d)� Z9d*d+� Z:d,d-� Z;d.d/� Z<G d0d1� d1e=�Z>dS )2a5 Logic to map Python classes to and from selectables. Defines the :class:`~sqlalchemy.orm.mapper.Mapper` class, the central configurational unit which associates a class with a database table. This is a semi-private module; the main configurational API of the ORM is available in :class:`~sqlalchemy.orm.`. � )�absolute_import)�deque)�chainN� )� attributes)�exc)�instrumentation)�loading)� properties)�util)�_class_to_mapper)� _INSTRUMENTOR)� _state_mapper)� class_mapper)� state_str)�_MappedAttribute)�EXT_SKIP)�InspectionAttr)�MapperProperty)� PathRegistry� )�event)� inspection)�log)�schema)�sql)� expression)� operators)�visitorsF� NO_ATTRIBUTEc @ s~ e Zd ZdZdZdZejdddd�d�d d ��ZdZ dZ e d d � �Z e dd� �Z dZdZdZdZdZdZdZdZdZdZdZdZdZdZdZ dZ dZ dZ e e� dd�dd� ��Z!ej"dd� �Z#dd� Z$dd� Z%dd� Z&d d � Z'd d � Z(d d!� Z)d"d#� Z*d$d%� Z+e,d&d'� �Z-d(d)� Z.d*d+� Z/d,d-� Z0d�d.d/�Z1dZ2e3d0d1� �Z4e3d2d3� �Z5e3d4d5� �Z6d6d7� Z7d�d8d9�Z8d:d;� Z9d<d=� Z:d>d?� Z;d@dA� Z<dBdC� Z=e dDdE� �Z>dFdG� Z?dHdI� Z@dJdK� ZAdLdM� ZBdNdO� ZCdPdQ� ZDd�dRdS�ZEdTdU� ZFe dVdW� �ZGdXdY� ZHdZd[� ZIe3d\d]� �ZJe3d^d_� �ZKe3d`da� �ZLeKZMe3dbdc� �ZNe3ddde� �ZOe3dfdg� �ZPe3dhdi� �ZQe3djdk� �ZRe3dldm� �ZSe3dndo� �ZTe3dpdq� �ZUe drds� �ZVd�dtdu�ZWe3dvdw� �ZXd�dxdy�ZYe3dzd{� �ZZe3d|d}� �Z[e3d~d� �Z\e3d�d�� �Z]e3d�d�� �Z^e3d�d�� �Z_d�d�� Z`e3d�d�� �Zae3d�d�� �Zbd�d�� Zcd�d�� Zdd�d�� Zed�d�� Zfd�d�� Zgd�d�� Zhe3d�d�� �Zid�d�� Zjd�d�� Zke d�d�� �Zld�d�d��Zmd�d�d��Znd�d�d��Zod�d�� Zpeqjrfd�d��Zsd�d�� Zte3d�d�� �Zue3d�d�� �Zve3d�d�� �Zwe3d�d�� �Zxeqjrfd�d��Zyd�d�� Zzd�d�� Z{d�d�� Z|eqjrfd�d��Z}d�d�� Z~d�d�� Zd�dÄ Z�e��d�dšd�dDŽ �Z�e3d�dɄ �Z�d�d�d˄Z�e3d�d̈́ �Z�e3d�dτ �Z�d�dф Z�ej"d�dӄ �Z�dS )��Mappera Define the correlation of class attributes to database table columns. The :class:`.Mapper` object is instantiated using the :func:`~sqlalchemy.orm.mapper` function. For information about instantiating new :class:`.Mapper` objects, see that function's documentation. When :func:`.mapper` is used explicitly to link a user defined class with table metadata, this is referred to as *classical mapping*. Modern SQLAlchemy usage tends to favor the :mod:`sqlalchemy.ext.declarative` extension for class configuration, which makes usage of :func:`.mapper` behind the scenes. Given a particular class known to be mapped by the ORM, the :class:`.Mapper` which maintains it can be acquired using the :func:`.inspect` function:: from sqlalchemy import inspect mapper = inspect(MyClass) A class which was mapped by the :mod:`sqlalchemy.ext.declarative` extension will also have its mapper available via the ``__mapper__`` attribute. F)z0.7z�:class:`.MapperExtension` is deprecated in favor of the :class:`.MapperEvents` listener interface. The :paramref:`.mapper.extension` parameter will be removed in a future release.)z1.1z�The :paramref:`.mapper.order_by` parameter is deprecated, and will be removed in a future release. Use :meth:`.Query.order_by` to determine the ordering of a result set.)z1.3a The :paramref:`.mapper.non_primary` parameter is deprecated, and will be removed in a future release. The functionality of non primary mappers is now better suited using the :class:`.AliasedClass` construct, which can also be used as the target of a :func:`.relationship` in 1.3.)� extension�order_by� non_primaryNT�d c C sb t �|td�| _d| _t �|�| _|| _| dk r>t �| �| _n| | _| | _ t | t �rb| | _ d| _ n| | _ | dkrxd| _n| dkr�dd� | _n| | _|| _d| _|| _|| _|| _|| _|p�i | _g | _|| _| | _|| _t�|�| _ g | _ t � � | _ || _ || _!| | _"d| _#d| _$d| _%i | _&| | _'d| _(t �| �p6g �| _)|| _*| j�rZ| j�sZd| _+n|| _+t | jtj,��rzt-�.d��| �/|� || _0|| _1|dk�r�i | _2n|| _2|dk �r�t �3|�| _4nd| _4|�r�t �3|�| _5nd| _5d| _6t7�8� zd| j9j:�;|| � | �<� | �=� | �>� | �?� | �@� | �A� | �B� dtC_D| �Ed� | �F� W dt7�G� X dS ) aN Return a new :class:`~.Mapper` object. This function is typically used behind the scenes via the Declarative extension. When using Declarative, many of the usual :func:`.mapper` arguments are handled by the Declarative extension itself, including ``class_``, ``local_table``, ``properties``, and ``inherits``. Other options are passed to :func:`.mapper` using the ``__mapper_args__`` class variable:: class MyClass(Base): __tablename__ = 'my_table' id = Column(Integer, primary_key=True) type = Column(String(50)) alt = Column("some_alt", Integer) __mapper_args__ = { 'polymorphic_on' : type } Explicit use of :func:`.mapper` is often referred to as *classical mapping*. The above declarative example is equivalent in classical form to:: my_table = Table("my_table", metadata, Column('id', Integer, primary_key=True), Column('type', String(50)), Column("some_alt", Integer) ) class MyClass(object): pass mapper(MyClass, my_table, polymorphic_on=my_table.c.type, properties={ 'alt':my_table.c.some_alt }) .. seealso:: :ref:`classical_mapping` - discussion of direct usage of :func:`.mapper` :param class\_: The class to be mapped. When using Declarative, this argument is automatically passed as the declared class itself. :param local_table: The :class:`.Table` or other selectable to which the class is mapped. May be ``None`` if this mapper inherits from another mapper using single-table inheritance. When using Declarative, this argument is automatically passed by the extension, based on what is configured via the ``__table__`` argument or via the :class:`.Table` produced as a result of the ``__tablename__`` and :class:`.Column` arguments present. :param always_refresh: If True, all query operations for this mapped class will overwrite all data within object instances that already exist within the session, erasing any in-memory changes with whatever information was loaded from the database. Usage of this flag is highly discouraged; as an alternative, see the method :meth:`.Query.populate_existing`. :param allow_partial_pks: Defaults to True. Indicates that a composite primary key with some NULL values should be considered as possibly existing within the database. This affects whether a mapper will assign an incoming row to an existing identity, as well as if :meth:`.Session.merge` will check the database first for a particular primary key value. A "partial primary key" can occur if one has mapped to an OUTER JOIN, for example. :param batch: Defaults to ``True``, indicating that save operations of multiple entities can be batched together for efficiency. Setting to False indicates that an instance will be fully saved before saving the next instance. This is used in the extremely rare case that a :class:`.MapperEvents` listener requires being called in between individual row persistence operations. :param column_prefix: A string which will be prepended to the mapped attribute name when :class:`.Column` objects are automatically assigned as attributes to the mapped class. Does not affect explicitly specified column-based properties. See the section :ref:`column_prefix` for an example. :param concrete: If True, indicates this mapper should use concrete table inheritance with its parent mapper. See the section :ref:`concrete_inheritance` for an example. :param confirm_deleted_rows: defaults to True; when a DELETE occurs of one more rows based on specific primary keys, a warning is emitted when the number of rows matched does not equal the number of rows expected. This parameter may be set to False to handle the case where database ON DELETE CASCADE rules may be deleting some of those rows automatically. The warning may be changed to an exception in a future release. .. versionadded:: 0.9.4 - added :paramref:`.mapper.confirm_deleted_rows` as well as conditional matched row checking on delete. :param eager_defaults: if True, the ORM will immediately fetch the value of server-generated default values after an INSERT or UPDATE, rather than leaving them as expired to be fetched on next access. This can be used for event schemes where the server-generated values are needed immediately before the flush completes. By default, this scheme will emit an individual ``SELECT`` statement per row inserted or updated, which note can add significant performance overhead. However, if the target database supports :term:`RETURNING`, the default values will be returned inline with the INSERT or UPDATE statement, which can greatly enhance performance for an application that needs frequent access to just-generated server defaults. .. seealso:: :ref:`orm_server_defaults` .. versionchanged:: 0.9.0 The ``eager_defaults`` option can now make use of :term:`RETURNING` for backends which support it. :param exclude_properties: A list or set of string column names to be excluded from mapping. See :ref:`include_exclude_cols` for an example. :param extension: A :class:`.MapperExtension` instance or list of :class:`.MapperExtension` instances which will be applied to all operations by this :class:`.Mapper`. :param include_properties: An inclusive list or set of string column names to map. See :ref:`include_exclude_cols` for an example. :param inherits: A mapped class or the corresponding :class:`.Mapper` of one indicating a superclass to which this :class:`.Mapper` should *inherit* from. The mapped class here must be a subclass of the other mapper's class. When using Declarative, this argument is passed automatically as a result of the natural class hierarchy of the declared classes. .. seealso:: :ref:`inheritance_toplevel` :param inherit_condition: For joined table inheritance, a SQL expression which will define how the two tables are joined; defaults to a natural join between the two tables. :param inherit_foreign_keys: When ``inherit_condition`` is used and the columns present are missing a :class:`.ForeignKey` configuration, this parameter can be used to specify which columns are "foreign". In most cases can be left as ``None``. :param legacy_is_orphan: Boolean, defaults to ``False``. When ``True``, specifies that "legacy" orphan consideration is to be applied to objects mapped by this mapper, which means that a pending (that is, not persistent) object is auto-expunged from an owning :class:`.Session` only when it is de-associated from *all* parents that specify a ``delete-orphan`` cascade towards this mapper. The new default behavior is that the object is auto-expunged when it is de-associated with *any* of its parents that specify ``delete-orphan`` cascade. This behavior is more consistent with that of a persistent object, and allows behavior to be consistent in more scenarios independently of whether or not an orphanable object has been flushed yet or not. See the change note and example at :ref:`legacy_is_orphan_addition` for more detail on this change. :param non_primary: Specify that this :class:`.Mapper` is in addition to the "primary" mapper, that is, the one used for persistence. The :class:`.Mapper` created here may be used for ad-hoc mapping of the class to an alternate selectable, for loading only. :paramref:`.Mapper.non_primary` is not an often used option, but is useful in some specific :func:`.relationship` cases. .. seealso:: :ref:`relationship_non_primary_mapper` :param order_by: A single :class:`.Column` or list of :class:`.Column` objects for which selection operations should use as the default ordering for entities. By default mappers have no pre-defined ordering. :param passive_deletes: Indicates DELETE behavior of foreign key columns when a joined-table inheritance entity is being deleted. Defaults to ``False`` for a base mapper; for an inheriting mapper, defaults to ``False`` unless the value is set to ``True`` on the superclass mapper. When ``True``, it is assumed that ON DELETE CASCADE is configured on the foreign key relationships that link this mapper's table to its superclass table, so that when the unit of work attempts to delete the entity, it need only emit a DELETE statement for the superclass table, and not this table. When ``False``, a DELETE statement is emitted for this mapper's table individually. If the primary key attributes local to this table are unloaded, then a SELECT must be emitted in order to validate these attributes; note that the primary key columns of a joined-table subclass are not part of the "primary key" of the object as a whole. Note that a value of ``True`` is **always** forced onto the subclass mappers; that is, it's not possible for a superclass to specify passive_deletes without this taking effect for all subclass mappers. .. versionadded:: 1.1 .. seealso:: :ref:`passive_deletes` - description of similar feature as used with :func:`.relationship` :paramref:`.mapper.passive_updates` - supporting ON UPDATE CASCADE for joined-table inheritance mappers :param passive_updates: Indicates UPDATE behavior of foreign key columns when a primary key column changes on a joined-table inheritance mapping. Defaults to ``True``. When True, it is assumed that ON UPDATE CASCADE is configured on the foreign key in the database, and that the database will handle propagation of an UPDATE from a source column to dependent columns on joined-table rows. When False, it is assumed that the database does not enforce referential integrity and will not be issuing its own CASCADE operation for an update. The unit of work process will emit an UPDATE statement for the dependent columns during a primary key change. .. seealso:: :ref:`passive_updates` - description of a similar feature as used with :func:`.relationship` :paramref:`.mapper.passive_deletes` - supporting ON DELETE CASCADE for joined-table inheritance mappers :param polymorphic_load: Specifies "polymorphic loading" behavior for a subclass in an inheritance hierarchy (joined and single table inheritance only). Valid values are: * "'inline'" - specifies this class should be part of the "with_polymorphic" mappers, e.g. its columns will be included in a SELECT query against the base. * "'selectin'" - specifies that when instances of this class are loaded, an additional SELECT will be emitted to retrieve the columns specific to this subclass. The SELECT uses IN to fetch multiple subclasses at once. .. versionadded:: 1.2 .. seealso:: :ref:`with_polymorphic_mapper_config` :ref:`polymorphic_selectin` :param polymorphic_on: Specifies the column, attribute, or SQL expression used to determine the target class for an incoming row, when inheriting classes are present. This value is commonly a :class:`.Column` object that's present in the mapped :class:`.Table`:: class Employee(Base): __tablename__ = 'employee' id = Column(Integer, primary_key=True) discriminator = Column(String(50)) __mapper_args__ = { "polymorphic_on":discriminator, "polymorphic_identity":"employee" } It may also be specified as a SQL expression, as in this example where we use the :func:`.case` construct to provide a conditional approach:: class Employee(Base): __tablename__ = 'employee' id = Column(Integer, primary_key=True) discriminator = Column(String(50)) __mapper_args__ = { "polymorphic_on":case([ (discriminator == "EN", "engineer"), (discriminator == "MA", "manager"), ], else_="employee"), "polymorphic_identity":"employee" } It may also refer to any attribute configured with :func:`.column_property`, or to the string name of one:: class Employee(Base): __tablename__ = 'employee' id = Column(Integer, primary_key=True) discriminator = Column(String(50)) employee_type = column_property( case([ (discriminator == "EN", "engineer"), (discriminator == "MA", "manager"), ], else_="employee") ) __mapper_args__ = { "polymorphic_on":employee_type, "polymorphic_identity":"employee" } When setting ``polymorphic_on`` to reference an attribute or expression that's not present in the locally mapped :class:`.Table`, yet the value of the discriminator should be persisted to the database, the value of the discriminator is not automatically set on new instances; this must be handled by the user, either through manual means or via event listeners. A typical approach to establishing such a listener looks like:: from sqlalchemy import event from sqlalchemy.orm import object_mapper @event.listens_for(Employee, "init", propagate=True) def set_identity(instance, *arg, **kw): mapper = object_mapper(instance) instance.discriminator = mapper.polymorphic_identity Where above, we assign the value of ``polymorphic_identity`` for the mapped class to the ``discriminator`` attribute, thus persisting the value to the ``discriminator`` column in the database. .. warning:: Currently, **only one discriminator column may be set**, typically on the base-most class in the hierarchy. "Cascading" polymorphic columns are not yet supported. .. seealso:: :ref:`inheritance_toplevel` :param polymorphic_identity: Specifies the value which identifies this particular class as returned by the column expression referred to by the ``polymorphic_on`` setting. As rows are received, the value corresponding to the ``polymorphic_on`` column expression is compared to this value, indicating which subclass should be used for the newly reconstructed object. :param properties: A dictionary mapping the string names of object attributes to :class:`.MapperProperty` instances, which define the persistence behavior of that attribute. Note that :class:`.Column` objects present in the mapped :class:`.Table` are automatically placed into ``ColumnProperty`` instances upon mapping, unless overridden. When using Declarative, this argument is passed automatically, based on all those :class:`.MapperProperty` instances declared in the declared class body. :param primary_key: A list of :class:`.Column` objects which define the primary key to be used against this mapper's selectable unit. This is normally simply the primary key of the ``local_table``, but can be overridden here. :param version_id_col: A :class:`.Column` that will be used to keep a running version id of rows in the table. This is used to detect concurrent updates or the presence of stale data in a flush. The methodology is to detect if an UPDATE statement does not match the last known version id, a :class:`~sqlalchemy.orm.exc.StaleDataError` exception is thrown. By default, the column must be of :class:`.Integer` type, unless ``version_id_generator`` specifies an alternative version generator. .. seealso:: :ref:`mapper_version_counter` - discussion of version counting and rationale. :param version_id_generator: Define how new version ids should be generated. Defaults to ``None``, which indicates that a simple integer counting scheme be employed. To provide a custom versioning scheme, provide a callable function of the form:: def generate_version(version): return next_version Alternatively, server-side versioning functions such as triggers, or programmatic versioning schemes outside of the version id generator may be used, by specifying the value ``False``. Please see :ref:`server_side_version_counter` for a discussion of important points when using this option. .. versionadded:: 0.9.0 ``version_id_generator`` supports server-side version number generation. .. seealso:: :ref:`custom_version_counter` :ref:`server_side_version_counter` :param with_polymorphic: A tuple in the form ``(<classes>, <selectable>)`` indicating the default style of "polymorphic" loading, that is, which tables are queried at once. <classes> is any single or list of mappers and/or classes indicating the inherited classes that should be loaded at once. The special value ``'*'`` may be used to indicate all descending classes should be loaded immediately. The second tuple argument <selectable> indicates a selectable that will be used to query for multiple classes. .. seealso:: :ref:`with_polymorphic` - discussion of polymorphic querying techniques. �class_NFc S s | pdd S )Nr r � )�xr& r& �H/opt/alt/python37/lib64/python3.7/site-packages/sqlalchemy/orm/mapper.py�<lambda>x � z!Mapper.__init__.<locals>.<lambda>z�When mapping against a select() construct, map against an alias() of the construct instead.This because several databases don't allow a SELECT from a subquery that does not have an alias.TZ constructed)Hr Zassert_arg_type�typer% � class_manager�to_list�_primary_key_argumentr# r" �always_refresh� isinstancer Zversion_id_prop�version_id_col�version_id_generator�concrete�single�inherits� local_table�inherit_condition�inherit_foreign_keys�_init_properties�_delete_orphans�batch�eager_defaults� column_prefixr Z_clause_element_as_expr�polymorphic_onZ_dependency_processorsZ immutabledict� validators�passive_updates�passive_deletes�legacy_is_orphanZ_clause_adapter�_requires_row_aliasing�_inherits_equated_pairs�_memoized_values�_compiled_cache_size�_reconstructor�_deprecated_extensions�allow_partial_pks�confirm_deleted_rows� SelectBase�sa_exc�InvalidRequestError�_set_with_polymorphic�polymorphic_load�polymorphic_identity�polymorphic_map�to_set�include_properties�exclude_properties� configured�_CONFIGURE_MUTEX�acquire�dispatchZ_eventsZ_new_mapper_instance�_configure_inheritance�"_configure_legacy_instrument_class� _configure_class_instrumentation�_configure_listeners�_configure_properties� _configure_polymorphic_setter�_configure_pksr � _new_mappers�_log�_expire_memoizations�release) �selfr% r6 r � primary_keyr# r5 r7 r8 r! r" r/ r1 r2 r> Z_polymorphic_maprP r3 �with_polymorphicrO rI r; r= rS rT r@ rA rJ r< rB rF r& r& r( �__init__k s� z zMapper.__init__c C s | S )z<Part of the inspection API. Returns self. r& )rd r& r& r( �mapper� s z Mapper.mapperc C s | j S )zDPart of the inspection API. Returns self.class\_. )r% )rd r& r& r( �entity� s z Mapper.entityz1.3zUse .persist_selectablec C s | j S )N)�persist_selectable)rd r& r& r( � mapped_table� s zMapper.mapped_tablec C s t �| �S )N)r Z per_mapper)rd r& r& r( �_path_registry� s zMapper._path_registryc C sX t �� | _| j�rt| jt�r.t| jdd�| _t| j| jj�sZt � d| jj | jjj f ��| j | jj kr�| j rtdpvd}t � d|| jj |f ��| j dkr�| jj | _ | jj| _d| _n�| j | jj k �rR| jr�| j | _xz| �� D ]}|jdk r�d|_q�W nX| jdk�rt�| jj | j �| _t�| jj| j | j�| _t �| j�}tj| jj |d �| _ n| j | _| j dk �rz| j�sz| jj | _ n| j| _ | j dk�r�| jj | _ | jj!| _!n:| jj dk �r�| j | jj k �r�t �"d | j j#| jj j#f � | j$dk�r | j�s | jj$dk �r | jj$| _$| jj%| _%| jj&| _&| jj�'| � | jj(| _(| jj)| _)| jj*�pN| j*| _*| jj+| _+| j dk �r�| j | j%k�r�t �"d | j | j%| j | | j f � | | j%| j < | j,�r�| j�r�t � d ��| j,d k�r�| j�-| � n*| j,dk�r�n | j,dk �r:t � d| j, ��n6t.� | _+| | _(| j | _| j dk �r2| | j%| j < | j| _ | jdk�rTt � d| ��dS )zXConfigure settings related to inheriting and/or inherited mappers being present.F)Z configurez%Class '%s' does not inherit from '%s'Zprimaryz non-primaryzHInheritance of %s mapper for class '%s' is only allowed from a %s mapperNT)Zconsider_as_foreign_keysz�Inheriting version_id_col '%s' does not match inherited version_id_col '%s' and will not automatically populate the inherited versioning column. version_id_col should only be specified on the base-most mapper that includes versioning.z�Reassigning polymorphic association for identity %r from %r to %r: Check for duplicate use of %r as value for polymorphic_identity.zKpolymorphic_load is not currently supported with concrete table inheritance�inline�selectinz)unknown argument for polymorphic_load: %rz9Mapper '%s' does not have a persist_selectable specified.)/r � WeakSequence�_inheriting_mappersr5 r0 r+ r � issubclassr% rL � ArgumentError�__name__r# r6 rj r4 r3 �iterate_to_rootr> rC r7 �sql_utilZjoin_conditionr �joinrR r8 Zcriterion_as_pairsZonclauserD rP �_identity_classr1 r2 �warn� descriptionr" rQ r; �append� base_mapperr@ rA � _all_tablesrO � _add_with_polymorphic_subclass�set)rd �nprh Zfksr& r& r( rY � s� z Mapper._configure_inheritancec C s� |dkrd| _ nTt|ttf�rJt|d tjttf �r>|| _ qd|d f| _ n|d k r^t�d��nd | _ t| jt j �r|t� d��| j r�t| j d t j �r�| j d | j d � � f| _ | j r�| �� d S )N�*)r� Nr z$Invalid setting for with_polymorphicz�When mapping against a select() construct, map against an alias() of the construct instead.This because several databases don't allow a SELECT from a subquery that does not have an alias.r )rf r0 �tuple�listr � string_typesrL rr r6 r rK rM �aliasrU rb )rd rf r& r& r( rN n s& z Mapper._set_with_polymorphicc C sP |j }| jd kr | �|f� n.| jd dkrL| �| jd |f | jd f� d S )Nr r� r )r% rf rN )rd rh Zsubclr& r& r( r} � s z%Mapper._add_with_polymorphic_subclassc C s� | j s t�| jrt�t|t�s"t�|| _| jj�| j� | jj| _x | �� D ]}|jdk rLd|_ qLW | jj | _ x| j D ]}| jj |_ qvW | jj �| � | jj| _| jj| _x@|j�� D ]2\}}|| jkr�| j||ddd�s�| �||d� q�W dS )z�Set the given :class:`.Mapper` as the 'inherits' for this :class:`.Mapper`, assuming this :class:`.Mapper` is concrete and does not already have an inherits.NTF)�local�column)r3 �AssertionErrorr5 r0 r rQ �updatert r> rC r; �self_and_descendantsr{ rp rz r@ r| �_props�items�_should_exclude�_adapt_inherited_property)rd rh �mp�key�propr& r& r( �_set_concrete_base� s& zMapper._set_concrete_basec C s || _ | �d� d S )NT)r> r^ )rd r> r& r& r( �_set_polymorphic_on� s zMapper._set_polymorphic_onc C sb | j r4| j�| j j� ttdd� | j �� D �� �}nt� }x"| jD ]}||krB|�| |� qBW d S )Nc S s g | ] }|j �qS r& )rH )�.0�mr& r& r( � <listcomp>� s z=Mapper._configure_legacy_instrument_class.<locals>.<listcomp>)r5 rX Z_updater~ r rt rH Z_adapt_instrument_class)rd �super_extensions�extr& r& r( rZ � s z)Mapper._configure_legacy_instrument_classc C sR | j r$ttdd� | j �� D �� �}nt� }x"| jD ]}||kr2|�| |� q2W d S )Nc S s g | ] }|j �qS r& )rH )r� r� r& r& r( r� � s z/Mapper._configure_listeners.<locals>.<listcomp>)r5 r~ r rt rH Z_adapt_listener)rd r� r� r& r& r( r\ � s zMapper._configure_listenersc C s� t �| j�}| jrH|r |js,t�d| j ��|| _|jj | _ dt | < dS |dk rv|j| jks`t �|jrvt� d| j ��dt | < | j �| | j� |dkr�t�| j�}|| _| |_t�tj| �|_|j�td�r�dS tj|dtdd� tj|dt dd� x�t� | j�D ]�\}}|d k�r:t |d ��r:|j }t |t!j"��r:|j#}t |t!j$��rt |d ��rn|| _%tj|d t&dd� nXt |d ��r|j'}xD|j(D ]:}|| j)k�r�t�d|| f ��| j)�*|||fi�| _)�q�W �qW | |jt< dS )a� If this mapper is to be a primary mapper (i.e. the non_primary flag is not set), associate this Mapper with the given class and entity name. Subsequent calls to ``class_mapper()`` for the ``class_`` / ``entity`` name combination will return this mapper. Also decorate the `__init__` method on the mapped class to include optional auto-session attachment logic. ztClass %s has no primary mapper configured. Configure a primary mapper first before setting up a non primary Mapper.TNz�Class '%s' already has a primary mapper defined. Use non_primary=True to create a non primary Mapper. clear_mappers() will remove *all* current mappers from all classes.FZ first_init)�raw�initrg �_sa_original_init�__sa_reconstructor__�load�__sa_validators__zJA validation function for mapped attribute %r on mapper %s already exists.)+r �manager_of_classr% r# � is_mappedrL rM r, rh rw �_mapper_registryr� rr rX �instrument_classr Zregister_classr �partialr Zload_scalar_attributesZdeferred_scalar_loader�info�getr r �listen�_event_on_first_init�_event_on_initZiterate_attributes�hasattrr� r0 �types� MethodTypeZim_func� FunctionTyperG �_event_on_load�__sa_validation_opts__r� r? �union)rd �managerr� �methodZvalidation_opts�namer& r& r( r[ � s^ z'Mapper._configure_class_instrumentationc C s t � dS )zAClass-level path to the :func:`.configure_mappers` call. N)�configure_mappers)�clsr& r& r( �_configure_all5 s zMapper._configure_allc C sN d| _ d| _t| d�r| `| jsJ| jd k rJ| jjrJ| jj| krJt� | j � d S )NT�_configure_failed) rU �_dispose_calledr� r� r# r, r� rh r Zunregister_classr% )rd r& r& r( �dispose; s zMapper.disposec s" t �� j�� _i � _i � _t�tdd� � j D �� �}t�dd� |D ��}t � j� jg �}� j � |� xN|D ]F}|j r�|�|j �r�t�|j ��|�� j|< t�|j��|�� j|< qlW � jr�x�� jD ]2}|j� jkr�t�� � j|j< � j|j �|� q�W nl� j� jk�s t� j� j �dk�r8t�d� � jjf ��n0� j� jk�rht� jt j ��rht� d� jj � � j �r�� j �s�� j�s�� j j � _ nx� j�r�t j!� fdd�� jD �d d �}nt j!� j� j d d �}t|�dk�r�t�d� � jjf ��t"|�� _ � �#d |� t � fd d�� j D ��� _$d S ) Nc S s g | ] }|j �qS r& )� proxy_set)r� �colr& r& r( r� R s z)Mapper._configure_pks.<locals>.<listcomp>c s s | ]}|j r|V qd S )N)re )r� �cr& r& r( � <genexpr>U s z(Mapper._configure_pks.<locals>.<genexpr>r zJMapper %s could not assemble any primary key columns for mapped table '%s'zlCould not assemble any primary keys for locally mapped table '%s' - no rows will be persisted in this Table.c s g | ]}� j �|��qS r& )rj �corresponding_column)r� r� )rd r& r( r� � s T)Zignore_nonexistent_tablesz"Identified primary key columns: %sc 3 s> | ]6}� j | � jkrt|d �r,|j� jkr� j | V qdS )�tableN)�_columntoproperty�_identity_key_propsr� r� �_cols_by_table)r� r� )rd r& r( r� � s )%ru � find_tablesrj �tables� _pks_by_tabler� r � column_setr r� r~ r| r� re � issupersetZordered_column_set� intersectionr� r. r� � OrderedSet�add�lenrL rr ry r6 r0 r ZTablerx r5 r3 Zreduce_columnsr� ra �_readonly_props)rd Zall_cols�pk_colsr� �t�kre r& )rd r( r_ K sf zMapper._configure_pksc C s& t �� | _| _t �� | _t| �| _| jrPx$| j� � D ]\}}| � ||d� q6W | j r�xB| j j� � D ]2\}}|| jkrd| j ||dd d�sd| � ||d� qdW x�| jjD ]z}|| jkr�q�| jp�d|j }| j |j|| jj�|�|d�r�q�x&| �� D ]}||jkr�|j| j}q�W | j ||ddd� q�W d S )NF)r� r� � T)r� � setparent)r ZOrderedProperties�columnsr� � OrderedDictr� �_ColumnMappingr� r9 r� �_configure_propertyr5 r� r� rj r= r� r6 Zcontains_columnrt )rd r� r� r� Z column_keyrh r& r& r( r] � s4 z Mapper._configure_propertiesc sP d}| j dk �r�d}t| j tj�rZy| j| j | _ W n$ tk rX t�d| j ��Y nX | j | jkrv| j| j }�n t| j t �r�t| j t j �s�t�d��| j }n�t � | j �s�t�d��n�| j�| j �}|dk�r"d}d}| j }t|tj��r&| jdk�s| jd �|�dk�r&t�d|j ��nd}t|dd�}|�r`| �|j|jd|��rvt�d |j ��n|�d � | _ }|j}t j ||d �}| j|||dd � |jd | _ |j� npxn| �� D ]b}|j dk �r�| j|jk�r�|j | _ n| j�|j �| _ | j dk �r |j | _ |j | _ nd| _ dS �q�W |�rF� fdd�}� fdd�} || _ | | _ nd| _ dS )a� Configure an attribute on the mapper representing the 'polymorphic_on' column, if applicable, and not already generated by _configure_properties (which is typical). Also create a setter function which will assign this attribute to the value of the 'polymorphic_identity' upon instance construction, also if applicable. This routine will run when an instance is created. FNTzPCan't determine polymorphic_on value '%s' - no attribute is mapped to this name.zUOnly direct column-mapped property or SQL expression can be passed for polymorphic_onr zkCould not map polymorphic_on column '%s' to the mapped table - polymorphic loads will not function properlyr� z6Cannot exclude or override the discriminator column %rZ_sa_polymorphic_on)Z _instrument)r� r� r c s& | j }| �� ��| || jjjd � d S )N)�dictZget_implr~ r� rh rP )�state�dict_)�polymorphic_keyr& r( �_set_polymorphic_identityv s zGMapper._configure_polymorphic_setter.<locals>._set_polymorphic_identityc s2 � |kr.|� | j kr.t�dt|�|� f� d S )NznFlushing object %s with incompatible polymorphic identity %r; the object may not refresh and/or load correctly)�"_acceptable_polymorphic_identitiesr Z warn_limitedr )rh r� r� )r� r& r( � _validate_polymorphic_identity s zLMapper._configure_polymorphic_setter.<locals>._validate_polymorphic_identity) r> r0 r r� r� �KeyErrorrL rr r� r r �ColumnPropertyr � _is_columnrj r� r ZColumnrf rM ry �getattrr� r� �labelr� r� rt r� r� ) rd r� �setterr� r� Z instrumentr� rh r� r� r& )r� r( r^ � s� z$Mapper._configure_polymorphic_setterc C s | j d k r| j| j S d S d S )N)r1 r� )rd r& r& r( �_version_id_prop� s zMapper._version_id_propc C sJ t � }t| g�}x4|rD|�� }|j| jkr|�|j� |�|j� qW |S )N)r~ r �popleftrj r� rP �extendrp )rd Z identities�stack�itemr& r& r( r� � s z)Mapper._acceptable_polymorphic_identitiesc C s t | j�� �S )N)� frozensetr� �values)rd r& r& r( � _prop_set� s zMapper._prop_setc C sl | j s| j||ddd� nN|| jkrh| j�||�}||ksRt|tj�rh|j|j krh| j|t � � |dd� d S )NF)r� r� T) r3 r� r� r, �_get_class_attr_mror0 r ZInstrumentedAttributeZ _parententity�parentr �ConcreteInheritedProperty)rd r� r� r� Zimplementing_attributer& r& r( r� � s z Mapper._adapt_inherited_propertyc C s� | � d||jj� t|t�s(| �||�}t|tj��r�| j� |j d �}|d kr�| j r�| g}xb| j � � D ]T}|j � |j d �}|d k r�x|D ]}|j�� q�W | j� |j d �}P |�|� qhW |d k�r|j d }t| d��rDt|d�r�|j| jk�rD| j�|� n>t| d��rD|j| jk�rD|| j|j k�rD| j|j �|� t|d��sn|| jk�pj|j d | jk|_|| j |< x2|j |j D ]"}x|jD ]}|| j|< �q�W �q�W ||_|�r�|�| |� || j k�rt | j | dd��r| j | j } t � d | ||| f ��|| j k�rlt|tj��slt| j | tjtj!f��slt"�#d | j | | |f � | j | } | j$�%| d � || j |< | j&�s�|�'| � x | j(D ]} | �)|||� �q�W |�r�|�*� |�+| � | j,�r�| �-� d S ) Nz_configure_property(%s, %s)r r� r� r� � _is_polymorphic_discriminator�_mapped_by_synonymFzpCan't call map_column=True for synonym %r=%r, a ColumnProperty already exists keyed to the name %r for column %rzYProperty %s on %s being replaced with new property %s; the old property will be discarded).ra � __class__rs r0 r �_property_from_columnr r� rj r� r� r5 rt r6 �_reset_exportedrz r� r� r� r� r� r> r� Z _orig_columnsr� r� r� Z set_parentr� r� r� rL rr r� r rx rl �popr# r� rp r� r� �post_instrument_classrU rb ) rd r� r� r� r� r� �pathr� �m2ZsynZoldproprh r& r& r( r� � s~ zMapper._configure_propertyc C s� t �|�}|d }t�|�s.t�d||f ��| j�|d�}t|t j �r�| j rb|j d |f| j kr�|j d � |�s�|j d | jk r�|| jk r�|j| k }d|j d ||f }|r�t �|� n t�|��|�� }|j �d|� | �d| � |S |dk�st|t j��r�g }xx|D ]p}| j�|�} | dk�rr| j�|�} | dk �rH| j�� | j�|�} | dk�rrt�d|| |f ��|�| � �qW t j |� S t�d|| |j|f ��dS ) zUgenerate/update a :class:`.ColumnProprerty` given a :class:`.Column` object. r z4%s=%r is not an instance of MapperProperty or ColumnNz�Implicitly combining column %s with column %s under attribute '%s'. Please configure one or more attributes for these same-named columns explicitly.���zAinserting column to existing list in properties.ColumnProperty %sz�When configuring property '%s' on %s, column '%s' is not represented in the mapper's table. Use the `column_property()` function to force this column to be mapped as a read-only attribute.a� WARNING: when configuring property '%s' on %s, column '%s' conflicts with property '%r'. To resolve this, map the column to the class under a different name in the 'properties' dictionary. Or, to remove all awareness of the column entirely (including its availability as a foreign key), use the 'include_properties' or 'exclude_properties' mapper arguments to control specifically which table columns get mapped.) r r- r r� rL rr r� r� r0 r r� rD r� Zshares_lineager1 r� rx rM �copy�insertra r� rj r� r6 r� rz r� ) rd r� r� r� r� Z warn_only�msgZ mapped_columnr� Zmcr& r& r( r� 6 sZ z Mapper._property_from_columnc C sx | � d� dd� | j�� D �}xD|D ]<\}}| � d|� |j| krP|jsP|�� |jr$|�| � q$W | � d� d| _dS )z�Call the ``init()`` method on all ``MapperProperties`` attached to this mapper. This is a deferred configuration step which is intended to execute once all mappers have been constructed. z$_post_configure_properties() startedc S s g | ]\}}||f�qS r& r& )r� r� r� r& r& r( r� � s z5Mapper._post_configure_properties.<locals>.<listcomp>zinitialize prop %sz%_post_configure_properties() completeTN) ra r� r� r� Z_configure_startedr� Z_configure_finishedr� rU )rd �lr� r� r& r& r( �_post_configure_properties� s z!Mapper._post_configure_propertiesc C s& x |� � D ]\}}| �||� q W dS )z^Add the given dictionary of properties to this mapper, using `add_property`. N)r� � add_property)rd Zdict_of_propertiesr� �valuer& r& r( �add_properties� s zMapper.add_propertiesc C s || j |< | j||| jd� dS )aA Add an individual MapperProperty to this mapper. If the mapper has not been configured yet, just adds the property to the initial properties dictionary sent to the constructor. If this Mapper has already been configured, then the given MapperProperty is configured immediately. )r� N)r9 r� rU )rd r� r� r& r& r( r� � s zMapper.add_propertyc C s x| � � D ]}t�|� q W d S )N)rt � _memoized_configured_propertyZexpire_instance)rd rh r& r& r( rb � s zMapper._expire_memoizationsc C s> d| j j d | jd k r | jjp(t| j� | jr4dp6d d S )N�(�|z |non-primaryr� �))r% rs r6 ry �strr# )rd r& r& r( � _log_desc� s zMapper._log_descc G s" | j jd| f| jf| �� d S )Nz%s )�loggerr� r )rd r� �argsr& r& r( ra � s z Mapper._logc G s" | j jd| f| jf| �� d S )Nz%s )r �debugr )rd r� r r& r& r( � _log_debug� s zMapper._log_debugc C s dt | �| jjf S )Nz<Mapper at 0x%x; %s>)�idr% rs )rd r& r& r( �__repr__� s zMapper.__repr__c C s2 d| j j| jrdpd| jd k r&| jjn| jjf S )Nzmapped class %s%s->%sz (non-primary)r� )r% rs r# r6 ry rj )rd r& r& r( �__str__� s zMapper.__str__c C st d}x\| � � D ]P}xJ|jD ]@\}}d}t�|�j|||jd�}| jrL|rLdS | js|sdS qW qW | jrl|S dS d S )NFT)Z optimistic)rt r: r r� � has_parentZ has_identityrB )rd r� Zorphan_possiblerh r� r� r r& r& r( � _is_orphan� s zMapper._is_orphanc C s || j kS )N)r� )rd r� r& r& r( � has_property� s zMapper.has_propertyc C sF |rt jrt� y | j| S tk r@ t�d| |f ��Y nX dS )z?return a MapperProperty associated with the given key. z Mapper '%s' has no property '%s'N)r r` r� r� r� rL rM )rd r� Z_configure_mappersr& r& r( � get_property� s zMapper.get_propertyc C s | j | S )zdGiven a :class:`.Column` object, return the :class:`.MapperProperty` which maps this column.)r� )rd r� r& r& r( �get_property_by_column s z Mapper.get_property_by_columnc C s t jr t� t| j�� �S )z1return an iterator of all MapperProperty objects.)r r` r� �iterr� r� )rd r& r& r( �iterate_properties s zMapper.iterate_propertiesc s� |dkrt | j�� n~|r�t� � xXt�|�D ]J}t|�}|�| �sRt�d|| f ��|dkrj� � |� � � q*� � |� q*W � fdd�| jD �� ng � |dk r�tt j |dd����fdd�� D �� � S ) z�given a with_polymorphic() argument, return the set of mappers it represents. Trims the list of mappers to just those represented within the given selectable, if present. This helps some more legacy-ish mappings. r� z%r does not inherit from %rNc s g | ]}|� kr|�qS r& r& )r� r� )�mappersr& r( r� % s z-Mapper._mappers_from_spec.<locals>.<listcomp>T)Zinclude_aliasesc s g | ]}|j � kr|�qS r& )r6 )r� r� )r� r& r( r� - s )r� r� r~ r r- r �isarL rM r� rt r� ru r� )rd �spec� selectabler� r& )r r� r( �_mappers_from_spec s& zMapper._mappers_from_specc C s` | j }xT|D ]L}|| krq |jr,t�d��q |js |rH|�|j|j�}q |�|j|j�}q W |S )z�given a list of mappers (assumed to be within this mapper's inheritance hierarchy), construct an outerjoin amongst those mapper's mapped tables. z^'with_polymorphic()' requires 'selectable' argument when concrete-inheriting mappers are used.) rj r3 rL rM r4 rv r6 r7 Z outerjoin)rd r � innerjoinZfrom_objr� r& r& r( �_selectable_from_mappers0 s z Mapper._selectable_from_mappersc C s@ | j r8| jr8| jd k r8| j�d| i��dd� | jD ��S d S d S )NZ parentmapperc s s | ] }|j V qd S )N)rP )r� r� r& r& r( r� O s z1Mapper._single_table_criterion.<locals>.<genexpr>)r4 r5 r> Z _annotate�in_r� )rd r& r& r( �_single_table_criterionK s z Mapper._single_table_criterionc C s" t jr t� | jsg S | j| j� S )N)r r` r� rf r )rd r& r& r( �_with_polymorphic_mappersT s z Mapper._with_polymorphic_mappersc C s: | j s | jS | j \}}|d k r"|S | �| �||�d�S d S )NF)rf rj r r )rd r r r& r& r( � _with_polymorphic_selectable\ s z#Mapper._with_polymorphic_selectablec C s t dd� | j�� D ��S )Nc s s( | ] \}}|t d d� |D ��fV qdS )c s s | ]}|j jr|V qd S )N)r+ �should_evaluate_none)r� r� r& r& r( r� u s z@Mapper._insert_cols_evaluating_none.<locals>.<genexpr>.<genexpr>N)r� )r� r� r� r& r& r( r� r s z6Mapper._insert_cols_evaluating_none.<locals>.<genexpr>)r� r� r� )rd r& r& r( � _insert_cols_evaluating_noneo s z#Mapper._insert_cols_evaluating_nonec C s t dd� | j�� D ��S )Nc s s( | ] \}}|t d d� |D ��fV qdS )c s s. | ]&}|j s|js|js|jjs|jV qd S )N)re �server_default�defaultr+ r r� )r� r� r& r& r( r� � s z8Mapper._insert_cols_as_none.<locals>.<genexpr>.<genexpr>N)r� )r� r� r� r& r& r( r� ~ s z.Mapper._insert_cols_as_none.<locals>.<genexpr>)r� r� r� )rd r& r& r( �_insert_cols_as_none{ s zMapper._insert_cols_as_nonec s t � fdd�� j�� D ��S )Nc 3 s, | ]$\}}|t � fd d�|D ��fV qdS )c 3 s | ]}� j | j|fV qd S )N)r� r� )r� r� )rd r& r( r� � s z3Mapper._propkey_to_col.<locals>.<genexpr>.<genexpr>N)r� )r� r� r� )rd r& r( r� � s z)Mapper._propkey_to_col.<locals>.<genexpr>)r� r� r� )rd r& )rd r( �_propkey_to_col� s zMapper._propkey_to_colc C s t dd� | j�� D ��S )Nc s s( | ] \}}|t d d� |D ��fV qdS )c S s g | ] }|j �qS r& )r� )r� r� r& r& r( r� � s z6Mapper._pk_keys_by_table.<locals>.<genexpr>.<listcomp>N)r� )r� r� �pksr& r& r( r� � s z+Mapper._pk_keys_by_table.<locals>.<genexpr>)r� r� r� )rd r& r& r( �_pk_keys_by_table� s zMapper._pk_keys_by_tablec s t � fdd�� j�� D ��S )Nc 3 s, | ]$\}}|t � fd d�|D ��fV qdS )c s g | ]}� j | j�qS r& )r� r� )r� r� )rd r& r( r� � s z;Mapper._pk_attr_keys_by_table.<locals>.<genexpr>.<listcomp>N)r� )r� r� r# )rd r& r( r� � s z0Mapper._pk_attr_keys_by_table.<locals>.<genexpr>)r� r� r� )rd r& )rd r( �_pk_attr_keys_by_table� s z Mapper._pk_attr_keys_by_tablec C s t dd� | j�� D ��S )Nc s s( | ] \}}|t d d� |D ��fV qdS )c S s g | ]}|j d k r|j�qS )N)r r� )r� r� r& r& r( r� � s z9Mapper._server_default_cols.<locals>.<genexpr>.<listcomp>N)r� )r� r� r� r& r& r( r� � s z.Mapper._server_default_cols.<locals>.<genexpr>)r� r� r� )rd r& r& r( �_server_default_cols� s zMapper._server_default_colsc C s` t � }xT| j�� D ]F\}}x<|D ]4}|jd k s8|jd k r || jkr |�| j| j� q W qW |S )N)r~ r� r� r �server_onupdater� r� r� )rd �resultr� r� r� r& r& r( �&_server_default_plus_onupdate_propkeys� s z-Mapper._server_default_plus_onupdate_propkeysc C s t dd� | j�� D ��S )Nc s s( | ] \}}|t d d� |D ��fV qdS )c S s g | ]}|j d k r|j�qS )N)r' r� )r� r� r& r& r( r� � s zBMapper._server_onupdate_default_cols.<locals>.<genexpr>.<listcomp>N)r� )r� r� r� r& r& r( r� � s z7Mapper._server_onupdate_default_cols.<locals>.<genexpr>)r� r� r� )rd r& r& r( � _server_onupdate_default_cols� s z$Mapper._server_onupdate_default_colsc C s | j S )a$ The :func:`.select` construct this :class:`.Mapper` selects from by default. Normally, this is equivalent to :attr:`.persist_selectable`, unless the ``with_polymorphic`` feature is in use, in which case the full "polymorphic" selectable is returned. )r )rd r& r& r( r � s zMapper.selectablec C sd | j r(|s| j d }|dkr4| j d }n |dkr4d }| �||�}|d k rP||fS || �||�fS d S )Nr Fr )rf r r )rd r r r r r& r& r( �_with_polymorphic_args� s z Mapper._with_polymorphic_argsc C s t | �| j��S )N)r� � _iterate_polymorphic_propertiesr )rd r& r& r( �_polymorphic_properties� s z Mapper._polymorphic_propertiesc c s� |dkr| j }|s*xl| jD ] }|V qW nVxTt�tdd� | g| D �� �D ]2}t|dd�rv| jdksJ|jd | jk rvqJ|V qJW dS )zUReturn an iterator of MapperProperty objects which will render into a SELECT.Nc S s g | ]}t |j��qS r& )r� r )r� rh r& r& r( r� s z:Mapper._iterate_polymorphic_properties.<locals>.<listcomp>r� Fr )r r r Z unique_listr r� r> r� )rd r r� r& r& r( r, � s z&Mapper._iterate_polymorphic_propertiesc C s t jr t� t�| j�S )a] A namespace of all :class:`.MapperProperty` objects associated this mapper. This is an object that provides each property based on its key name. For instance, the mapper for a ``User`` class which has ``User.name`` attribute would provide ``mapper.attrs.name``, which would be the :class:`.ColumnProperty` representing the ``name`` column. The namespace object can also be iterated, which would yield each :class:`.MapperProperty`. :class:`.Mapper` has several pre-filtered views of this attribute which limit the types of properties returned, including :attr:`.synonyms`, :attr:`.column_attrs`, :attr:`.relationships`, and :attr:`.composites`. .. warning:: The :attr:`.Mapper.attrs` accessor namespace is an instance of :class:`.OrderedProperties`. This is a dictionary-like object which includes a small number of named methods such as :meth:`.OrderedProperties.items` and :meth:`.OrderedProperties.values`. When accessing attributes dynamically, favor using the dict-access scheme, e.g. ``mapper.attrs[somename]`` over ``getattr(mapper.attrs, somename)`` to avoid name collisions. .. seealso:: :attr:`.Mapper.all_orm_descriptors` )r r` r� r �ImmutablePropertiesr� )rd r& r& r( �attrs s "z Mapper.attrsc C s t �t| j�� ��S )a+ A namespace of all :class:`.InspectionAttr` attributes associated with the mapped class. These attributes are in all cases Python :term:`descriptors` associated with the mapped class or its superclasses. This namespace includes attributes that are mapped to the class as well as attributes declared by extension modules. It includes any Python descriptor type that inherits from :class:`.InspectionAttr`. This includes :class:`.QueryableAttribute`, as well as extension types such as :class:`.hybrid_property`, :class:`.hybrid_method` and :class:`.AssociationProxy`. To distinguish between mapped attributes and extension attributes, the attribute :attr:`.InspectionAttr.extension_type` will refer to a constant that distinguishes between different extension types. When dealing with a :class:`.QueryableAttribute`, the :attr:`.QueryableAttribute.property` attribute refers to the :class:`.MapperProperty` property, which is what you get when referring to the collection of mapped properties via :attr:`.Mapper.attrs`. .. warning:: The :attr:`.Mapper.all_orm_descriptors` accessor namespace is an instance of :class:`.OrderedProperties`. This is a dictionary-like object which includes a small number of named methods such as :meth:`.OrderedProperties.items` and :meth:`.OrderedProperties.values`. When accessing attributes dynamically, favor using the dict-access scheme, e.g. ``mapper.all_orm_descriptors[somename]`` over ``getattr(mapper.all_orm_descriptors, somename)`` to avoid name collisions. .. seealso:: :attr:`.Mapper.attrs` )r r. r� r, Z_all_sqla_attributes)rd r& r& r( �all_orm_descriptors= s +zMapper.all_orm_descriptorsc C s | � tj�S )z�Return a namespace of all :class:`.SynonymProperty` properties maintained by this :class:`.Mapper`. .. seealso:: :attr:`.Mapper.attrs` - namespace of all :class:`.MapperProperty` objects. )�_filter_propertiesr ZSynonymProperty)rd r& r& r( �synonymsl s zMapper.synonymsc C s | � tj�S )z�Return a namespace of all :class:`.ColumnProperty` properties maintained by this :class:`.Mapper`. .. seealso:: :attr:`.Mapper.attrs` - namespace of all :class:`.MapperProperty` objects. )r1 r r� )rd r& r& r( � column_attrsy s zMapper.column_attrsc C s | � tj�S )a4 A namespace of all :class:`.RelationshipProperty` properties maintained by this :class:`.Mapper`. .. warning:: the :attr:`.Mapper.relationships` accessor namespace is an instance of :class:`.OrderedProperties`. This is a dictionary-like object which includes a small number of named methods such as :meth:`.OrderedProperties.items` and :meth:`.OrderedProperties.values`. When accessing attributes dynamically, favor using the dict-access scheme, e.g. ``mapper.relationships[somename]`` over ``getattr(mapper.relationships, somename)`` to avoid name collisions. .. seealso:: :attr:`.Mapper.attrs` - namespace of all :class:`.MapperProperty` objects. )r1 r ZRelationshipProperty)rd r& r& r( � relationships� s zMapper.relationshipsc C s | � tj�S )z�Return a namespace of all :class:`.CompositeProperty` properties maintained by this :class:`.Mapper`. .. seealso:: :attr:`.Mapper.attrs` - namespace of all :class:`.MapperProperty` objects. )r1 r ZCompositeProperty)rd r& r& r( � composites� s zMapper.compositesc s0 t jr t� t�t�� fdd�| j�� D ���S )Nc 3 s$ | ] \}}t |� �r||fV qd S )N)r0 )r� r� �v)�type_r& r( r� � s z,Mapper._filter_properties.<locals>.<genexpr>)r r` r� r r. r� r� r� )rd r7 r& )r7 r( r1 � s zMapper._filter_propertiesc C s. dd� | j D �}tjdd� |D �� t�|�fS )z�create a "get clause" based on the primary key. this is used by query.get() and many-to-one lazyloads to load this item by primary key. c S s g | ]}|t jd |jd�f�qS )N)r7 )r � bindparamr+ )r� re r& r& r( r� � s z&Mapper._get_clause.<locals>.<listcomp>c S s g | ]\}}||k�qS r& r& )r� r� r6 r& r& r( r� � s )re r �and_r � column_dict)rd �paramsr& r& r( � _get_clause� s zMapper._get_clausec sH t �� � � fdd�}x.| jjD ]"}|jdk r t�|ji d|i� q W � S )a� Create a map of all equivalent columns, based on the determination of column pairs that are equated to one another based on inherit condition. This is designed to work with the queries that util.polymorphic_union comes up with, which often don't include the columns from the base table directly (including the subclass table columns only). The resulting structure is a dictionary of columns mapped to lists of equivalent columns, e.g.:: { tablea.col1: {tableb.col1, tablec.col1}, tablea.col2: {tabled.col2} } c st | j tjkrp| j� kr*� | j �| j� nt�| jf�� | j< | j� kr\� | j �| j� nt�| jf�� | j< d S )N)�operatorr �eq�leftr� �rightr r� )�binary)r( r& r( � visit_binary� s z0Mapper._equivalent_columns.<locals>.visit_binaryNrA )r r: r{ r� r7 r Ztraverse)rd rB rh r& )r( r( �_equivalent_columns� s zMapper._equivalent_columnsc C s t |ttjtjf�rdS dS d S )NFT)r0 r r Z ClassManagerr Z ColumnElement)rd �objr& r& r( �_is_userland_descriptor� s z Mapper._is_userland_descriptorc C s� |r0| j j�|d�dk rT| �| j j| �rTdS n$| j�|d�}|dk rT| �|�rTdS | jdk r�|| jkr�|dksz|| jkr�| �d| � dS | jdk r�|| jks�|dk r�|| jkr�| �d| � dS dS )z�determine whether a particular property should be implicitly present on the class. This occurs when properties are propagated from an inherited class, or are applied from the columns present in the mapped table. NTznot including property %szexcluding property %sF) r% �__dict__r� rE r, r� rS ra rT )rd r� Z assigned_namer� r� �attrr& r& r( r� � s( zMapper._should_excludec C s | j |j kS )zXReturn true if the given mapper shares a common inherited parent as this mapper.)r{ )rd �otherr& r& r( � common_parent$ s zMapper.common_parentc C s4 | � � }| jd k s|r$t|��|�S t|�|kS d S )N)�primary_mapperr> r r )rd r� Zallow_subtypes�sr& r& r( �_canload* s zMapper._canloadc C s$ | }x|r||k r|j }qW t|�S )z>Return True if the this mapper inherits from the given mapper.)r5 �bool)rd rH r� r& r& r( r 1 s z Mapper.isac c s | }x|r|V |j }qW d S )N)r5 )rd r� r& r& r( rt 9 s zMapper.iterate_to_rootc C s@ g }t | g�}x&|r4|�� }|�|� |�|j� qW t�|�S )z�The collection including this mapper and all descendant mappers. This includes not just the immediately inheriting mappers but all their inheriting mappers as well. )r r� rz r� rp r ro )rd Z descendantsr� r� r& r& r( r� ? s zMapper.self_and_descendantsc C s t | j�S )aC Iterate through the collection including this mapper and all descendant mappers. This includes not just the immediately inheriting mappers but all their inheriting mappers as well. To iterate through an entire hierarchy, use ``mapper.base_mapper.polymorphic_iterator()``. )r r� )rd r& r& r( �polymorphic_iteratorO s zMapper.polymorphic_iteratorc C s | j jS )zSReturn the primary mapper corresponding to this mapper's class key (class).)r, rh )rd r& r& r( rJ \ s zMapper.primary_mapperc C s | j jjS )N)r, rh r{ )rd r& r& r( �primary_base_mapperb s zMapper.primary_base_mapperc s@ | j }� r � fdd�|D �}x |D ]}|�|�s"dS q"W dS d S )Nc s g | ]}� j | �qS r& )r� )r� r� )�adapterr& r( r� i s z3Mapper._result_has_identity_key.<locals>.<listcomp>FT)re Z_has_key)rd r( rP r� r� r& )rP r( �_result_has_identity_keyf s z Mapper._result_has_identity_keyc s: | j }� r � fdd�|D �}| jt�fdd�|D ��|fS )a� Return an identity-map key for use in storing/retrieving an item from the identity map. :param row: A :class:`.RowProxy` instance. The columns which are mapped by this :class:`.Mapper` should be locatable in the row, preferably via the :class:`.Column` object directly (as is the case when a :func:`.select` construct is executed), or via string names of the form ``<tablename>_<colname>``. c s g | ]}� j | �qS r& )r� )r� r� )rP r& r( r� } s z0Mapper.identity_key_from_row.<locals>.<listcomp>c 3 s | ]}� | V qd S )Nr& )r� r� )�rowr& r( r� � s z/Mapper.identity_key_from_row.<locals>.<genexpr>)re rw r� )rd rR �identity_tokenrP r� r& )rP rR r( �identity_key_from_rowp s z Mapper.identity_key_from_rowc C s | j t|�|fS )z�Return an identity-map key for use in storing/retrieving an item from an identity map. :param primary_key: A list of values indicating the identifier. )rw r� )rd re rS r& r& r( � identity_key_from_primary_key� s z$Mapper.identity_key_from_primary_keyc C s t �|�}| �|t j�S )a� Return the identity key for the given instance, based on its primary key attributes. If the instance's state is expired, calling this method will result in a database check to see if the object has been deleted. If the row no longer exists, :class:`~sqlalchemy.orm.exc.ObjectDeletedError` is raised. This value is typically also found on the instance state under the attribute name `key`. )r �instance_state�_identity_key_from_state� PASSIVE_OFF)rd �instancer� r& r& r( �identity_key_from_instance� s z!Mapper.identity_key_from_instancec s4 �j � �j�| jt� ���fdd�| jD ���jfS )Nc s" g | ]}�|j j��� ���qS r& )r� �implr� )r� r� )r� r� �passiver� r& r( r� � s z3Mapper._identity_key_from_state.<locals>.<listcomp>)r� r� rw r� r� rS )rd r� r\ r& )r� r� r\ r� r( rW � s z Mapper._identity_key_from_statec C s t �|�}| �|t j�}|d S )aG Return the list of primary key values for the given instance. If the instance's state is expired, calling this method will result in a database check to see if the object has been deleted. If the row no longer exists, :class:`~sqlalchemy.orm.exc.ObjectDeletedError` is raised. r )r rV rW rX )rd rY r� Z identity_keyr& r& r( �primary_key_from_instance� s z Mapper.primary_key_from_instancec s � fdd�� j D �S )Nc s g | ]}� j | �qS r& )r� )r� r� )rd r& r( r� � s z.Mapper._identity_key_props.<locals>.<listcomp>)re )rd r& )rd r( r� � s zMapper._identity_key_propsc C s* t � }x | jD ]}|�| j| � qW |S )N)r~ r� r� r� )rd Z collectionr� r& r& r( � _all_pk_props� s zMapper._all_pk_propsc C s$ t | j�}| jd k r |�| j� |S )N)r~ re r> r� )rd �colsr& r& r( �_should_undefer_in_wildcard� s z"Mapper._should_undefer_in_wildcardc C s dd� | j D �S )Nc S s h | ] }|j �qS r& )r� )r� r� r& r& r( � <setcomp>� s z/Mapper._primary_key_propkeys.<locals>.<setcomp>)r^ )rd r& r& r( �_primary_key_propkeys� s z Mapper._primary_key_propkeysc C s$ | j | }|j|j jj|||d�S )N)r\ )r� r� r� r[ r� )rd r� r� r� r\ r� r& r& r( �_get_state_attr_by_column� s z Mapper._get_state_attr_by_columnc C s& | j | }|j|j j�|||� d S )N)r� r� r� r[ Zset_committed_value)rd r� r� r� r� r� r& r& r( �#_set_committed_state_attr_by_column� s z*Mapper._set_committed_state_attr_by_columnc C s( | j | }|j|j j�|||d � d S )N)r� r� r� r[ r~ )rd r� r� r� r� r� r& r& r( �_set_state_attr_by_column� s z Mapper._set_state_attr_by_columnc C s( t �|�}t �|�}| j|||t jd�S )N)r\ )r rV � instance_dict�#_get_committed_state_attr_by_columnrX )rd rD r� r� r� r& r& r( � _get_committed_attr_by_column� s z$Mapper._get_committed_attr_by_columnc C s$ | j | }|j|j jj|||d�S )N)r\ )r� r� r� r[ Zget_committed_value)rd r� r� r� r\ r� r& r& r( rg � s z*Mapper._get_committed_state_attr_by_columnc s �j �tt�fdd�|D �� ���jj�kr0dS G dd� dt�� � ���fdd�}g }yhd}x^tt��� ��D ]J}|j�kr�d }nt |jt j �s�dS |rn|j sn|� t�|ji d |i�� qnW W n � k r� dS X tj|� }g }x |D ]} |��| j� q�W tj||d d �S ) al assemble a WHERE clause which retrieves a given state by primary key, using a minimized set of tables. Applies to a joined-table inheritance mapper where the requested attribute names are only present on joined tables, not the base table. The WHERE clause attempts to include only those tables to minimize joins. c s* g | ]"}� | j D ]}tj|d d��qqS )T)Z check_columns)r� ru r� )r� r� r� )�propsr& r( r� s z3Mapper._optimized_get_statement.<locals>.<listcomp>Nc @ s e Zd ZdS )z<Mapper._optimized_get_statement.<locals>.ColumnsNotAvailableN)rs � __module__� __qualname__r& r& r& r( �ColumnsNotAvailable s rl c s� | j }| j}|d ks |d kr d S |j�krh�j��j|tjd�}|tjkrP� � �t j d || jj d�| _ nF|j�kr��j��j|tjd�}|tjkr�� � �t j d || jj d�| _d S )N)r\ )r7 ) r? r@ r� rg r� r ZPASSIVE_NO_INITIALIZE�orm_utilZ _none_setr r8 r+ )rA ZleftcolZrightcolZleftvalZrightval)rl rd r� r� r& r( rB s0 z5Mapper._optimized_get_statement.<locals>.visit_binaryFTrA )Z use_labels)r� r~ r r{ r6 � Exception�reversedr� rt r0 r Z TableClauser4 rz r Zcloned_traverser7 r r9 r� r� �select) rd r� Zattribute_namesrB Zallconds�startrh �condr_ r� r& )rl ri rd r� r� r( �_optimized_get_statement� s> z Mapper._optimized_get_statementc c sL | � |�rH| }x8| �� D ],}|V ||k r6||jkr6P |}||krP qW d S )N)r rt r )rd rh �prevr� r& r& r( �_iterate_to_target_viawpolyJ s z"Mapper._iterate_to_target_viawpolyc C s� |s,|}x�| � |�D ]}|jdkr|S qW ndt|�}dd� |D �}xL|�|g�D ]<}|j}x0| � |�D ]"}|jdks|||krf|�||�S qfW qPW d S )Nrn c S s i | ] }||j �qS r& )rh )r� �er& r& r( � <dictcomp>a s z0Mapper._should_selectin_load.<locals>.<dictcomp>)ru rO r~ r� rh r� )rd Zenabled_via_optZpolymorphic_fromrh r� Zenabled_via_opt_mappersri r& r& r( �_should_selectin_loadW s z Mapper._should_selectin_loadzsqlalchemy.ext.bakedz sqlalchemy.orm.strategy_optionsc s �j s t��j�j }t|g�j �}|�� �}|�� �}xL�jD ]B}|j�ksX||krp|� |j ft |j �� qB|� |j fddi� qBW t �j�dkr�tj�j� �n �jd �� jr� j�ks�t�|��j� fdd��f�} | �� n|��j�fdd��f�} | ��fdd�7 } | ||fS ) zmAssemble a BakedQuery that can load the columns local to this subclass as a SELECT with IN. Z do_nothingTr r c s | � � ��� j��� S )N)�queryZselect_entity_fromr Z_adapt_all_clauses)�session)ri r& r( r) � s z.Mapper._subclass_load_via_in.<locals>.<lambda>c s | � � �S )N)ry )rz )rd r& r( r) � r* c s" | � � �tjddd���j�j� S )NZ primary_keysT)Z expanding)�filterr r r8 r" re )�q)�in_exprrd r& r( r) � s )r5 r� r� r> r~ r� �Loadr/ r� Zset_generic_strategyr� r� Z strategy_keyr� re r Ztuple_Zis_aliased_classrh Z BakedQuery�_compiled_cacheZspoil) rd ZbakedZstrategy_optionsri Zpolymorphic_propZ keep_propsZ disable_optZ enable_optr� r| r& )ri r} rd r( �_subclass_load_via_inm s6 z Mapper._subclass_load_via_inc C s | � | �S )N)r� )rd r& r& r( � _subclass_load_via_in_mapper� s z#Mapper._subclass_load_via_in_mapperc c s� t � }t� t� }}|j�| �s$t�tt|jj�� �|||jfg�}x�|r�|d \}} } } |sh|� � qF| |kr�|� � } || j kr�qFt| � || | ||��} | r�|� | |ddf� qF| |krF|� � \}}}}||||fV |� t|j�� �|||f� qFW dS )a. Iterate each element and its mapper in an object graph, for all relationships that meet the given cascade rule. :param type\_: The name of the cascade rule (i.e. ``"save-update"``, ``"delete"``, etc.). .. note:: the ``"all"`` cascade is not accepted here. For a generic object traversal function, see :ref:`faq_walk_objects`. :param state: The lead InstanceState. child items will be processed per the relationships defined for this object's mapper. :return: the method yields individual object instances. .. seealso:: :ref:`unitofwork_cascades` :ref:`faq_walk_objects` - illustrates a generic function to traverse all objects without relying on cascades. r� N)r~ �objectrh r r� r r� r� r� r� r� Zcascade�cascade_iteratorrz )rd r7 r� Zhalt_onZvisited_statesZprpZmppZ visitables�iteratorZ item_typeZ parent_stateZ parent_dictr� �queuerY Zinstance_mapperZcorresponding_stateZcorresponding_dictr& r& r( r� � sD zMapper.cascade_iteratorc C s t �| j�S )N)r ZLRUCacherF )rd r& r& r( r � s zMapper._compiled_cachec s� i �x,| j jD ] }x|jD ]}��||� qW qW g }x8��� D ],\� }|j}|r@|�� fdd�|jD �� q@W �fdd�}tj�||d�}t � � }x|D ]}�| ||< q�W |S )Nc s g | ] }|� f�qS r& r& )r� Z super_table)r� r& r( r� s z)Mapper._sorted_tables.<locals>.<listcomp>c s� � � | jj�}� � | jj�}|d k r�|d k r�||k r�|jd k r�tt�|j��}|jd k r~|�t�|j��}| j|ko|| j|kS | j|kS dS )NF) r� r� r� r� r7 r~ ru Z _find_columnsr� )Zfkr� �depr_ )�table_to_mapperr& r( �skip s z#Mapper._sorted_tables.<locals>.skip)Zskip_fn�extra_dependencies) r{ r� r� � setdefaultr� r5 r� ru Z sort_tablesr r� )rd rh r� r� Zsuper_r� Zsorted_�retr& )r� r� r( �_sorted_tables� s& zMapper._sorted_tablesc C s, || j kr| j | S |� | j |< }|S d S )N)rE )rd r� Z callable_r� r& r& r( �_memo0 s z Mapper._memoc C st t �t�}xd| jD ]Z}t|j�}xJ| �� D ]>}|jr*|�t � tj dd� |jD ���r*|| � ||jf� q*W qW |S )zgmemoized map of tables to collections of columns to be synchronized upwards to the base mapper.c S s g | ]\}}|j �qS r& )r� )r� r� �rr& r& r( r� D s z,Mapper._table_to_equated.<locals>.<listcomp>) r � defaultdictr� r� r~ r� rt rD r� �reducer� rz )rd r( r� r_ r� r& r& r( �_table_to_equated7 s zMapper._table_to_equated) NNNFNNNNFFNNNNNFNNTTNNNTFTFFr$ )F)TT)T)NFF)N)N)NN)N)N)�rs rj rk �__doc__r` r� r Zdeprecated_paramsrg Z is_mapperZrepresents_outer_join�propertyrh ri r6 rj r5 rU r3 r� re r% r, r4 r# r> rQ rP r{ r� r? r� Z deprecatedrk Zmemoized_propertyrl rY rN r} r� r� rZ r\ r[ � classmethodr� r� r_ r] r^ r� r� r� r� r� r� r� r� r� r� r� rb r ra r r r r r r r r r r r r r Zwith_polymorphic_mappersr r! r" r$ r% r& r) r* r r+ r- r, r/ r0 r2 r3 r4 r5 r1 r< rC rE r� rI rL r rt r� rN rJ rO rQ rT rU rZ r ZPASSIVE_RETURN_NEVER_SETrW r] r� r^ r` rb rc rd re rh rg rs ru rx Z dependenciesr� r� r� r r� r� r� r& r& r& r( r E sH ! 8 " Y e3 1 oV " & / * ( X : M 3r c C sV t js dS t�� �z"tr dS da�zt js0dS d} t j�t ��� x�tt �D ]�}d}x*|jj D ] }|||j �}|t kr`d} P q`W |t kr�qNt |dd�r�t�d||jf �}|j|_|�|jsNy$|�� |�� |j�||j � W qN tk �r t�� d }t|d��s||_� Y qNX qNW | �s*dt _W ddaX W dt�� X t j�t ��� dS )a� Initialize the inter-mapper relationships of all mappers that have been constructed thus far. This function can be called any number of times, but in most cases is invoked automatically, the first time mappings are used, as well as whenever mappings are used and additional not-yet-configured mappers have been constructed. Points at which this occur include when a mapped class is instantiated into an instance, as well as when the :meth:`.Session.query` method is used. The :func:`.configure_mappers` function provides several event hooks that can be used to augment its functionality. These methods include: * :meth:`.MapperEvents.before_configured` - called once before :func:`.configure_mappers` does any work; this can be used to establish additional options, properties, or related mappings before the operation proceeds. * :meth:`.MapperEvents.mapper_configured` - called as each individual :class:`.Mapper` is configured within the process; will include all mapper state except for backrefs set up by other mappers that are still to be configured. * :meth:`.MapperEvents.after_configured` - called once after :func:`.configure_mappers` is complete; at this stage, all :class:`.Mapper` objects that are known to SQLAlchemy will be fully configured. Note that the calling application may still have other mappings that haven't been produced yet, such as if they are in modules as yet unimported. NTFr� z�One or more mappers failed to initialize - can't proceed with initialization of other mappers. Triggering mapper: '%s'. Original exception was: %sr )r r` rV rW �_already_compilingrX Z _for_classZbefore_configuredr� r� Zbefore_mapper_configuredr% r r� rL rM r� rU r� rb Zmapper_configuredrn �sys�exc_infor� rc Zafter_configured)Zhas_skiprh Z run_configure�fnrv r r& r& r( r� L sV # r� c C s d| _ | S )a- Decorate a method as the 'reconstructor' hook. Designates a method as the "reconstructor", an ``__init__``-like method that will be called by the ORM after the instance has been loaded from the database or otherwise reconstituted. The reconstructor will be invoked with no arguments. Scalar (non-collection) database-mapped attributes of the instance will be available for use within the function. Eagerly-loaded collections are generally not yet available and will usually only contain the first element. ORM state changes made to objects at this stage will not be recorded for the next flush() operation, so the activity within a reconstructor should be conservative. .. seealso:: :ref:`mapping_constructors` :meth:`.InstanceEvents.load` T)r� )r� r& r& r( � reconstructor� s r� c s, |� dd��|� dd�� � ��fdd�}|S )a� Decorate a method as a 'validator' for one or more named properties. Designates a method as a validator, a method which receives the name of the attribute as well as a value to be assigned, or in the case of a collection, the value to be added to the collection. The function can then raise validation exceptions to halt the process from continuing (where Python's built-in ``ValueError`` and ``AssertionError`` exceptions are reasonable choices), or can modify or replace the value before proceeding. The function should otherwise return the given value. Note that a validator for a collection **cannot** issue a load of that collection within the validation routine - this usage raises an assertion to avoid recursion overflows. This is a reentrant condition which is not supported. :param \*names: list of attribute names to be validated. :param include_removes: if True, "remove" events will be sent as well - the validation function must accept an additional argument "is_remove" which will be a boolean. :param include_backrefs: defaults to ``True``; if ``False``, the validation function will not emit if the originator is an attribute event related via a backref. This can be used for bi-directional :func:`.validates` usage where only one validator should emit per attribute operation. .. versionadded:: 0.9.0 .. seealso:: :ref:`simple_validators` - usage examples for :func:`.validates` �include_removesF�include_backrefsTc s �| _ �� d�| _| S )N)r� r� )r� r� )r� )r� r� �namesr& r( �wrap� s zvalidates.<locals>.wrap)r� )r� �kwr� r& )r� r� r� r( � validates� s # r� c C s$ | j jt }|jr |�| �� � d S )N)r� r� r rG rD )r� �ctx�instrumenting_mapperr& r& r( r� � s r� c C s | j �t�}|r tjr t� dS )z�Initial mapper compilation trigger. instrumentation calls this one when InstanceState is first generated, and is needed for legacy mutable attributes to work. N)r� r� r r r` r� )r� r� r� r& r& r( r� s r� c C s2 | j j�t�}|r.tjr t� |jr.|�| � dS )z�Run init_instance hooks. This also includes mapper compilation, normally not needed here but helps with some piecemeal configuration scenarios (such as in the ORM tutorial). N)r� r� r� r r r` r� r� )r� r �kwargsr� r& r& r( r� s r� c @ s$ e Zd ZdZdZdd� Zdd� ZdS )r� z4Error reporting helper for mapper._columntoproperty.)rh c C s || _ d S )N)rh )rd rh r& r& r( rg & s z_ColumnMapping.__init__c C sH | j j�|�}|r0t�d|jj|j|j|f ��t�d|| j f ��d S )NzDColumn '%s.%s' is not available, due to conflicting property '%s':%rz*No column %s is configured on mapper %s...)rh r� r� �orm_excZUnmappedColumnErrorr� r� r� )rd r� r� r& r& r( � __missing__) s z_ColumnMapping.__missing__N)rs rj rk r� � __slots__rg r� r& r& r& r( r� ! s r� )?r� � __future__r � collectionsr � itertoolsr r� r� �weakrefr� r r r� r r r r rm �baser r r r r Z interfacesr r r r Z path_registryr r rL r r r r r r ru r �WeakKeyDictionaryr� r� Z!group_expirable_memoized_propertyr� �symbolr � threading�RLockrV Z_self_inspectsZ class_loggerr r� r� r� r� r� r� r� r� r& r& r& r( �<module> s� e1