관리-도구
편집 파일: mapped_collection.cpython-38.pyc
U -?�f�L � @ s2 d dl mZ d dlZd dlmZ d dlmZ d dlmZ d dlmZ d dlmZ d dlm Z d d lm Z d d lm Z d d lm Z d d lm Z d d lmZ d dlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddl m Z ddl m Z ddl m Z e �r^dd lm!Z! dd lm"Z" dd lm#Z# dd l$m%Z% ed ed!�Z&ed"ed!�Z'G d#d$� d$ee& �Z(G d%d&� d&e(e& �Z)d'd(�d)d*d+d,�d-d.�Z*G d/d0� d0�Z+d'd(�d1d*d2d3�d4d5�Z,d'd(�d6d*d7d8�d9d:�Z-G d;d<� d<ee&e'f �Z.d6d*d+d8�d=d>�Z/e.Z0e-Z1e,Z2e*Z3dS )?� )� annotationsN)�Any)�Callable)�Dict)�Generic)�List)�Optional)�Sequence)�Tuple)�Type)� TYPE_CHECKING)�TypeVar)�Union� )�base)� collection)�collection_adapter� )�exc)�util)� coercions)� expression)�roles)�Missing)� MissingOr)�Literal)�AttributeEventToken)�Mapper)�CollectionAdapter)� ColumnElement�_KT)�bound�_VTc @ sR e Zd ZdZdZddd�dd�Zdd �d d �Zd dd �dd�Zddd�dd�ZdS )�_PlainColumnGetterz�Plain column getter, stores collection of Column objects directly. Serializes to a :class:`._SerializableColumnGetterV2` which has more expensive __call__() performance and some rare caveats. )�cols� composite� Sequence[ColumnElement[_KT]]�None�r$ �returnc C s || _ t|�dk| _d S �Nr )r$ �lenr% )�selfr$ � r- �P/opt/hc_python/lib64/python3.8/site-packages/sqlalchemy/orm/mapped_collection.py�__init__: s z_PlainColumnGetter.__init__�cTuple[Type[_SerializableColumnGetterV2[_KT]], Tuple[Sequence[Tuple[Optional[str], Optional[str]]]]]�r) c C s t �| j�S �N)�_SerializableColumnGetterV2�_reduce_from_colsr$ �r, r- r- r. � __reduce__> s z _PlainColumnGetter.__reduce__� Mapper[_KT]��mapperr) c C s | j S r2 )r$ )r, r9 r- r- r. �_colsF s z_PlainColumnGetter._colsr z&MissingOr[Union[_KT, Tuple[_KT, ...]]])�valuer) c sX t �|��t ���� � �fdd�| �� �D �}| jr<t|�S |d }|d krPtS |S d S )Nc s g | ]}� � ��j|��qS r- )Z_get_state_attr_by_column�dict)�.0�col��m�stater- r. � <listcomp>M s �z/_PlainColumnGetter.__call__.<locals>.<listcomp>r )r �instance_stateZ _state_mapperr: r% �tupler )r, r; �key�objr- r? r. �__call__I s �z_PlainColumnGetter.__call__N) �__name__� __module__� __qualname__�__doc__� __slots__r/ r6 r: rG r- r- r- r. r# . s r# c @ sV e Zd ZdZdZddd�dd�Zdd �d d �Zed dd �dd��Zdd d�dd�Z dS )r3 a< Updated serializable getter which deals with multi-table mapped classes. Two extremely unusual cases are not supported. Mappings which have tables across multiple metadata objects, or which are mapped to non-Table selectables linked across inheriting mappers may fail to function here. )�colkeysz-Sequence[Tuple[Optional[str], Optional[str]]]r' )rM r) c C s || _ t|�dk| _d S r* )rM r+ r% )r, rM r- r- r. r/ i s z$_SerializableColumnGetterV2.__init__r0 r1 c C s | j | jffS r2 )� __class__rM r5 r- r- r. r6 o s z&_SerializableColumnGetterV2.__reduce__r& r( c s, ddd�dd�� � fdd�|D �}t |ffS )NzColumnElement[_KT]z Optional[str])�cr) c S s t | jtj�sd S | jjS d S r2 )� isinstance�tabler Z TableClauserE )rO r- r- r. � _table_key| s zA_SerializableColumnGetterV2._reduce_from_cols.<locals>._table_keyc s g | ]}|j � |�f�qS r- )rE )r= rO �rR r- r. rB � s zA_SerializableColumnGetterV2._reduce_from_cols.<locals>.<listcomp>)r3 )�clsr$ rM r- rS r. r4 w s z-_SerializableColumnGetterV2._reduce_from_colsr7 r8 c C sh g }t |jdd �}| jD ]J\}}|d ks8|d ks8||krL|�|jj| � q|�|j| j| � q|S )N�metadata)�getattrZ local_tablerM �appendrO Ztables)r, r9 r$ rU ZckeyZtkeyr- r- r. r: � s z!_SerializableColumnGetterV2._colsN) rH rI rJ rK rL r/ r6 � classmethodr4 r: r- r- r- r. r3 [ s r3 F�� ignore_unpopulated_attributez&Union[Type[_KT], Callable[[_KT], _VT]]�boolzType[KeyFuncDict[_KT, _KT]])� mapping_specrZ r) c C s( dd� t �| �D �}t|�}t||d�S )a� A dictionary-based collection type with column-based keying. .. versionchanged:: 2.0 Renamed :data:`.column_mapped_collection` to :class:`.column_keyed_dict`. Returns a :class:`.KeyFuncDict` factory which will produce new dictionary keys based on the value of a particular :class:`.Column`-mapped attribute on ORM mapped instances to be added to the dictionary. .. note:: the value of the target attribute must be assigned with its value at the time that the object is being added to the dictionary collection. Additionally, changes to the key attribute are **not tracked**, which means the key in the dictionary is not automatically synchronized with the key value on the target object itself. See :ref:`key_collections_mutations` for further details. .. seealso:: :ref:`orm_dictionary_collection` - background on use :param mapping_spec: a :class:`_schema.Column` object that is expected to be mapped by the target mapper to a particular attribute on the mapped class, the value of which on a particular instance is to be used as the key for a new dictionary entry for that instance. :param ignore_unpopulated_attribute: if True, and the mapped attribute indicated by the given :class:`_schema.Column` target attribute on an object is not populated at all, the operation will be silently skipped. By default, an error is raised. .. versionadded:: 2.0 an error is raised by default if the attribute being used for the dictionary key is determined that it was never populated with any value. The :paramref:`_orm.column_keyed_dict.ignore_unpopulated_attribute` parameter may be set which will instead indicate that this condition should be ignored, and the append operation silently skipped. This is in contrast to the behavior of the 1.x series which would erroneously populate the value in the dictionary with an arbitrary key value of ``None``. c S s g | ]}t jtj|d d��qS )r\ )�argname)r �expectr ZColumnArgumentRole)r= �qr- r- r. rB � s �z%column_keyed_dict.<locals>.<listcomp>rY )r Zto_listr# �_mapped_collection_cls)r\ rZ r$ �keyfuncr- r- r. �column_keyed_dict� s .��rb c @ s< e Zd ZdZdd�dd�Zddd�dd �Zd d �d d �ZdS )� _AttrGetter)� attr_name�getter�str)rd c C s || _ t�|�| _d S r2 )rd �operator� attrgetterre )r, rd r- r- r. r/ � s z_AttrGetter.__init__r )� mapped_objectr) c C sZ | � |�}|d krVt�|�}|j}| j|jkrR|j}|�| jtj�}|d krVt S nt S |S r2 ) re r rC r9 rd �attrsr< �get�NO_VALUEr )r, ri rF rA �mpZdict_r- r- r. rG � s z_AttrGetter.__call__z$Tuple[Type[_AttrGetter], Tuple[str]]r1 c C s t | jffS r2 )rc rd r5 r- r- r. r6 � s z_AttrGetter.__reduce__N)rH rI rJ rL r/ rG r6 r- r- r- r. rc � s rc rf zType[KeyFuncDict[Any, Any]])rd rZ r) c C s t t| �|d�S )ad A dictionary-based collection type with attribute-based keying. .. versionchanged:: 2.0 Renamed :data:`.attribute_mapped_collection` to :func:`.attribute_keyed_dict`. Returns a :class:`.KeyFuncDict` factory which will produce new dictionary keys based on the value of a particular named attribute on ORM mapped instances to be added to the dictionary. .. note:: the value of the target attribute must be assigned with its value at the time that the object is being added to the dictionary collection. Additionally, changes to the key attribute are **not tracked**, which means the key in the dictionary is not automatically synchronized with the key value on the target object itself. See :ref:`key_collections_mutations` for further details. .. seealso:: :ref:`orm_dictionary_collection` - background on use :param attr_name: string name of an ORM-mapped attribute on the mapped class, the value of which on a particular instance is to be used as the key for a new dictionary entry for that instance. :param ignore_unpopulated_attribute: if True, and the target attribute on an object is not populated at all, the operation will be silently skipped. By default, an error is raised. .. versionadded:: 2.0 an error is raised by default if the attribute being used for the dictionary key is determined that it was never populated with any value. The :paramref:`_orm.attribute_keyed_dict.ignore_unpopulated_attribute` parameter may be set which will instead indicate that this condition should be ignored, and the append operation silently skipped. This is in contrast to the behavior of the 1.x series which would erroneously populate the value in the dictionary with an arbitrary key value of ``None``. rY )r` rc )rd rZ r- r- r. �attribute_keyed_dict� s +�rn �Callable[[Any], Any]zType[KeyFuncDict[_KT, Any]])ra rZ r) c C s t | |d�S )a� A dictionary-based collection type with arbitrary keying. .. versionchanged:: 2.0 Renamed :data:`.mapped_collection` to :func:`.keyfunc_mapping`. Returns a :class:`.KeyFuncDict` factory with a keying function generated from keyfunc, a callable that takes an entity and returns a key value. .. note:: the given keyfunc is called only once at the time that the target object is being added to the collection. Changes to the effective value returned by the function are not tracked. .. seealso:: :ref:`orm_dictionary_collection` - background on use :param keyfunc: a callable that will be passed the ORM-mapped instance which should then generate a new key to use in the dictionary. If the value returned is :attr:`.LoaderCallableStatus.NO_VALUE`, an error is raised. :param ignore_unpopulated_attribute: if True, and the callable returns :attr:`.LoaderCallableStatus.NO_VALUE` for a particular instance, the operation will be silently skipped. By default, an error is raised. .. versionadded:: 2.0 an error is raised by default if the callable being used for the dictionary key returns :attr:`.LoaderCallableStatus.NO_VALUE`, which in an ORM attribute context indicates an attribute that was never populated with any value. The :paramref:`_orm.mapped_collection.ignore_unpopulated_attribute` parameter may be set which will instead indicate that this condition should be ignored, and the append operation silently skipped. This is in contrast to the behavior of the 1.x series which would erroneously populate the value in the dictionary with an arbitrary key value of ``None``. rY )r` )ra rZ r- r- r. �keyfunc_mapping s , �rp c s� e Zd ZdZdd�ddddd�� fd d �Zed!dd d dd�dd��Zdd�dd�Ze� d�d"ddddd�dd��Z e j e j d#dddd �d d ���Ze je j d$dddd �d d ���Z� ZS )%� KeyFuncDicta� Base for ORM mapped dictionary classes. Extends the ``dict`` type with additional methods needed by SQLAlchemy ORM collection classes. Use of :class:`_orm.KeyFuncDict` is most directly by using the :func:`.attribute_keyed_dict` or :func:`.column_keyed_dict` class factories. :class:`_orm.KeyFuncDict` may also serve as the base for user-defined custom dictionary classes. .. versionchanged:: 2.0 Renamed :class:`.MappedCollection` to :class:`.KeyFuncDict`. .. seealso:: :func:`_orm.attribute_keyed_dict` :func:`_orm.column_keyed_dict` :ref:`orm_dictionary_collection` :ref:`orm_custom_collection` FrY ro r r[ r' )ra � dict_argsrZ r) c s || _ || _t� j|� dS )ah Create a new collection with keying provided by keyfunc. keyfunc may be any callable that takes an object and returns an object for use as a dictionary key. The keyfunc will be called every time the ORM needs to add a member by value-only (such as when loading instances from the database) or remove a member. The usual cautions about dictionary keying apply- ``keyfunc(object)`` should return the same output for the life of the collection. Keying based on mutable properties can result in unreachable instances "lost" in the collection. N)ra rZ �superr/ )r, ra rZ rr �rN r- r. r/ _ s zKeyFuncDict.__init__NzDict[_KT, _KT]zOptional[CollectionAdapter]z'KeyFuncDict[_KT, _KT]')ra �values�adapterr) c C s t |�}|�|� |S r2 )rq �update)rT ra ru rv rm r- r- r. � _unreducev s zKeyFuncDict._unreducezxTuple[Callable[[_KT, _KT], KeyFuncDict[_KT, _KT]], Tuple[Any, Union[Dict[_KT, _KT], Dict[_KT, _KT]], CollectionAdapter]]r1 c C s t j| jt| �t| �ffS r2 )rq rx ra r< r r5 r- r- r. r6 � s ��zKeyFuncDict.__reduce__zsqlalchemy.orm.attributesr z2Union[AttributeEventToken, Literal[(None, False)]])r; � initiator� warn_onlyr) c C s� t �|�j}tjj}t||j�s&d}n"|j|j krB|j |j � }n|j}|r`t� d|� d�� n0t � d|� dt � |�� dt � |�� d|� d� ��d S ) Nzunknown relationshipz0Attribute keyed dictionary value for attribute 'z�' was None; this will raise in a future release. To skip this assignment entirely, Set the "ignore_unpopulated_attribute=True" parameter on the mapped collection factory.z1In event triggered from population of attribute 'za' (potentially from a backref), can't populate value in KeyFuncDict; dictionary key derived from z= is not populated. Ensure appropriate state is set up on the z object before assigning to the z� attribute. To skip this assignment entirely, Set the "ignore_unpopulated_attribute=True" parameter on the mapped collection factory.)r rC r9 r Z preloadedZorm_attributesrP r rE rj �warn�sa_exc�InvalidRequestErrorZ instance_str)r, r; ry rz r9 � attributesZ relationshipr- r- r. �_raise_for_unpopulated� s � (�z"KeyFuncDict._raise_for_unpopulated)r; � _sa_initiatorr) c C sl | � |�}|tjkr2| js,| j||dd� qZdS n(|tkrZ| jsV| j||dd� d}ndS | �|||� dS )z9Add an item by value, consulting the keyfunc for the key.F�rz NT)ra r rl rZ r r � __setitem__�r, r; r� rE r- r- r. �set� s& � �zKeyFuncDict.setc C s� | � |�}|tjkr.| js*| j||dd� dS |tkrV| jsR| j||dd� d}ndS | | |krzt�d|| | |f ��| �||� dS )z<Remove an item by value, consulting the keyfunc for the key.Fr� NTz�Can not remove '%s': collection holds '%s' for key '%s'. Possible cause: is the KeyFuncDict key function based on mutable properties or properties that only obtain values after flush?) ra r rl rZ r r r| r} � __delitem__r� r- r- r. �remove� s2 � � ��zKeyFuncDict.remove)N)N)N)N)rH rI rJ rK r/ rX rx r6 r Zpreload_moduler r ZappenderZinternally_instrumentedr� Zremoverr� � __classcell__r- r- rt r. rq E s$ � � �+ � �rq c s" G � �fdd�dt ttf �}|S )Nc s( e Zd Zddd�� ��fdd� Z� ZS )z/_mapped_collection_cls.<locals>._MKeyfuncMappedr r' )rr r) c s t � j�f|�d�i� d S )NrZ )rs r/ )r, rr )rN rZ ra r- r. r/ s ���z8_mapped_collection_cls.<locals>._MKeyfuncMapped.__init__)rH rI rJ r/ r� r- �rZ ra rt r. �_MKeyfuncMapped s r� )rq r )ra rZ r� r- r� r. r` s r` )4� __future__r rg �typingr r r r r r r r r r r r � r � collectionsr r r r| r �sqlr r r Zutil.langhelpersr r Z util.typingr r r r Z sql.elementsr r r" r# r3 rb rc rn rp rq r` ZMappedCollectionZmapped_collectionZattribute_mapped_collectionZcolumn_mapped_collectionr- r- r- r. �<module> s` -8�9�4�1 =