관리-도구
편집 파일: mapper.cpython-38.pyc
U -?�fP� � @ s U d Z ddlmZ ddlmZ ddlmZ ddlmZ ddl Z ddl Z ddl m Z ddl m Z dd l mZ dd l mZ dd l mZ dd l mZ dd l mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl m Z ddl m Z ddl m Z ddl m Z ddl Z dd l!m"Z" dd l!m#Z$ dd l!m%Z% dd l!m&Z& dd l!m'Z' dd!l!m(Z) dd"l*m+Z+ dd#l,m-Z- dd$l,m.Z. dd%l,m/Z/ dd&l,m0Z0 dd'l,m1Z1 dd(l2m3Z3 dd)l2m4Z4 dd*l2m5Z5 dd+l2m6Z6 dd,l2m7Z7 dd-l2m8Z8 dd.l2m9Z9 dd/l:m;Z; d0d1l!m<Z< d0d l!m#Z= d0d2l!m>Z> d0d3l!m?Z? d0d4l!m@Z@ d0d5l!mAZA d0d!l!m(Z( d0d6l<mBZB d0d7l<mCZC d0d8lAm,ZD d0d9lAmEZE d0d:lAmFZF d0d;lAmGZG d0d<lAmHZH d0d=lAmIZI d0d!lAm(ZJ d0d>lAmKZK d0d?lLmMZM d0d@lNmOZO d0dAlPmQZQ d0dBlPmRZR d0dClSmTZT d0dDl(mUZU d0dEl(mVZV d0dFlWmXZX e �r�ddGl*mYZY ddHl*mZZZ ddIl*m[Z[ ddJl*m\Z\ ddKl]m^Z^ ddLl_m`Z` ddMlambZb ddNlamcZc ddOldmeZe ddPl%mfZf ddQl:mgZg ddRl'mhZh ddSlimjZj ddTlkmlZl ddUl(mmZm d0dVlnmoZo d0dWlnmpZp d0dXlqmrZr d0dYlqmsZs d0dZltmuZu d0d[lNmvZv d0d\lNmwZw d0d]lSmxZx d0d^l(myZy e d_e d`�Zze dadbd`�Z{e dcddd`�Z|e eXde ee eXde ee dfe e f f edg f ee dfe e f f Z}e �~� Zdhe�di< djdk�dldm�Z�dndk�dodp�Z�dqa�e(��dr�Z�e ��� Z�e>j�e?j�G dsdt� dte8e7e+ eMe5e?j�e>j�du eCee+ � ��Z�G dvdw� dwe��Z�dxdk�dydz�Z�d{d|dxd}�d~d�Z�e(��d��d{d|dxd}�d�d���Z�e(��d��d{d|dxd}�d�d���Z�d�d�� Z�dqd�d��d�d|d|d�d��d�d��Z�d�d�� Z�d�d�� Z�G d�d�� d�ed� �Z�dS )�a5 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.`. � )� annotations)�deque)�reduce)�chainN)�Any)�Callable)�cast)� Collection)�Deque)�Dict)� FrozenSet)�Generic)�Iterable)�Iterator)�List)�Mapping)�Optional)�Sequence)�Set)�Tuple)�Type)� TYPE_CHECKING)�TypeVar)�Union� )� attributes)�exc)�instrumentation)�loading)� properties)�util)�_O)�_class_to_mapper)�_parse_mapper_argument)� _state_mapper)� PassiveFlag)� state_str)�_MappedAttribute)�EXT_SKIP)�InspectionAttr)�MapperProperty)�ORMEntityColumnsClauseRole)�ORMFromClauseRole)�StrategizedProperty)� PathRegistry� )�event)� inspection)�log)�schema)�sql)� dispatcher)� EventTarget)�base)� coercions)� expression)� operators)�roles)� TableClause)�visitors)�MemoizedHasCacheKey)�KeyedColumnElement)�Column)�Table)� LABEL_STYLE_TABLENAME_PLUS_COL)� HasMemoized)�!HasMemoized_ro_memoized_attribute)�Literal)�_IdentityKeyType)� _InstanceDict)�_ORMColumnExprArgument)� _RegistryType)�registry)�DependencyProcessor)�CompositeProperty)�SynonymProperty)� MapperEvents)� ClassManager)�CachingEntityRegistry)�ColumnProperty)�RelationshipProperty)� InstanceState)� ORMAdapter)�Row)� RowMapping)�_ColumnExpressionArgument)�_EquivalentColumnMap)�ReadOnlyColumnCollection)� ColumnClause)� ColumnElement)� FromClause)� OrderedSet�_T)�bound�_MP�MapperProperty[Any]�_FnzCallable[..., Any]�*� Mapper[Any]r\ z.weakref.WeakKeyDictionary[_RegistryType, bool]�_mapper_registriesz Set[registry]��returnc C s$ t � tt�W 5 Q R � S Q R X d S �N)�_CONFIGURE_MUTEX�setre � rk rk �E/opt/hc_python/lib64/python3.8/site-packages/sqlalchemy/orm/mapper.py�_all_registries� s rm �Iterator[Mapper[Any]]c c s t � D ]} | �� E d H qd S rh )rm �_mappers_to_configure)�regrk rk rl �_unconfigured_mappers� s rq F� NO_ATTRIBUTEc @ s� e Zd ZU dZded< dZdZded< dZej dd��d�d dddddddddddddddddddd d d dddd dd d � d!d"��Z d#d$� Z d%d&� Z d Z dZd'ed(< ed)d*�d+d,��Zed-d.� �Zd ed/< d ed0< d1ed2< d3ed4< d5ed6< d7ed8< d9ed:< d ed;< d<ed=< d>ed?< d@edA< dBedC< dDedE< dFedG< dHedI< dJedK< dLedM< dedN< dedO< dPedQ< dRedS< dedT< dUedV< dUedW< dXedY< dZed[< dZded\< ded]< d^ed_< d`eda< dedb< dedc< ddede< dfedg< dedh< diedj< dkedl< dkedm< eje�dndo�dpdq� ��Zejdrd*�dsdt��Zdudv� Zddwdx�dydz�Zd{d|� Zd}d~� Zdd�� Z d�d�� Z dwd*�d�d��Z d�d�d�d��d�d��Z dwd*�d�d��Z dwd*�d�d��Z!�d�d�d��Z"d Z#e$j%d�d�� �Z&e$j%d�d�� �Z'e$j%d�d�� �Z(e�)d��d�d�� �Z*e�)d��d d dd��d�d�dddd�d��d�d���Z+d�d�d�d��d�d��Z,�d�d�d�dd�ddd�d��d�d��Z-e�)d��d�d�d�d��d�d���Z.ej/�0d�e1j2�dwd*�d�d���Z3dwd*�d�d��Z4d�d�� Z5d�d�dwd��d�d��Z6dwd*�d�d��Z7ed�d*�d�d���Z8d�ddwd��d�d��Z9d�ddwd��d�d��Z:d�d*�d�d��Z;d�d*�d�dZ<d�ddĜd�dƄZ=d�ddǜd�dɄZ>�d�d�dd�dʜd�d̄Z?d�d�dϜd�dфZ@ed�dӄ �ZAddd�d՜d�dׄZBd�ddUdٜd�dۄZCe$j%dd*�d�d݄�ZDe$j%d�d߄ �ZEe$j%d�d� �ZFe$j%d�d� �ZGe$j%d�d*�d�d��ZHe$j%d�d� �ZIeJdUd*�d�d��ZKeHZLeJd�d� �ZMe$j%d�d� �ZNe$j%d�d� �ZOe$j%d�d� �ZPe$j%d�d� �ZQe$j%d�d*�d�d���ZRe$j%d�d*�d�d���ZSe$j%d�d*�d�d���ZTe$j%d�d*�d�d���ZUe$j%d�d*�d��d ��ZVe$jW�d�d� �ZXej�d�d� �ZYedUd*��d�d��ZZ�d�d�dd�d�d ��d �d �Z[e$j%�d �d � �Z\e�d�d� �Z]�d��d�d�Z^e$j%�dd*��d�d��Z_�d��d�d�Z`e$j%�dd*��d�d��Zae$j%�dd*��d �d ��Zbe$j%e�)d���d d*��d �d ���Zce$j%e�)d���d!d*��d"�d#���Zde�d$�d%� �Zee$j%�d&d*��d'�d(��Zfe$j%e�)�d)��d*d*��d+�d,���Zge$j%e�)d���d-d*��d.�d/���Zh�d0�d1�d2��d3�d4�Zie$j%�d5�d6� �Zje$j%�d7d*��d8�d9��Zkd�dd�d:��d;�d<�Zle$j%�d=�d>� �Zm�d?�d@� Zndid�dA��dB�dC�Zodid�dA��dD�dE�Zp�dFdd�dG��dH�dI�Zqdid�dA��dJ�dK�Zr�dLd*��dM�dN�Zse$j%d�d*��dO�dP��Zt�dLd*��dQ�dR�Zudid*��dS�dT�Zvedid*��dU�dV��Zw�d��dW�dX�Zx�d��dYd�dZ�d[�d\��d]�d^�Zy�d��d_d�d[�d`��da�db�Zz�dc�d[�dd��de�df�Z{e|j}fdÐdg�d[�dh��di�dj�Z~�dc�d_�dd��dk�dl�Ze$j%�dm�dn� �Z�e$j%�do�dp� �Z�e$j%�dq�dr� �Z�e$j%�ds�dt� �Z�e$j%�du�dv� �Z�e|j}fdÐdw�dx�dgd�dy��dz�d{�Z��d|�d}� Z��d~�d� Z��d��d�� Z�e|j}f�d��d��Z��d��d�� Z��d��d�� Z�e$j%�d��d�� �Z��d��d�� Z��d��d�� Z�e�)�d���d��d�� �Z�e$j%�d��d�� �Z��d�d�dÐd��d��d���d��d��Z�e$j%�d��d�� �Z�e$j%�d��d�� �Z�e$j%�d��d�� �Z�d�d��d��d���d��d��Z�ej�d��d�� �Z�d S (� �Mappera� Defines an association between a Python class and a database table or other relational structure, so that ORM operations against the class may proceed. The :class:`_orm.Mapper` object is instantiated using mapping methods present on the :class:`_orm.registry` object. For information about instantiating new :class:`_orm.Mapper` objects, see :ref:`orm_mapping_classes_toplevel`. zdispatcher[Mapper[_O]]�dispatchFr �_configure_failed)�1.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:`_orm.relationship` in 1.3.)� non_primaryNT�auto�d zType[_O]zOptional[FromClause]z+Optional[Mapping[str, MapperProperty[Any]]]z/Optional[Iterable[_ORMColumnExprArgument[Any]]]�boolz'Optional[Union[Mapper[Any], Type[Any]]]z)Optional[_ColumnExpressionArgument[bool]]z/Optional[Sequence[_ORMColumnExprArgument[Any]]]z%Optional[_ORMColumnExprArgument[Any]]z5Optional[Union[Literal[False], Callable[[Any], Any]]]zFOptional[Union[_ORMColumnExprArgument[Any], str, MapperProperty[Any]]]z Optional[Dict[Any, Mapper[Any]]]z Optional[Any]z Optional[_WithPolymorphicArg]z)Optional[Literal[('selectin', 'inline')]]z Optional[str]zOptional[Sequence[str]]z Literal[(True, False, 'auto')]�int) �class_� local_tabler � primary_keyrw �inherits�inherit_condition�inherit_foreign_keys�always_refresh�version_id_col�version_id_generator�polymorphic_on�_polymorphic_map�polymorphic_identity�concrete�with_polymorphic�polymorphic_abstract�polymorphic_load�allow_partial_pks�batch� column_prefix�include_properties�exclude_properties�passive_updates�passive_deletes�confirm_deleted_rows�eager_defaults�legacy_is_orphan�_compiled_cache_sizec C s� t �|td�| _d| jj| jjf | _t �|�| _|| _ | | _ t | t �rV| | _ d| _n | dk rptjtj| dd�nd| _| dkr�d| _n| dkr�dd� | _n| | _|| _d| _|dk r�t|�| _nd| _|dk r�tjtj|d d d �| _n.| jr�| jj| _d | _nt�d | jj� d ���|dk �r0t�tj |�| _ nd| _ || _ |�rJt |�ni | _ g | _!|| _"|| _#|| _$| dk �r�tjtj| dd�nd| _%|| _&g | _'t j(| _)|| _*|| _+| | _,d| _-d| _.d| _/i | _0| | _1d| _2|| _3| j�r�| j�s�d| _4n|| _4| �5|� || _6|| _7| dk�r i | _8n| | _8|dk �r>t �9|�| _:nd| _:|�rXt �9|�| _;nd| _;t<�b t=d| j>j?��@|| � | �A� | �B� | �C� | �D� | �E� | jF�G| � | �Hd� | �I� W 5 Q R X | j>�J| | j� dS )a�V Direct constructor for a new :class:`_orm.Mapper` object. The :class:`_orm.Mapper` constructor is not called directly, and is normally invoked through the use of the :class:`_orm.registry` object through either the :ref:`Declarative <orm_declarative_mapping>` or :ref:`Imperative <orm_imperative_mapping>` mapping styles. .. versionchanged:: 2.0 The public facing ``mapper()`` function is removed; for a classical mapping configuration, use the :meth:`_orm.registry.map_imperatively` method. Parameters documented below may be passed to either the :meth:`_orm.registry.map_imperatively` method, or may be passed in the ``__mapper_args__`` declarative class attribute described at :ref:`orm_declarative_mapper_options`. :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:`_schema.Table` or other :class:`_sql.FromClause` (i.e. 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 :attr:`_orm.DeclarativeBase.__table__` attribute or via the :class:`_schema.Table` produced as a result of the :attr:`_orm.DeclarativeBase.__tablename__` attribute being present. :param polymorphic_abstract: Indicates this class will be mapped in a polymorphic hierarchy, but not directly instantiated. The class is mapped normally, except that it has no requirement for a :paramref:`_orm.Mapper.polymorphic_identity` within an inheritance hierarchy. The class however must be part of a polymorphic inheritance scheme which uses :paramref:`_orm.Mapper.polymorphic_on` at the base. .. versionadded:: 2.0 .. seealso:: :ref:`orm_inheritance_abstract_poly` :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.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:`_schema.Column` objects are automatically assigned as attributes to the mapped class. Does not affect :class:`.Column` objects that are mapped explicitly in the :paramref:`.Mapper.properties` dictionary. This parameter is typically useful with imperative mappings that keep the :class:`.Table` object separate. Below, assuming the ``user_table`` :class:`.Table` object has columns named ``user_id``, ``user_name``, and ``password``:: class User(Base): __table__ = user_table __mapper_args__ = {'column_prefix':'_'} The above mapping will assign the ``user_id``, ``user_name``, and ``password`` columns to attributes named ``_user_id``, ``_user_name``, and ``_password`` on the mapped ``User`` class. The :paramref:`.Mapper.column_prefix` parameter is uncommon in modern use. For dealing with reflected tables, a more flexible approach to automating a naming scheme is to intercept the :class:`.Column` objects as they are reflected; see the section :ref:`mapper_automated_reflection_schemes` for notes on this usage pattern. :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. :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. The fetch of values occurs either by using ``RETURNING`` inline with the ``INSERT`` or ``UPDATE`` statement, or by adding an additional ``SELECT`` statement subsequent to the ``INSERT`` or ``UPDATE``, if the backend does not support ``RETURNING``. The use of ``RETURNING`` is extremely performant in particular for ``INSERT`` statements where SQLAlchemy can take advantage of :ref:`insertmanyvalues <engine_insertmanyvalues>`, whereas the use of an additional ``SELECT`` is relatively poor performing, adding additional SQL round trips which would be unnecessary if these new attributes are not to be accessed in any case. For this reason, :paramref:`.Mapper.eager_defaults` defaults to the string value ``"auto"``, which indicates that server defaults for INSERT should be fetched using ``RETURNING`` if the backing database supports it and if the dialect in use supports "insertmanyreturning" for an INSERT statement. If the backing database does not support ``RETURNING`` or "insertmanyreturning" is not available, server defaults will not be fetched. .. versionchanged:: 2.0.0rc1 added the "auto" option for :paramref:`.Mapper.eager_defaults` .. seealso:: :ref:`orm_server_defaults` .. versionchanged:: 2.0.0 RETURNING now works with multiple rows INSERTed at once using the :ref:`insertmanyvalues <engine_insertmanyvalues>` feature, which among other things allows the :paramref:`.Mapper.eager_defaults` feature to be very performant on supporting backends. :param exclude_properties: A list or set of string column names to be excluded from mapping. .. seealso:: :ref:`include_exclude_cols` :param include_properties: An inclusive list or set of string column names to map. .. seealso:: :ref:`include_exclude_cols` :param inherits: A mapped class or the corresponding :class:`_orm.Mapper` of one indicating a superclass to which this :class:`_orm.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:`_schema.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 orphan 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:`_orm.Mapper` is in addition to the "primary" mapper, that is, the one used for persistence. The :class:`_orm.Mapper` created here may be used for ad-hoc mapping of the class to an alternate selectable, for loading only. .. seealso:: :ref:`relationship_aliased_class` - the new pattern that removes the need for the :paramref:`_orm.Mapper.non_primary` flag. :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. .. seealso:: :ref:`passive_deletes` - description of similar feature as used with :func:`_orm.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:`_orm.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. May be specified as a string attribute name, or as a SQL expression such as a :class:`_schema.Column` or in a Declarative mapping a :func:`_orm.mapped_column` object. It is typically expected that the SQL expression corresponds to a column in the base-most mapped :class:`.Table`:: class Employee(Base): __tablename__ = 'employee' id: Mapped[int] = mapped_column(primary_key=True) discriminator: Mapped[str] = mapped_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: Mapped[int] = mapped_column(primary_key=True) discriminator: Mapped[str] = mapped_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 using its string name, which is of particular use when using annotated column configurations:: class Employee(Base): __tablename__ = 'employee' id: Mapped[int] = mapped_column(primary_key=True) discriminator: Mapped[str] __mapper_args__ = { "polymorphic_on": "discriminator", "polymorphic_identity": "employee" } When setting ``polymorphic_on`` to reference an attribute or expression that's not present in the locally mapped :class:`_schema.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 :paramref:`_orm.Mapper.polymorphic_on` setting. As rows are received, the value corresponding to the :paramref:`_orm.Mapper.polymorphic_on` column expression is compared to this value, indicating which subclass should be used for the newly reconstructed object. .. seealso:: :ref:`inheritance_toplevel` :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:`_schema.Column` objects present in the mapped :class:`_schema.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. .. seealso:: :ref:`orm_mapping_properties` - in the :ref:`orm_mapping_classes_toplevel` :param primary_key: A list of :class:`_schema.Column` objects, or alternatively string names of attribute names which refer to :class:`_schema.Column`, 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. .. versionchanged:: 2.0.2 :paramref:`_orm.Mapper.primary_key` arguments may be indicated as string attribute names as well. .. seealso:: :ref:`mapper_primary_key` - background and example use :param version_id_col: A :class:`_schema.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. .. 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. The :paramref:`_orm.Mapper.polymorphic_load` parameter may be preferable over the use of :paramref:`_orm.Mapper.with_polymorphic` in modern mappings to indicate a per-subclass technique of indicating polymorphic loading styles. .. seealso:: :ref:`with_polymorphic_mapper_config` r| z%s.%sNr� ��argnameFc S s | pdd S )Nr r rk )�xrk rk rl �<lambda>� � z!Mapper.__init__.<locals>.<lambda>Tr} )Zdisable_inspectionr� zMapper[zM(None)] has None for a primary table argument and does not specify 'inherits'r� rN Z constructed)Kr Zassert_arg_type�typer| � __module__�__name__� _sort_key�to_list�_primary_key_argumentrw r� � isinstancer* Zversion_id_propr� r8 �expectr; ZColumnArgumentOrKeyRoler� r� �singler# r �StrictFromClauseRoler} �sa_exc� ArgumentErrorZ OnClauseRoler� r� �dict�_init_properties�_delete_orphansr� r� r� r� r� �_dependency_processors� EMPTY_DICT� validatorsr� r� r� Z_clause_adapter�_requires_row_aliasing�_inherits_equated_pairs�_memoized_valuesr� �_reconstructorr� r� �_set_with_polymorphicr� r� �polymorphic_map�to_setr� r� ri r rt Z_eventsZ_new_mapper_instance�_configure_inheritance� _configure_class_instrumentation�_configure_properties� _configure_polymorphic_setter�_configure_pksrJ Z_flag_new_mapper�_log�_expire_memoizationsZafter_mapper_constructed) �selfr| r} r r~ rw r r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rk rk rl �__init__� s� � ��� � � � ��� � zMapper.__init__c C s. | j dkr$|jsdS || jko"|jS | j S d S )Nrx F)r� Zimplicit_returning�_server_default_col_keysZ insert_executemany_returning)r� �dialect�tablerk rk rl �_prefer_eager_defaults\ s �z Mapper._prefer_eager_defaultsc C s | fS rh rk )r� Zanon_mapZ bindparamsrk rk rl �_gen_cache_keyh s zMapper._gen_cache_keyrI rJ � Mapper[_O]rf c C s | S )z<Part of the inspection API. Returns self. rk �r� rk rk rl �mapperu s z Mapper.mapperc C s | j S )zDPart of the inspection API. Returns self.class\_. �r| r� rk rk rl �entity~ s z Mapper.entityr| �_identity_classzList[Tuple[str, Type[Any]]]r� zList[DependencyProcessor]r� z Dict[Any, Callable[[], Any]]r� z util.WeakSequence[Mapper[Any]]�_inheriting_mapperszSet[TableClause]� _all_tables�_polymorphic_attr_keyz/Dict[FromClause, OrderedSet[ColumnClause[Any]]]� _pks_by_tablez0Dict[FromClause, OrderedSet[ColumnElement[Any]]]�_cols_by_tablez*util.OrderedDict[str, MapperProperty[Any]]�_propsz Dict[str, MapperProperty[Any]]r� �_ColumnMapping�_columntopropertyz-Optional[Callable[[InstanceState[_O]], None]]�_set_polymorphic_identityzHOptional[Callable[[Mapper[_O], InstanceState[_O], _InstanceDict], None]]� _validate_polymorphic_identityzSequence[TableClause]�tablesz3util.immutabledict[str, Tuple[str, Dict[str, Any]]]r� r� r� z Optional[ColumnElement[Any]]r� zcOptional[Tuple[Union[Literal['*'], Sequence[Union[Mapper[Any], Type[Any]]]], Optional[FromClause]]]r� r� r\ r} �persist_selectablezOptional[Mapper[Any]]r z Optional[ColumnElement[bool]]r� � configuredr� zTuple[Column[Any], ...]r~ zClassManager[_O]� class_managerr� rw z!Optional[KeyedColumnElement[Any]]r� zDict[Any, Mapper[Any]]r� r� rd � base_mapperz*ReadOnlyColumnCollection[str, Column[Any]]�columns�crv zUse .persist_selectablec C s | j S rh )r� r� rk rk rl � mapped_table� s zMapper.mapped_tablerP c C s t �| �S rh )r. Z per_mapperr� rk rk rl �_path_registry� s zMapper._path_registryc C s< t �� | _| j�r�t| j| jj�s>t�d| jj| jjjf ��| j � | jj � | j | jj kr�| j rhdpjd}t�d|| jj|f ��| j r�| jj | _ �n�| j| jjk �r| jr�| j| _ | �� D ]}|jdk r�d|_q��q | jdk�r�zt�| jj| j�| _W n� tjk �rb } zD| jjdk �s$t�| jdk �s4t�t�d| jjj| jjf �|�W 5 d}~X Y nf tjk �r� } zD| jjdk �s�t�| jdk �s�t�t�d| jjj| jjf �|�W 5 d}~X Y nX | jj dk �s�t�t�| jj | j| j�| _ t � | j �}tj | j j |d �| _ n| j| _ | j!dk�rf| j| _"| j#�s�| jj$jdk �r�t �%| � d | jj$j� d �� n | j�rx| j| _"n | jj"| _"| j&dk�r�| jj&| _&| jj'| _'n:| jj&dk �r�| j&| jj&k �r�t �%d | j&j| jj&jf � | jj(| _(| jj)| _)| jj�*| � | jj$| _$| jj+| _+| jj,�p"| j,| _,| jj-| _-| j!dk �rx| j!| j(k�rlt �%d | j!| j(| j! | | j!f � | | j(| j!< | j.�r�| j�r�t�d��| j.dk�r�| j�/| � n*| j.dk�r�n | j.dk �r t�d| j. ��nFt0� | _-| | _$| jdk �s�t�| j| _ | j!dk �r| | j(| j!< | j| _"| j dk�r8t�d| ��dS )zXConfigure settings related to inheriting and/or inherited mappers being present.z%Class '%s' does not inherit from '%s'�primaryz non-primaryzHInheritance of %s mapper for class '%s' is only allowed from a %s mapperNTa7 Can't determine the inherit condition between inherited table '%s' and inheriting table '%s'; tables have no foreign key relationships established. Please ensure the inheriting table has a foreign key relationship to the inherited table, or provide an 'on clause' using the 'inherit_condition' mapper argument.z�Can't determine the inherit condition between inherited table '%s' and inheriting table '%s'; tables have more than one foreign key relationship established. Please specify the 'on clause' using the 'inherit_condition' mapper argument.)Zconsider_as_foreign_keysz| does not indicate a 'polymorphic_identity', yet is part of an inheritance hierarchy that has a 'polymorphic_on' column of 'a' '. If this is an intermediary class that should not be instantiated, the class may either be left unmapped, or may include the 'polymorphic_abstract=True' parameter in its Mapper arguments. To leave the class unmapped when using Declarative, set the '__abstract__ = True' attribute on the class.z�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.)1r � WeakSequencer� r � issubclassr| r� r� r� rt �_updaterw r� r� r} r� �iterate_to_rootr� r� r� �sql_utilZjoin_conditionZNoForeignKeysError�AssertionError� descriptionZAmbiguousForeignKeysErrorr4 �joinr� r� Zcriterion_as_pairsZonclauser� r� r� r� r� �warnr� r� r� r� �appendr� r� r� r� � _add_with_polymorphic_subclassrj )r� �npr� ZnfeZafeZfksrk rk rl r� � s �� �� � ������� � � � � �� � ���� � ��� � �� ��z Mapper._configure_inheritance�None)r� rg c C s� |dkrd| _ n\t|ttf�rLt|d tttf�r@td|�| _ ql|d f| _ n |d k rft�d|����nd | _ | j r�| j d d k r�| j d tj t j | j d dd�f| _ | j r�| � � d S ) Nrc )rc Nr z�Tuple[ Union[ Literal["*"], Sequence[Union["Mapper[Any]", Type[Any]]], ], Optional["FromClause"], ]z&Invalid setting for with_polymorphic: r T�Z allow_select)r� r� �tuple�list�strr r� r� r8 r� r; r� r� r� )r� r� rk rk rl r� ` s0 � ��� z Mapper._set_with_polymorphicc C sd |j }| jd kr | �|f� nB| jd dkr`t| jd t�s@t�| �| jd |f | jd f� d S )Nr rc r )r| r� r� r� r� r� )r� r� Zsubclrk rk rl r� � s �z%Mapper._add_with_polymorphic_subclassc C s� | j s t�| jrt�t|t�s"t�|| _| jj�| j� | jj| _| �� D ]}|jdk rJd|_ qJ| jj | _ | j D ]}| jj |_ qp| jj �| � | jj| _| jj| _|j�� D ]2\}}|| jkr�| j||ddd�s�| �||d� q�dS )z�Set the given :class:`_orm.Mapper` as the 'inherits' for this :class:`_orm.Mapper`, assuming this :class:`_orm.Mapper` is concrete and does not already have an inherits.NTF��local�column)r� r� r r� rs r� �updater� r� r� r� �self_and_descendantsr� r� r� r� r� r� �items�_should_exclude�_adapt_inherited_property)r� r� �mp�key�proprk rk rl �_set_concrete_base� s. �zMapper._set_concrete_basec C s || _ | �d� d S )NT)r� r� )r� r� rk rk rl �_set_polymorphic_on� s zMapper._set_polymorphic_onc C s� t �| j�}| jrb|r |js,t�d| j ��|| _|jdk s@t �|j| _|j j | _ |j� | � dS |dksp|jszt�d��| j �| | j� tj| j| t�tj| �dd�}|| _|jdk s�t �|j| _|j dkr�dS tj|dtdd� t�| j�D ]�\}}|dk�r&t|d ��r&|j}t|d ��r&|j}t |�r�t|d ��rT|| _ tj|d t dd� q�t|d �r�|j }|j D ]:}|| j!k�r�t�d|| f ��| j!�"|||fi�| _!�qjq�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.Nz�The _mapper() function and Mapper() constructor may not be invoked directly outside of a declarative registry. Please use the sqlalchemy.orm.registry.map_imperatively() function for a classical mapping.T)r� Zexpired_attribute_loader�finalize�init)�rawr� �_sa_original_init�__func__�__sa_reconstructor__�load�__sa_validators__zJA validation function for mapped attribute %r on mapper %s already exists.)#r Zopt_manager_of_classr| rw Z is_mappedr� �InvalidRequestErrorr� rJ r� r� r� Z_add_non_primary_mapperrt �instrument_classr Zregister_classr �partialr Zload_scalar_attributesr0 �listen�_event_on_initZiterate_attributes�hasattrr r �callabler� �_event_on_load�__sa_validation_opts__r r� �union)r� �managerr� �methodZvalidation_opts�namerk rk rl r� � sn �� � �� �� �z'Mapper._configure_class_instrumentationc C s$ d| _ d| _d| _| j�dd � d S )NTru )r� �_ready_for_configure�_dispose_called�__dict__�popr� rk rk rl �_set_dispose_flags s zMapper._set_dispose_flagsr� z Column[Any])r� r� rg c C s� z| j | }W n< tk rJ } z t�d|� d|� d��|�W 5 d }~X Y nX z |j}W n< tk r� } z t�d|� d|� d��|�W 5 d }~X Y nX t|t�s�t�d|� d|� d���|S )NzCan't determine z column 'z(' - no attribute is mapped to this name.z4'; property does not refer to a single mapped Column)r� �KeyErrorr� r� r9 �AttributeErrorr� r@ )r� r� r� r� �err�exprZaerk rk rl �_str_arg_to_mapped_col s* �� �� �z Mapper._str_arg_to_mapped_colc sF t �� j�� _� j�dd� � jD �� i � _i � _t� t dd� � j D �� �}t� dd� |D ��}t � j�� � jg�D ]F}|jr�|�|j�r�t�|j��|�� j|< t�|j��|�� j|< qt� jr� fdd�dd� � jD �D �}nd }|�r(|D ]4}|j� jk�rt�� � j|j< � j|j �|� q�nl� j� jk�sLt� j� j �dk�rdt�d � � jjf ��n0� j� jk�r�t � jt j ��r�t� d � jj � � j �r�� j!�s�� j�s�� j j� _nt|�r�d d� � fd d�|D �D �}nt j"� j� j d d�}t|�dk�rt�d � � jjf ��t#|�� _� �$d|� � fdd�� j D �� _%d S )Nc s s | ] }|V qd S rh rk )�.0�trk rk rl � <genexpr>. s z(Mapper._configure_pks.<locals>.<genexpr>c S s g | ] }|j �qS rk �� proxy_set�r �colrk rk rl � <listcomp>4 s z)Mapper._configure_pks.<locals>.<listcomp>c s s | ]}|j r|V qd S rh �r~ �r r� rk rk rl r 7 s c s& g | ] }t |t�r � �d |�n|�qS r$ )r� r� r r% r� rk rl r# H s ��c s s | ]}t jtj|d d�V qdS )r~ r� N)r8 r� r; ZDDLConstraintColumnRole)r Z coerce_pkrk rk rl r N s ��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 s g | ]\}}|d k r|n|�qS rh rk )r �ccr� rk rk rl r# � s �c 3 s | ]}� j �|�|fV qd S rh )r� �corresponding_columnr% r� rk rl r � s �T)Zignore_nonexistent_tablesz"Identified primary key columns: %sc s< h | ]4}� j | � jkrt|d �r.|j� jkr� j | �qS �r� )r� �_identity_key_propsr r� r� r! r� rk rl � <setcomp>� s �z(Mapper._configure_pks.<locals>.<setcomp>)&r� � find_tablesr� r� r� r� r� r� r Z column_setr r� rj r r~ � issupersetZordered_column_set� intersectionr� r� r� r] �add�lenr� r� r� r} r� r3 rA r� r r� Zreduce_columnsr� r� �_readonly_props)r� Zall_cols�pk_cols�fcZcoerced_pk_arg�kr~ rk r� rl r� + s� ��� � �� �� �� ������ �� � �� �zMapper._configure_pksc C s t �� | _| _t�� | _t| �| _i }i }| j r�| j � � D ]z\}}t |t �s\| � ||�}n|}d}t |tj�r�|jD ]*}| jj�|�rvd}|||< ||f||< qv|r<| j||dd� q<| j�rH| jj� � D ]z\}}| j||dd d�r�q�|�|�} | �r.| j||d| d�} | ||< | jD ]} || f|| < �qq�|| jkr�| �||d� q�| jjD ]�} | |k�r�|| \}} | j|| dd� �qPn| | jk�r��qP| j�p�d| j }| j| j|| jj�| �| d��rƐqP| �� D ] }| |jk�r�|j| j}�q�| j|| ddd� �qPd S )NTF)r� r� )� warn_only� incoming_prop� �r� � setparent) �sql_baseZColumnCollectionr� r� r � OrderedDictr� r� r� r� r� r� r* �_make_prop_from_columnr rQ r} Zcontains_column�_configure_propertyr r� �get�%_reconcile_prop_with_incoming_columnsr� r� r� r� r� )r� Z explicit_col_props_by_columnZexplicit_col_props_by_keyr� �prop_argZpossible_col_propZ_map_as_property_nowZ given_colZinherited_propr5 �new_propZinc_colr� r� Z column_keyr� rk rk rl r� � s� � � � � � � � �z Mapper._configure_propertiesc s� d}d� | j dk �r�d}t| j t�rlz| j| j | _ W n4 tk rj } zt�d| j �|�W 5 d}~X Y nX | j | jkr�| j| j }�nt| j t�r�t| j t j �s�t�d��| j }n�| j � | j �}|dk�r,d}d}| j }t|t j��r0| jdk�s| jd dk�s| jd � |�dk�r0t�d|j ��nd}t|dd�}|�rd| �||d|��rzt�d | ��n|�d � | _ }|j}t j ||d �}| j|||dd � |jd | _ |j� n|| �� D ]r}|j dk �r�| j |j k�r�|j | _ n| j � |j �| _ | j dk �r|j| _|j| _|j| _n d| _d| _ dS �q�| j �rH| j dk�rHt�d��|�rz� fdd�} � | _� fdd�} | | _| | _n d| _d| _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 _instrumentr7 r z�The Mapper.polymorphic_abstract parameter may only be used on a mapper hierarchy which includes the Mapper.polymorphic_on parameter at the base of the hierarchy.c sR | j }| jjj}|d kr8| jjjr8t�d| jj� d���| �� ��| ||d � d S )Nz Can't instantiate class for z,; mapper is marked polymorphic_abstract=True) r� r r� r� r� r� r Zget_implrj )�state�dict_r� �Zpolymorphic_keyrk rl r� � 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& )r� rA rB rC rk rl r� � s ����zLMapper._configure_polymorphic_setter.<locals>._validate_polymorphic_identity) r� r� r� r� r r� r� r� r* r rQ r� r' r3 r@ r� r r� �getattrr� �labelr� r< r� r� r� r� r� r� ) r� r� �setterr r� r" Z instrumentr� r� r� r� rk rC rl r� s� ��� ��� � ����� �� �� ��� � �z$Mapper._configure_polymorphic_setterc C s | j d k r| j| j S d S d S rh )r� r� r� rk rk rl �_version_id_prop� s zMapper._version_id_propc C sF t � }t| g�}|rB|�� }|j| jkr|�|j� |�|j� q|S rh )rj r �popleftr� r. r� �extendr� )r� Z identities�stack�itemrk rk rl rD � s z)Mapper._acceptable_polymorphic_identitiesc C s t | j�� �S rh )� frozensetr� �valuesr� rk rk rl � _prop_set� s zMapper._prop_setz sqlalchemy.orm.descriptor_propsc C st t jj}| js"| j||ddd� nN|| jkrp| j�||�}||ksZt|t j �rp|j |j krp| j||� � |dd� d S )NFr7 T)r � preloaded�orm_descriptor_propsr� r< r� r� �_get_class_attr_mror� r ZInstrumentedAttributeZ _parententity�parent�ConcreteInheritedProperty)r� r� r� r� �descriptor_propsZimplementing_attributerk rk rl r� � s, � �� ��z Mapper._adapt_inherited_property)r� r8 �warn_for_existingz3Union[KeyedColumnElement[Any], MapperProperty[Any]]ra )r� r? r� r8 rV rg c C s� t jj}| �d||jj� t|t�s2| �||�}n|}t|t j ��r�| j � |j d �}|d kr�| jr�| g} | j�� D ]T} | j� |j d �}|d k r�| D ]} | j �|� q�| j � |j d �} q�| �| � qt|d k�r|j d }t| d��rPt|d��r|j| jk�rP| j�|� n>t| d��rP|j| jk�rP|| j|j k�rP| j|j �|� t|d��sz|| jk�pv|j d | jk|_t|tj��r�| |_ |_ | j �||� |j D ] }|j D ]} || j | < �q��q�t |d|�|k�rt �!d| j"j� d |j � d |�d |j �d |j �d � � ||_ |�r&|�#| |� || j$k�rht | j$| d d��rh| j$| j%} t&�'d| ||| f ��|| j$k�r�t| j$| |j(��s�t||j)��s�|�r�t �*d| j"j� d |� d| � d�d� | j$| }| j+�,|d � nf|�r@| j"j-�.|d �d k �r@t||j)��s@t| j$�.|d �|j(��s@t �*d| j"j� d |� d| � d�d� || j$|< | j/�s\|�0| � | j1D ]}|�2|||� �qb|�r�|�3� |�4| � | j5�r�| �6� |S )Nz_configure_property(%s, %s)r r0 r� r� � _is_polymorphic_discriminatorr� zORM mapped property �.z being assigned to attribute z& is already associated with attribute z+. The attribute will be de-associated from �_mapped_by_synonymFzpCan't call map_column=True for synonym %r=%r, a ColumnProperty already exists keyed to the name %r for column %rzUser-placed attribute z on z� is replacing an existing ORM-mapped attribute. Behavior is not fully defined in this case. This use is deprecated and will raise an error in a future releasez2.0z� is replacing an existing class-bound attribute of the same name. Behavior is not fully defined in this case. This use is deprecated and will raise an error in a future release)7r rP rQ r� � __class__r� r� r* �_property_from_columnr rQ r� r' r� r r� r} �_refresh_for_new_columnr� r r� r� r0 r. r� rW r9 �Labelr� Z _tq_key_labelr r� rE r� r| Z set_parentr� rY r� r� rT rM Zwarn_deprecatedr� r r r= rw r r� r� r� �post_instrument_classr� r� )r� r� r? r� r8 rV rU r� r" �path�m�m2Z proxy_col�synZoldpropr� rk rk rl r< s� � �� � �� �� � ,� � �� � �� �� �� � �� � zMapper._configure_propertyzAUnion[Sequence[KeyedColumnElement[Any]], KeyedColumnElement[Any]]zColumnProperty[Any])r� r� rg c C s� t �|�}g }|D ]j}| j�|�}|d krr| j�|�}|d k rJ| j�|� | j�|�}|d krrt�d|| |f ��|�|� qt j |� S )Nz�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.) r r� r� r' r} r\ r� r� r� r rQ )r� r� r� r� Z mapped_columnr� Zmcrk rk rl r; � s" �� z Mapper._make_prop_from_columnz Optional[ColumnProperty[Any]])r� � existing_propr4 r5 � single_columnrg c C s |r| j st|tj�s|S |jd }|r6||jkr6|S |d kr^|d k sJt�|}|jd |f}n$|d ksjt�|jd }||jd f}| jr�|| jkr�|�|�s�|| jk r�|| jk r�d|jd ||f } |r�t � | � n t � | ��|� � } | j�d|� | �d|� | S )Nr z�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 %s)r� r� r rQ r� r� r� Zshares_lineager� r r� r� r �copy�insertr� ) r� r� rc r4 r5 rd Zexisting_columnZincoming_columnZequated_pair_key�msgr@ rk rk rl r> � sV � � ����� ��� �z,Mapper._reconcile_prop_with_incoming_columnszKeyedColumnElement[Any]c C st t jj}| j�|�}t|tj�r8| j||||j | k d�S |dksLt||j �rX| � ||�S t � d|| |j|f ��dS )zrgenerate/update a :class:`.ColumnProperty` given a :class:`_schema.Column` or other SQL expression object.)rd r4 Na� 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 rP rQ r� r= r� r rQ r> rS rT r; r� r� r� )r� r� r� rU r� rk rk rl r[ ' s& � � ��z Mapper._property_from_columnz�This warning originated from the `configure_mappers()` process, which was invoked automatically in response to a user-initiated operation.c C s | j jrt| j hdd� d S )NT��cascade)rJ � _new_mappers�_configure_registriesr� rk rk rl �_check_configureL s zMapper._check_configurec C st | � d� dd� | j�� D �}|D ]<\}}| � d|� |j| krN|jsN|�� |jr"|�| � q"| � 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 rk rk )r r� r� rk rk rl r# ` s z5Mapper._post_configure_properties.<locals>.<listcomp>zinitialize prop %sz%_post_configure_properties() completeTN) r� r� r� rS Z_configure_startedr� Z_configure_finishedr^ r� )r� �lr� r� rk rk rl �_post_configure_propertiesV s z!Mapper._post_configure_propertiesc C s" |� � D ]\}}| �||� qdS )z^Add the given dictionary of properties to this mapper, using `add_property`. N)r� � add_property)r� Zdict_of_propertiesr� �valuerk rk rl �add_propertiesm s zMapper.add_propertiesz'Union[Column[Any], MapperProperty[Any]])r� r� rg c C s0 | j ||| jdd�}t|t�s"t�|| j|< 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. T)r� rV N)r< r� r� r* r� r� )r� r� r� rk rk rl rp u s �zMapper.add_propertyc C s | � � D ] }|�� qd S rh )r� Z_reset_memoizations�r� r� rk rk rl r� � s zMapper._expire_memoizationsc C s> d| j j d | jd k r | jjp(t| j� | jr4dp6d d S )N�(�|z |non-primaryr6 �))r| r� r} r� r� rw r� rk rk rl � _log_desc� s �� �� � ��zMapper._log_desc)rh �argsrg c G s" | j jd| f| jf| �� d S �Nz%s )�logger�inforw �r� rh rx rk rk rl r� � s z Mapper._logc G s" | j jd| f| jf| �� d S ry )rz �debugrw r| rk rk rl � _log_debug� s zMapper._log_debugc C s dt | �| jjf S )Nz<Mapper at 0x%x; %s>)�idr| r� r� rk rk rl �__repr__� s zMapper.__repr__c C s2 d| j j| jrdpd| jd k r&| jjn| jjf S )NzMapper[%s%s(%s)]z (non-primary)r6 )r| r� rw r} r� r� r� rk rk rl �__str__� s � �zMapper.__str__zInstanceState[_O])rA rg c C st d}| � � D ]T}|jD ]H\}}d}t�|�j|||jd�}| jrL|rL dS | js|s dS qq | jrl|S dS d S )NFT)Z optimistic)r� r� r Zmanager_of_class� has_parentZ has_identityr� )r� rA Zorphan_possibler� r� �clsr� rk rk rl � _is_orphan� s � zMapper._is_orphan)r� rg c C s || j kS rh )r� �r� r� rk rk rl � has_property� s zMapper.has_property)r� �_configure_mappersrg c C sZ |r | � � z | j| W S tk rT } z t�d| � d|� d��|�W 5 d}~X Y nX dS )z6return a MapperProperty associated with the given key.zMapper 'z' has no property 'zw'. If this property was indicated from other mappers or configure events, ensure registry.configure() has been called.N)rm r� r r� r )r� r� r� r rk rk rl � get_property� s ��zMapper.get_propertyzColumnElement[_T]zMapperProperty[_T])r� rg c C s | j | S )zkGiven a :class:`_schema.Column` object, return the :class:`.MapperProperty` which maps this column.�r� )r� r� rk rk rl �get_property_by_column� s z Mapper.get_property_by_columnc C s t | j�� �S )z1return an iterator of all MapperProperty objects.)�iterr� rN r� rk rk rl �iterate_properties� s zMapper.iterate_propertieszSequence[Mapper[Any]])�spec� selectablerg c s� |dkrt | j�}nz|r�t� � t�|�D ]J}t|�}|�| �sPt�d|| f ��|dkrh� � |� � � q(� � |� q(� 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. rc z%r does not inherit from %rNc s g | ]}|� kr|�qS rk rk �r r` )� mapper_setrk rl r# � s z-Mapper._mappers_from_spec.<locals>.<listcomp>T)Zinclude_aliasesc s g | ]}|j � kr|�qS rk )r} r� )r� rk rl r# s )r� r� rj r r� r" �isar� r r� r� r. r� r+ )r� r� r� �mappersr` rk )r� r� rl �_mappers_from_spec� s* � �zMapper._mappers_from_speczIterable[Mapper[Any]])r� � innerjoinrg c C s\ | j }|D ]L}|| krq |jr*t�d��q |js |rF|�|j|j�}q |�|j|j�}q |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.) r� r� r� r r� r� r} r� Z outerjoin)r� r� r� Zfrom_objr` rk rk rl �_selectable_from_mappers s& � � �z Mapper._selectable_from_mappersc C sL | j }|d krdS t|t�s dS |jd k pF|jd k oF|jj oF|jj S d S )NFT)r� r� r@ �server_default�defaultZ is_scalar� is_callable)r� Zvid_colrk rk rl �!_version_id_has_server_side_value$ s �z(Mapper._version_id_has_server_side_valuec C sB | j r:| jr:| jd k r:| j�| | d���dd� | jD ��S d S d S )N)� parententity� parentmapperc S s g | ]}|j s|j�qS rk )r� r� r� rk rk rl r# < s �z2Mapper._single_table_criterion.<locals>.<listcomp>)r� r r� � _annotate�in_r� r� rk rk rl �_single_table_criterion6 s ��� z Mapper._single_table_criterionc C s | j ot| j d tj�S )z�return True if with_polymorphic[1] is an aliased fromclause, like a subquery. As of #8168, polymorphic adaption with ORMAdapter is used only if this is present. r )r� r� r9 ZAliasedReturnsRowsr� rk rk rl �#_has_aliased_polymorphic_fromclauseE s �z*Mapper._has_aliased_polymorphic_fromclausec C s | j p| jp| jj p| jjS )a; determine if _MapperEntity or _ORMColumnEntity will need to use polymorphic adaption when setting up a SELECT as well as fetching rows for mapped classes and subclasses against this Mapper. moved here from context.py for #8456 to generalize the ruleset for this condition. )r� r� r� r� rk rk rl � _should_select_with_poly_adapterS s +���z'Mapper._should_select_with_poly_adapterc C s | � � | jsg S | j| j� S rh )rm r� r� r� rk rk rl �_with_polymorphic_mappers� s z Mapper._with_polymorphic_mappersc C s | � � dS )z�This hook is invoked by attribute inspection. E.g. when Query calls: coercions.expect(roles.ColumnsClauseRole, ent, keep_inspect=True) This allows the inspection process run a configure mappers hook. N)rm r� rk rk rl � _post_inspect� s zMapper._post_inspectc C s: | j s | jS | j \}}|d k r"|S | �| �||�d�S d S �NF)r� r� r� r� )r� r� r� rk rk rl � _with_polymorphic_selectable� s �z#Mapper._with_polymorphic_selectablec C s dd� | j �� D �S )Nc S s$ i | ] \}}|t d d� |D ���qS )c s s | ]}|j jr|V qd S rh )r� �should_evaluate_noner! rk rk rl r � s zAMapper._insert_cols_evaluating_none.<locals>.<dictcomp>.<genexpr>�rM �r r� r� rk rk rl � <dictcomp>� s � �z7Mapper._insert_cols_evaluating_none.<locals>.<dictcomp>�r� r� r� rk rk rl � _insert_cols_evaluating_none� s �z#Mapper._insert_cols_evaluating_nonec C s dd� | j �� D �S )Nc S s$ i | ] \}}|t d d� |D ���qS )c s s. | ]&}|j s|js|js|jjs|jV qd S rh )r~ r� r� r� r� r� r! rk rk rl r � s �z9Mapper._insert_cols_as_none.<locals>.<dictcomp>.<genexpr>r� r� rk rk rl r� � s � �z/Mapper._insert_cols_as_none.<locals>.<dictcomp>r� r� rk rk rl �_insert_cols_as_none� s �zMapper._insert_cols_as_nonec s � fdd�� j �� D �S )Nc s$ i | ] \}}|� fd d�|D ��qS )c s i | ]}� j | j|�qS rk �r� r� r! r� rk rl r� � s z5Mapper._propkey_to_col.<locals>.<dictcomp>.<dictcomp>rk r� r� rk rl r� � s � z*Mapper._propkey_to_col.<locals>.<dictcomp>r� r� rk r� rl �_propkey_to_col� s �zMapper._propkey_to_colc C s dd� | j �� D �S )Nc S s$ i | ] \}}|t d d� |D ���qS )c S s g | ] }|j �qS rk �r� r! rk rk rl r# � s z7Mapper._pk_keys_by_table.<locals>.<dictcomp>.<listcomp>r� �r r� Zpksrk rk rl r� � s � z,Mapper._pk_keys_by_table.<locals>.<dictcomp>�r� r� r� rk rk rl �_pk_keys_by_table� s �zMapper._pk_keys_by_tablec s � fdd�� j �� D �S )Nc s( i | ] \}}|t � fd d�|D ���qS )c s g | ]}� j | j�qS rk r� r! r� rk rl r# � s z<Mapper._pk_attr_keys_by_table.<locals>.<dictcomp>.<listcomp>r� r� r� rk rl r� � s � z1Mapper._pk_attr_keys_by_table.<locals>.<dictcomp>r� r� rk r� rl �_pk_attr_keys_by_table� s �z Mapper._pk_attr_keys_by_tablez+Mapping[FromClause, FrozenSet[Column[Any]]]c C s dd� | j �� D �S )Nc S s* i | ]"\}}|t d d� td|�D ���qS )c S s, g | ]$}|j d k s$|jd k r|jjr|�qS rh )r� r� �is_clause_elementr! rk rk rl r# � s �z:Mapper._server_default_cols.<locals>.<dictcomp>.<listcomp>�Iterable[Column[Any]]�rM r r� rk rk rl r� � s � ��z/Mapper._server_default_cols.<locals>.<dictcomp>r� r� rk rk rl �_server_default_cols� s �zMapper._server_default_colsc C s dd� | j �� D �S )Nc S s* i | ]"\}}|t d d� td|�D ���qS )c S s, g | ]$}|j d k s$|jd k r|jjr|�qS rh )Zserver_onupdateZonupdater� r! rk rk rl r# � s �zCMapper._server_onupdate_default_cols.<locals>.<dictcomp>.<listcomp>r� r� r� rk rk rl r� � s � ��z8Mapper._server_onupdate_default_cols.<locals>.<dictcomp>r� r� rk rk rl � _server_onupdate_default_cols� s �z$Mapper._server_onupdate_default_colsz#Mapping[FromClause, FrozenSet[str]]c C s dd� | j �� D �S )Nc S s$ i | ] \}}|t d d� |D ���qS )c s s | ]}|j d k r|j V qd S rh r� r! rk rk rl r s z=Mapper._server_default_col_keys.<locals>.<dictcomp>.<genexpr>r� �r r� �colsrk rk rl r� s � z3Mapper._server_default_col_keys.<locals>.<dictcomp>)r� r� r� rk rk rl r� � s �z Mapper._server_default_col_keysc C s dd� | j �� D �S )Nc S s$ i | ] \}}|t d d� |D ���qS )c s s | ]}|j d k r|j V qd S rh r� r! rk rk rl r s zFMapper._server_onupdate_default_col_keys.<locals>.<dictcomp>.<genexpr>r� r� rk rk rl r� s � z<Mapper._server_onupdate_default_col_keys.<locals>.<dictcomp>)r� r� r� rk rk rl �!_server_onupdate_default_col_keys s �z(Mapper._server_onupdate_default_col_keyszSet[str]c st t � }| j� | j�� D ]&\}}|�� fdd�|�� �D �� q| j�� D ]&\}}|�� fdd�|�� �D �� qH|S )Nc 3 s | ]}� | j V qd S rh r� r! �Zcol_to_propertyrk rl r s �z@Mapper._server_default_plus_onupdate_propkeys.<locals>.<genexpr>c 3 s | ]}� | j V qd S rh r� r! r� rk rl r s �)rj r� r� r� r� r- r� )r� �resultr� r� rk r� rl �&_server_default_plus_onupdate_propkeys s � � z-Mapper._server_default_plus_onupdate_propkeysc C sT | | | d�}| j | jk r<| j�| | | d���d| d��|d< | j�|��d| d��S )N)�entity_namespacer� r� �orm�Zcompile_state_pluginZplugin_subjectZ dml_table)r� r} r� �_set_propagate_attrsr� )r� r rk rk rl �__clause_element__ s � ��� �zMapper.__clause_element__c C s$ t �� �| | | dd���d| d��S )NT)r� r� r� �identity_tokenr� r� )r9 �nullr� r� r� rk rk rl �select_identity_token7 s �� ��z Mapper.select_identity_tokenc C s | j S )a4 The :class:`_schema.FromClause` construct this :class:`_orm.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� r� rk rk rl r� H s zMapper.selectablez)Union[Literal[(False, None)], FromClause]z(Tuple[Sequence[Mapper[Any]], FromClause])r� r� r� rg c C s~ |dkrt jtj|dd�}| jrB|s.| jd }|dkrN| jd }n |dkrNd }| �||�}|d k rj||fS || �||�fS d S )Nr� Tr� r Fr )r8 r� r; r� r� r� r� )r� r� r� r� r� rk rk rl �_with_polymorphic_argsT s" � z Mapper._with_polymorphic_argsc C s t | �| j��S rh )r� � _iterate_polymorphic_propertiesr� r� rk rk rl �_polymorphic_propertiesl s ��z Mapper._polymorphic_propertiesc s | j }| j� � fdd�|D �S )Nc s< g | ]4}t |tj�r|jr|jD ]}� r2� j| n|�q qS rk )r� r rQ Z_renders_in_subqueriesr� )r r� r� ��adapterrk rl r# y s �z2Mapper._all_column_expressions.<locals>.<listcomp>)r� �_polymorphic_adapter)r� �poly_propertiesrk r� rl �_all_column_expressionst s �z Mapper._all_column_expressionsrk c C s$ |r| � |�}n| j}dd� |D �S )Nc S s( g | ] }t |tj�r|j|jd f�qS )r )r� r rQ r� r� �r r� rk rk rl r# � s �z-Mapper._columns_plus_keys.<locals>.<listcomp>)r� r� )r� Zpolymorphic_mappersr� rk rk rl �_columns_plus_keys� s ��zMapper._columns_plus_keysz Optional[orm_util.ORMAdapter]c C s* | j r"tjtjj| | j| jdd�S d S d S )NF)r� Z equivalentsZlimit_on_entity)r� �orm_utilrT Z_TraceAdaptRoleZMAPPER_POLYMORPHIC_ADAPTERr� �_equivalent_columnsr� rk rk rl r� � s �zMapper._polymorphic_adapterc c s| |dkr| j }|s&| jD ] }|V qnRt�tdd� | g| D �� �D ]2}t|dd�rp| jdksD|jd | jk rpqD|V qDdS )zUReturn an iterator of MapperProperty objects which will render into a SELECT.Nc S s g | ]}t |j��qS rk )r� r� )r r� rk rk rl r# � s �z:Mapper._iterate_polymorphic_properties.<locals>.<listcomp>rW Fr )r� r� r Z unique_listr rE r� r� )r� r� r� rk rk rl r� � s& ��� ��z&Mapper._iterate_polymorphic_propertiesz,util.ReadOnlyProperties[MapperProperty[Any]]c C s | � � t�| j�S )ai 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:`_orm.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:`_orm.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:`_orm.Mapper.all_orm_descriptors` )rm r �ReadOnlyPropertiesr� r� rk rk rl �attrs� s #z Mapper.attrsz'util.ReadOnlyProperties[InspectionAttr]c C s t �t| j�� ��S )ay 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. The sorting of the attributes is based on the following rules: 1. Iterate through the class and its superclasses in order from subclass to superclass (i.e. iterate through ``cls.__mro__``) 2. For each class, yield the attributes in the order in which they appear in ``__dict__``, with the exception of those in step 3 below. In Python 3.6 and above this ordering will be the same as that of the class' construction, with the exception of attributes that were added after the fact by the application or the mapper. 3. If a certain attribute key is also in the superclass ``__dict__``, then it's included in the iteration for that class, and not the class in which it first appeared. The above process produces an ordering that is deterministic in terms of the order in which attributes were assigned to the class. .. versionchanged:: 1.3.19 ensured deterministic ordering for :meth:`_orm.Mapper.all_orm_descriptors`. 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:`_orm.Mapper.attrs`. .. warning:: The :attr:`_orm.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:`_orm.Mapper.attrs` )r r� r� r� Z_all_sqla_attributesr� rk rk rl �all_orm_descriptors� s B �zMapper.all_orm_descriptorszDict[str, str]c s2 t jj� dd� | jD ��� �fdd�| j�� D �S )z~return a dictionary of {syn_attribute_name: pk_attr_name} for all synonyms that refer to primary key columns c S s h | ] }|j �qS rk r� r� rk rk rl r* - s z&Mapper._pk_synonyms.<locals>.<setcomp>c s0 i | ](\}}t |� j�r|j�kr|j|j�qS rk )r� rM r r� )r r3 rb �rU Zpk_keysrk rl r� / s � z'Mapper._pk_synonyms.<locals>.<dictcomp>)r rP rQ r) r� r� r� rk r� rl � _pk_synonyms$ s �zMapper._pk_synonymsz-util.ReadOnlyProperties[SynonymProperty[Any]]c C s t jj}| �|j�S )z�Return a namespace of all :class:`.Synonym` properties maintained by this :class:`_orm.Mapper`. .. seealso:: :attr:`_orm.Mapper.attrs` - namespace of all :class:`.MapperProperty` objects. )r rP rQ �_filter_propertiesrM )r� rU rk rk rl �synonyms6 s zMapper.synonymsc C s | j S rh r� r� rk rk rl r� G s zMapper.entity_namespacez,util.ReadOnlyProperties[ColumnProperty[Any]]c C s | � tj�S )a Return a namespace of all :class:`.ColumnProperty` properties maintained by this :class:`_orm.Mapper`. .. seealso:: :attr:`_orm.Mapper.attrs` - namespace of all :class:`.MapperProperty` objects. )r� r rQ r� rk rk rl � column_attrsK s zMapper.column_attrsz sqlalchemy.orm.relationshipsz2util.ReadOnlyProperties[RelationshipProperty[Any]]c C s | � tjjj�S )aD A namespace of all :class:`.Relationship` properties maintained by this :class:`_orm.Mapper`. .. warning:: the :attr:`_orm.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:`_orm.Mapper.attrs` - namespace of all :class:`.MapperProperty` objects. )r� r rP Zorm_relationshipsrR r� rk rk rl � relationshipsY s �zMapper.relationshipsz/util.ReadOnlyProperties[CompositeProperty[Any]]c C s | � tjjj�S )z�Return a namespace of all :class:`.Composite` properties maintained by this :class:`_orm.Mapper`. .. seealso:: :attr:`_orm.Mapper.attrs` - namespace of all :class:`.MapperProperty` objects. )r� r rP rQ rL r� rk rk rl � compositesx s �zMapper.compositesz Type[_MP]z util.ReadOnlyProperties[_MP])�type_rg c s, | � � t�t�� fdd�| j�� D ���S )Nc 3 s$ | ] \}}t |� �r||fV qd S rh )r� �r r3 �v�r� rk rl r � s z,Mapper._filter_properties.<locals>.<genexpr>)rm r r� r: r� r� )r� r� rk r� rl r� � s ��zMapper._filter_propertiesc C s4 dd� t | jd�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 )zpk_%dr� )r4 � bindparamr� )r �idxr~ rk rk rl r# � s ��z&Mapper._get_clause.<locals>.<listcomp>r c S s g | ]\}}||k�qS rk rk r� rk rk rl r# � s )� enumerater~ r4 �and_r Z column_dict)r� �paramsrk rk rl � _get_clause� s ��zMapper._get_clauserX c s@ i � � fdd�}| j jD ]"}|jdk rt�|ji d|i� q� 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 sh | j tjkrd| j� kr*� | j �| j� n| jh� | j< | j� krV� | j �| j� n| jh� | j< d S rh )�operatorr: �eq�leftr. �right)�binary�r� rk rl � visit_binary� s z0Mapper._equivalent_columns.<locals>.visit_binaryNr� )r� r� r� r= �traverse)r� r� r� rk r� rl r� � s �zMapper._equivalent_columns)� assigned_name�objrg c C s& t |ttjtjf�rdS || jkS d S r� )r� r' r rO r9 r[ �_dataclass_fields)r� r� r� rk rk rl �_is_userland_descriptor� s ��z Mapper._is_userland_descriptorc C s dd� t �| j�D �S )Nc S s g | ] }|j �qS rk )r )r �frk rk rl r# � s z,Mapper._dataclass_fields.<locals>.<listcomp>)r Zdataclass_fieldsr| r� rk rk rl r� � s zMapper._dataclass_fieldsc C s� |dk rt �|�rdS |rH| jj�|d�dk rn| �|| jj| �rndS n&| j�|d�}|dk rn| �||�rndS | jdk r�|| jkr�|dks�|| jkr�| � d| � dS | j dk r�|| j ks�|dk r�|| j kr�| � 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) r9 Z_never_select_columnr| r r= r� r� rR r� r� r� )r� r r� r� r� �attrrk rk rl r� � sR �� �� ����� ���zMapper._should_exclude)�otherrg c C s | j |j kS )zXReturn true if the given mapper shares a common inherited parent as this mapper.)r� �r� r� rk rk rl � common_parent s zMapper.common_parentc C s$ | j |j ko"| �|� o"|�| � S )z{return true if the other mapper is an inheriting sibling to this one. common parent but different branch )r� r� r� rk rk rl � is_sibling s � �zMapper.is_siblingzInstanceState[Any])rA �allow_subtypesrg c C s4 | � � }| jd k s|r$t|��|�S t|�|kS d S rh )�primary_mapperr� r$ r� )r� rA r� �srk rk rl �_canload s zMapper._canloadc C s | }|r||k r|j }qt|�S )z>Return True if the this mapper inherits from the given mapper.)r rz )r� r� r` rk rk rl r� ) s z Mapper.isarn c c s | }|r|V |j }qd S rh )r )r� r` rk rk rl r� 1 s zMapper.iterate_to_rootc C s< g }t | g�}|r2|�� }|�|� |�|j� qt�|�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 rI r� rJ r� r r� )r� Z descendantsrK rL rk rk rl r� 7 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� r� rk rk rl �polymorphic_iteratorG s zMapper.polymorphic_iteratorc C s | j jS )zSReturn the primary mapper corresponding to this mapper's class key (class).)r� r� r� rk rk rl r� T s zMapper.primary_mapperc C s | j jjS rh )r� r� r� r� rk rk rl �primary_base_mapperZ s zMapper.primary_base_mapperc s@ | j }� r � fdd�|D �}|�� }|D ]}||kr( dS q(dS )Nc s g | ]}� j | �qS rk �r� r% r� rk rl r# a s z3Mapper._result_has_identity_key.<locals>.<listcomp>FT)r~ �keys)r� r� r� r1 Zrkr" rk r� rl �_result_has_identity_key^ s z Mapper._result_has_identity_keyz%Optional[Union[Row[Any], RowMapping]]zOptional[ORMAdapter]z_IdentityKeyType[_O])�rowr� r� rg c sV | j }� r � fdd�|D �}t|d�r.|j�n td|��| 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:`.Row` or :class:`.RowMapping` produced from a result set that selected from the ORM mapped primary key columns. .. versionchanged:: 2.0 :class:`.Row` or :class:`.RowMapping` are accepted for the "row" argument c s g | ]}� j | �qS rk r� r% r� rk rl r# | s z0Mapper.identity_key_from_row.<locals>.<listcomp>�_mappingzMapping[Any, Any]c 3 s | ]}� | V qd S rh rk )r r� )�mappingrk rl r � s z/Mapper.identity_key_from_row.<locals>.<genexpr>)r~ r r r r� r� )r� r r� r� r1 rk )r� r rl �identity_key_from_rowi s �z Mapper.identity_key_from_rowzTuple[Any, ...])r~ r� rg c 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. )r� r� )r� r~ r� rk rk rl � identity_key_from_primary_key� s �z$Mapper.identity_key_from_primary_keyr! )�instancerg c C s t �|�}| �|tj�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_stater% � PASSIVE_OFF)r� r rA rk rk rl �identity_key_from_instance� s z!Mapper.identity_key_from_instancer% )rA �passiverg c s4 �j � �j�| jt� ���fdd�| jD ���jfS )Nc s" g | ]}�|j j��� ���qS rk )r� �implr= r� �rB r r rA rk rl r# � s �z3Mapper._identity_key_from_state.<locals>.<listcomp>)r� r r� r� r) r� )r� rA r rk r rl r � s ���z Mapper._identity_key_from_statec C s t �|�}| �|tj�}|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 )r� r rA Z identity_keyrk rk rl �primary_key_from_instance� s �z Mapper.primary_key_from_instancec s: dd� | j D �� t� ��d g�r.� fdd�}ndd� }|S )Nc S s g | ] }|j j�qS rk )r� Zsort_key_functionr! rk rk rl r# � s z1Mapper._persistent_sortkey_fn.<locals>.<listcomp>c s t dd� t� | jd �D ��S )Nc s s& | ] \}}|d k r||�n|V qd S rh rk )r Zkey_fn�valrk rk rl r � s �z=Mapper._persistent_sortkey_fn.<locals>.key.<locals>.<genexpr>r )r� �zipr� �rA �Zkey_fnsrk rl r� � s �z*Mapper._persistent_sortkey_fn.<locals>.keyc S s | j d S �Nr r� r rk rk rl r� � s )r~ rj � differencer� rk r rl �_persistent_sortkey_fn� s z Mapper._persistent_sortkey_fnc s � fdd�� j D �S )Nc s g | ]}� j | �qS rk r� r! r� rk rl r# � s z.Mapper._identity_key_props.<locals>.<listcomp>r$ r� rk r� rl r) � s zMapper._identity_key_propsc C s& t � }| jD ]}|�| j| � q |S rh )rj r� r� r� )r� Z collectionr� rk rk rl � _all_pk_cols� s zMapper._all_pk_colsc C s$ t | j�}| jd k r |�| j� |S rh )rj r~ r� r. )r� r� rk rk rl �_should_undefer_in_wildcard� s z"Mapper._should_undefer_in_wildcardc s � fdd�� j D �S )Nc s h | ]}� j | j�qS rk r� r! r� rk rl r* � s z/Mapper._primary_key_propkeys.<locals>.<setcomp>)r r� rk r� rl �_primary_key_propkeys� s z Mapper._primary_key_propkeysrG �ColumnElement[Any])rA rB r� r rg c C s$ | j | }|j|j jj|||d�S �N�r )r� r r� r r= �r� rA rB r� r r� rk rk rl �_get_state_attr_by_column� s z Mapper._get_state_attr_by_columnc C s& | j | }|j|j j�|||� d S rh )r� r r� r Zset_committed_value�r� rA rB r� rq r� rk rk rl �#_set_committed_state_attr_by_column� s z*Mapper._set_committed_state_attr_by_columnc C s( | j | }|j|j j�|||d � d S rh )r� r r� r rj r rk rk rl �_set_state_attr_by_column s z Mapper._set_state_attr_by_columnc C s( t �|�}t �|�}| j|||tjd�S r )r r � instance_dict�#_get_committed_state_attr_by_columnr% r )r� r� r� rA rB rk rk rl � _get_committed_attr_by_column s �z$Mapper._get_committed_attr_by_columnc C s$ | j | }|j|j jj|||d�S r )r� r r� r Zget_committed_valuer rk rk rl r# s �z*Mapper._get_committed_state_attr_by_columnc sX �j � t|���jj�� �}tt� fdd�|D �� ���jj�krFdS ���fdd�}g }d}t t �� � ��D ]l}|j�kr�d}nt |jt j�s� dS |rn|jsn|js�t�|jr�t�|jdk s�t�|�|j� ��|j� qnzt�|d i d |i�}W n tk �r Y dS X ||d< tj|� } g } |D ]} | �� | j � �q*tj | � � | �� t �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� r� r+ )r r� r� )�propsrk rl r# ' s �z3Mapper._optimized_get_statement.<locals>.<listcomp>Nc s� | j }| j}|d ks |d kr d S |j�krh� j��j|tjd�}|tjkrPt � �t j d || jj d�| _ nF|j�kr�� j��j|tjd�}|tjkr�t � �t j d || jj d�| _d S )Nr r� ) r� r� r� r# r� r% ZPASSIVE_NO_INITIALIZEr� Z _none_set�_OptGetColumnsNotAvailabler4 r� r� )r� ZleftcolZrightcolZleftvalZrightval)r� rA r� rk rl r� 2 s@ � � � �z5Mapper._optimized_get_statement.<locals>.visit_binaryFTr r� )!r� rj r- r� r� r� r r� r} �reversedr� r� r� r9 r< r� r r� r� r� r� r. r= Zcloned_traverser& r4 r� rJ r� �select�where�set_label_stylerB ) r� rA Zattribute_namesZcol_attribute_namesr� Zallconds�startr� Z _traversedZcondr� r� rk )r% r� rA r� rl �_optimized_get_statement s\ � ��� � ���z Mapper._optimized_get_statementc c sL | � |�rH| }| �� D ]0}|V ||k r6||jkr6 qH|}||kr qHqd S rh )r� r� r� )r� r� �prevr` rk rk rl �_iterate_to_target_viawpoly| s z"Mapper._iterate_to_target_viawpolyc C s i S rh rk r� rk rk rl �&_would_selectinload_combinations_cache� s z-Mapper._would_selectinload_combinations_cachec C sn | j }z || W S tk r$ Y nX | �|�s4t�|}| �|�D ]}|jdkrB||k} qbqBd}|||< |S )a� return True if this mapper would "selectin" polymorphic load based on the given super mapper, and not from a setting from a subclass. given:: class A: ... class B(A): __mapper_args__ = {"polymorphic_load": "selectin"} class C(B): ... class D(B): __mapper_args__ = {"polymorphic_load": "selectin"} ``inspect(C)._would_selectin_load_only_from_given_mapper(inspect(B))`` returns True, because C does selectin loading because of B's setting. OTOH, ``inspect(D) ._would_selectin_load_only_from_given_mapper(inspect(B))`` returns False, because D does selectin loading because of its own setting; when we are doing a selectin poly load from B, we want to filter out D because it would already have its own selectin poly load set up separately. Added as part of #9373. r� F)r/ r r� r� r. r� )r� Z super_mapper�cacher� r` �retvalrk rk rl �+_would_selectin_load_only_from_given_mapper� s z2Mapper._would_selectin_load_only_from_given_mapperc C s� |s,|}| � |�D ]}|jdkr| S qndt|�}dd� |D �}|�|g�D ]@}|j}| � |�D ]*}|jdksx||krb|�||� S qbqNd S )Nr� c S s i | ] }|j |�qS rk �r� )r �erk rk rl r� � s z0Mapper._should_selectin_load.<locals>.<dictcomp>)r. r� rj r r� r= )r� Zenabled_via_opt�polymorphic_fromr� r` Zenabled_via_opt_mappersr� rk rk rl �_should_selectin_load� s ��z Mapper._should_selectin_loadz sqlalchemy.orm.strategy_optionsc s� t jj}| jst�| jdk r:| j| j }t|g| j �}n t| j�}|� � �}|� � �}| h}| j} | dk r�| |k r�| j dkr�|� | � | j} qd| j | j D ]t} | j| jkr�q�| j|ks�| |kr�t| t�s�q�|jt� j| j�ft| j�dd�}q�|jt� j| j�fddidd�}q�dd� | jD �} t| �d k�r<tj| � } n| d } � j �r�� j | k�s\t�t� � �� t �} � j!�"| �} � fd d�| D �} | �#| �$tj%d dd ���j&| � } n0t� | �� t �} | �#| �$tj%d dd ���j&| � } | ||fS )zbAssemble a that can load the columns local to this subclass as a SELECT with IN. Nr� T)Z_reconcile_to_otherZ do_nothingFc S s g | ]}t �|d di��qS )Z _orm_adaptT)r� Z_deep_annotate)r �pkrk rk rl r# s �z0Mapper._subclass_load_via_in.<locals>.<listcomp>r r c s g | ]}� j �|��qS rk )�_adapterr� )r r3 �r� rk rl r# . s Z primary_keys)Z expanding)'r rP Zorm_strategy_optionsr r� r� r� rj r) �Loadr� r. r� r� r� r� rS r� r- Z_set_generic_strategyrE r� r� Z strategy_keyr~ r/ r4 �tuple_Zis_aliased_classr� r( r* rB r8 r� r) r� r� Zorder_by)r� r� r5 Zstrategy_optionsZpolymorphic_propZ keep_propsZ disable_optZ enable_optZclasses_to_includer` r� r~ Zin_expr�qrk r9 rl �_subclass_load_via_in� sz ��� � � � � �� ���z Mapper._subclass_load_via_inc C s | � | | j�S rh )r= r� r� rk rk rl � _subclass_load_via_in_mapper< s z#Mapper._subclass_load_via_in_mapperz.Optional[Callable[[InstanceState[Any]], bool]]zGIterator[Tuple[object, Mapper[Any], InstanceState[Any], _InstanceDict]])r� rA �halt_onrg c c s t � }t� t� }}|j�| �s$t�tt|jj�� �|||jfg�}|�r|d \}} } } |sh|� � qD| |kr�|� � } | j rD|| j kr�qD| dk s�t�| dk s�t�t| � || | ||��} | r�|� | |ddf� qD| |krD|� � \}}}}||||fV |� t|j�� �|||f� qDdS )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. re N)rj �objectr� r� r� r r� rN r� r rI rj �cascade_iteratorr� )r� r� rA r? Zvisited_statesZprpZmppZ visitables�iteratorZ item_typeZ parent_stateZ parent_dictr� �queuer Zinstance_mapperZcorresponding_stateZcorresponding_dictrk rk rl rA A s^ � �� �� ��zMapper.cascade_iteratorc C s t �| j�S rh )r ZLRUCacher� r� rk rk rl �_compiled_cache� s zMapper._compiled_cachec C s t | j�dkS r )r/ r� r� rk rk rl � _multiple_persistence_tables� s z#Mapper._multiple_persistence_tablesc s� i �| j jD ] }|jD ]}��||� qq g }��� D ],\� }|j}|r6|�� fdd�|jD �� q6�fdd�}tj�||d�}t � � }|D ]}�| ||< q�|S )Nc s g | ] }|� f�qS rk rk )r Z super_tabler( rk rl 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 r� ) r= rS r� r� r� rj r� Z _find_columnsr )ZfkrS �depr� )�table_to_mapperrk rl �skip� s$ ���� � z#Mapper._sorted_tables.<locals>.skip)Zskip_fn�extra_dependencies) r� r� r� � setdefaultr� r rJ r� Z sort_tablesr r: )r� r� r rI Zsuper_rH Zsorted_�retrk )r� rG rl �_sorted_tables� s* � �zMapper._sorted_tableszCallable[[], _T]r^ )r� � callable_rg c C s2 || j krtt| j | �S |� | j |< }|S d S rh )r� r r^ )r� r� rM rq rk rk rl �_memo� s z Mapper._memoc C sp t �t�}dd� }| jD ]R}t|j�}| �� D ]:}|jr.|�t |dd� |jD ���r.|| � ||jf� q.q|S )zgmemoized map of tables to collections of columns to be synchronized upwards to the base mapper.c S s | � |�S rh )r )r� �yrk rk rl � set_union� s z+Mapper._table_to_equated.<locals>.set_unionc S s g | ]\}}|j �qS rk r )r rn �rrk rk rl r# � s z,Mapper._table_to_equated.<locals>.<listcomp>) r � defaultdictr� rL rj r� r� r� r- r r� )r� r� rP r� r� r` rk rk rl �_table_to_equated� s � ��zMapper._table_to_equated) NNNFNNNFNNNNNFNFNTTNNNTFTrx Fry )F)NN)F)NFF)rk )N)N)NN)N)N)�r� r� � __qualname__�__doc__�__annotations__r ru r r Zdeprecated_paramsr� r� r� Z is_mapperZrepresents_outer_join�propertyr� r� r� Znon_memoized_property� deprecatedr� Zmemoized_propertyr� r� r� r� r� r� r� r r r� r� r� r� rC Zmemoized_attributerH rD rO �preload_moduler� r< r; r> r[ Z langhelpersZtag_method_for_warningsr� Z SAWarningrm ro rr rp r� rw r� r~ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rD r� Zwith_polymorphic_mappersr� r� r� r� r� r� r� r� r� r� Zmemoized_instancemethodr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r% ZPASSIVE_RETURN_NO_VALUEr r r r) r r r r r r! r$ r# r, r. r/ r2 r6 r= r> rA rD rE rL rN rS rk rk rk rl rs � sJ � �J @' ]t G � +$ �B$� � $ 0 � %E ) . �"#� � �$ � f 7 a� a2 rs r� c @ s e Zd ZdS )r& N)r� r� rT rk rk rk rl r& s r& r� c C s t t� dd� dS )a� Initialize the inter-mapper relationships of all mappers that have been constructed thus far across all :class:`_orm.registry` collections. 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. Mapper configuration is normally invoked automatically, the first time mappings from a particular :class:`_orm.registry` are used, as well as whenever mappings are used and additional not-yet-configured mappers have been constructed. The automatic configuration process however is local only to the :class:`_orm.registry` involving the target mapper and any related :class:`_orm.registry` objects which it may depend on; this is equivalent to invoking the :meth:`_orm.registry.configure` method on a particular :class:`_orm.registry`. By contrast, the :func:`_orm.configure_mappers` function will invoke the configuration process on all :class:`_orm.registry` objects that exist in memory, and may be useful for scenarios where many individual :class:`_orm.registry` objects that are nonetheless interrelated are in use. .. versionchanged:: 1.4 As of SQLAlchemy 1.4.0b2, this function works on a per-:class:`_orm.registry` basis, locating all :class:`_orm.registry` objects present and invoking the :meth:`_orm.registry.configure` method on each. The :meth:`_orm.registry.configure` method may be preferred to limit the configuration of mappers to those local to a particular :class:`_orm.registry` and/or declarative base class. Points at which automatic configuration is invoked include when a mapped class is instantiated into an instance, as well as when ORM queries are emitted using :meth:`.Session.query` or :meth:`_orm.Session.execute` with an ORM-enabled statement. The mapper configure process, whether invoked by :func:`_orm.configure_mappers` or from :meth:`_orm.registry.configure`, provides several event hooks that can be used to augment the mapper configuration step. These hooks include: * :meth:`.MapperEvents.before_configured` - called once before :func:`.configure_mappers` or :meth:`_orm.registry.configure` 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:`_orm.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` or :meth:`_orm.registry.configure` is complete; at this stage, all :class:`_orm.Mapper` objects that fall within the scope of the configuration operation 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, and may also have mappings that are still to be configured, if they are in other :class:`_orm.registry` collections not part of the current scope of configuration. Tri N)rl rm rk rk rk rl �configure_mappers s DrZ zSet[_RegistryType]rz )� registriesrj rg c C s� | D ]}|j r qqd S t�h tr0W 5 Q R � d S dazD| D ]}|j r: q\q:W �,W 5 Q R � d S tj�t��� t| |� W 5 daX W 5 Q R X tj�t��� d S )NTF) rk ri �_already_compilingrs rt Z _for_classZbefore_configured�_do_configure_registriesZafter_configured)r[ rj rp rk rk rl rl P s" rl zsqlalchemy.orm.decl_apic C s" t jjj}t| �}|�| �D � ]�}d}|�� D ]�}d }|jjD ] }|||j �}|t kr>d} q`q>|t krjq.t |dd�r�t � d||jf �} |j| _| �|js.z$|�� |�� |j�||j � W q. tk r� t�� d } t| d�s�| |_� Y q.X q.|�sd|_|s |j�|�r t � d��q d S )NFTru z�One or more mappers failed to initialize - can't proceed with initialization of other mappers. Triggering mapper: '%s'. Original exception was: %sr zHconfigure was called with cascade=False but additional registries remain)r rP � orm_decl_apirJ rj Z_recurse_with_dependenciesro rt Zbefore_mapper_configuredr| r( rE r� r ru r� ro r� Zmapper_configured� Exception�sys�exc_infor rk � _dependenciesr ) r[ rj rJ �origrp Zhas_skipr� Z run_configure�fnr4 r rk rk rl r] r sJ �� �r] c C s� t jjj}t| �}|�| �D ]�}|s:|j�|�r:t� d��|j rtz|j � � \}}W n t k rf Y q:X |� |� q:|j�� |j�� |jD ]}|j�|� q�|j�� d|_q d S )Nz^Registry has dependent registries that are not disposed; pass cascade=True to clear these alsoF)r rP r^ rJ rj Z_recurse_with_dependentsZ _dependentsr r� r Z _managers�popitemr Z_dispose_manager_and_mapperZ_non_primary_mappers�clearrb �discardrk )r[ rj rJ rc rp r �_rF rk rk rl �_dispose_registries� s& � ri c C s d| _ | S )a� Decorate a method as the 'reconstructor' hook. Designates a single 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. .. tip:: The :func:`_orm.reconstructor` decorator makes use of the :meth:`_orm.InstanceEvents.load` event hook, which can be used directly. 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:: :meth:`.InstanceEvents.load` T)r �rd rk rk rl � reconstructor� s rk T��include_removes�include_backrefsr� zCallable[[_Fn], _Fn])�namesrm rn rg c s ddd�� ��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. .. versionchanged:: 2.0.16 This paramter inadvertently defaulted to ``False`` for releases 2.0.0 through 2.0.15. Its correct default of ``True`` is restored in 2.0.16. .. seealso:: :ref:`simple_validators` - usage examples for :func:`.validates` rb )rd rg c s �| _ �� d�| _| S )Nrl )r r rj �rn rm ro rk rl �wrap s �zvalidates.<locals>.wraprk )rm rn ro rq rk rp rl � validates� s (rr c C s | j j}|jr |�| �� � d S rh )r r� r� r� )rA �ctx�instrumenting_mapperrk rk rl r s r c C s( | j j}|r$|�� |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� rm r� )rA rx �kwargsrt rk rk rl r ! s r c @ s$ e Zd ZdZdZdd� Zdd� ZdS )r� z4Error reporting helper for mapper._columntoproperty.r3 c C s || _ d S rh r3 rs rk rk rl r� 6 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...)r� r� r= �orm_excZUnmappedColumnErrorr� r r� )r� r� r� rk rk rl � __missing__: s ����z_ColumnMapping.__missing__N)r� r� rT rU � __slots__r� rw rk rk rk rl r� 1 s r� )r ra )�rU � __future__r � collectionsr � functoolsr � itertoolsr r` � threading�typingr r r r r r r r r r r r r r r r r r r r �weakrefr6 r r rv r r r r r� Z_typingr! r7 r" r# r$ r% r& Z interfacesr' r( r) r* r+ r, r- Z path_registryr. r0 r� r1 r2 r3 r4 r5 r6 r9 r8 r9 r: r; r< r� r= Z sql.cache_keyr> Z sql.elementsr? Z sql.schemar@ rA Zsql.selectablerB rC rD Z util.typingrE rF rG rH rI Zdecl_apirJ � dependencyrK rU rL rM �eventsrN rO rP rQ r� rR rA rS rT ZenginerU rV Z sql._typingrW rX Zsql.baserY rZ r[ r\ r] r^ r` rb Z_WithPolymorphicArg�WeakKeyDictionaryre rV rm rq r\ �symbolrr �RLockri Z_self_inspectsZ class_loggerZ IdentifiedZ Inspectablers r_ r& rZ rl rY r] ri rk rr r r r� rk rk rk rl �<module> s\ ���� � � G"4! �3