U
|
¸ý°dsM ã @ s 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 ddlm Z e r.ddlm Z ddlm Z ddl m Z ed ed Z!ed ed Z"ed eegef d Z#G d d! d!ee! Z$G d"d# d#e$e! Z%d$d%d&d'd(d)d*d+Z&e' Z(G d,d- d-Z)d$d%d.d'd(d/d0d1Z*d$d%d d'd2d3d4d5Z+G d6d7 d7ee!e"f Z,d d'd(d3d8d9Z-e,Z.e+Z/e*Z0e&Z1dS ):é )Ú annotationsN)ÚAny)ÚCallable)ÚDict)ÚGeneric)ÚList)ÚOptional)ÚSequence)ÚTuple)ÚType)Ú TYPE_CHECKING)ÚTypeVar)ÚUnioné )Úbase)Ú
|
collectioné )Úexc)Úutil)Ú coercions)Ú
|
expression)Úroles)ÚLiteral)ÚAttributeEventToken)ÚMapper)Ú ColumnElementÚ_KT)ÚboundÚ_VTÚ_Fc @ sR e Zd ZdZdZdddddZdd d
|
d Zd dd ddZdddddZdS )Ú_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* úWd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\sqlalchemy/orm/mapped_collection.pyÚ__init__9 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 r/ )r! )r) r6 r* r* r+ Ú_colsE s z_PlainColumnGetter._colsr zUnion[_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>L s ÿz/_PlainColumnGetter.__call__.<locals>.<listcomp>r )r Úinstance_stateZ _state_mapperr7 r" ÚtupleÚ_UNMAPPED_AMBIGUOUS_NONE)r) r8 ÚkeyÚobjr* r< r+ Ú__call__H s
|
|
þz_PlainColumnGetter.__call__N) Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__Ú __slots__r, r3 r7 rE r* r* r* r+ r - s r c @ sV e Zd ZdZdZdddddZdd d
|
d Zed dd ddZdd dddZ dS )r0 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$ )rK r& c C s || _ t|dk| _d S r' )rK r( r" )r) rK r* r* r+ r, h s z$_SerializableColumnGetterV2.__init__r- r. c C s | j | jffS r/ )Ú __class__rK r2 r* r* r+ r3 n s z&_SerializableColumnGetterV2.__reduce__r# r% c s, ddddd fdd|D }t |ffS )NzColumnElement[_KT]z Optional[str])Úcr& c S s t | jtjsd S | jjS d S r/ )Ú
|
isinstanceÚtabler Z TableClauserC )rM r* r* r+ Ú
|
_table_key} s zA_SerializableColumnGetterV2._reduce_from_cols.<locals>._table_keyc s g | ]}|j |fqS r* )rC )r: rM ©rP r* r+ r? s zA_SerializableColumnGetterV2._reduce_from_cols.<locals>.<listcomp>)r0 )Úclsr! rK r* rQ r+ r1 v s z-_SerializableColumnGetterV2._reduce_from_colsr4 r5 c C sh g }t |jdd }| jD ]J\}}|d ks8|d ks8||krL| |jj| ¡ q| |j| j| ¡ q|S )NÚmetadata)ÚgetattrZ local_tablerK ÚappendrM Ztables)r) r6 r! rS ZckeyZtkeyr* r* r+ r7 s z!_SerializableColumnGetterV2._colsN)
|
rF rG rH rI rJ r, r3 Ú classmethodr1 r7 r* r* r* r+ r0 Z s r0 F©Ú ignore_unpopulated_attributez&Union[Type[_KT], Callable[[_KT], _VT]]ÚboolzType[KeyFuncDict[_KT, _KT]])Ú mapping_specrX r& c C s( dd t | ¡D }t|}t||dS )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 dqS )rZ )Úargname)r Úexpectr ZColumnArgumentRole)r: Úqr* r* r+ r? ¿ s ÿz%column_keyed_dict.<locals>.<listcomp>rW )r Zto_listr Ú_mapped_collection_cls)rZ rX r! Úkeyfuncr* r* r+ Úcolumn_keyed_dict s .þþr` c @ s< e Zd ZdZddddZddddd Zd
|
d d d ZdS )Ú _AttrGetter)Ú attr_nameÚgetterÚstr)rb c C s || _ t |¡| _d S r/ )rb ÚoperatorÚ
|
attrgetterrc )r) rb 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 r/ )
|
rc r r@ r6 rb Úattrsr9 ÚgetÚNO_VALUErB )r) rg rD r> ÚmpZdict_r* r* r+ rE Ô s
|
|
z_AttrGetter.__call__z$Tuple[Type[_AttrGetter], Tuple[str]]r. c C s t | jffS r/ )ra rb r2 r* r* r+ r3 ã s z_AttrGetter.__reduce__N)rF rG rH rJ r, rE r3 r* r* r* r+ ra Í s ra rd )rb rX r& c C s t t| |dS )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``.
|
|
|
rW )r^ ra )rb rX r* r* r+ Úattribute_keyed_dictç s +þrl zType[KeyFuncDict[_KT, Any]])r_ rX r& c C s t | |dS )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``.
|
|
|
rW )r^ )r_ rX r* r* r+ Úkeyfunc_mapping s , ÿrm c s¶ e Zd ZdZddddddd fd d
|
Zedd d d ddZddddZe d¡d dddddddZ
|
e j e j d!ddddd d Ze je j d"ddddd 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`
|
|
|
FrW r r rY r$ )r_ Ú dict_argsrX 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)r_ rX Úsuperr, )r) r_ rX ro ©rL r* r+ r, c s zKeyFuncDict.__init__zDict[_KT, _KT]z'KeyFuncDict[_KT, _KT]')r_ Úvaluesr& c C s t |}| |¡ |S r/ )rn Úupdate)rR r_ rr rk r* r* r+ Ú _unreducez s
|
zKeyFuncDict._unreducezeTuple[Callable[[_KT, _KT], KeyFuncDict[_KT, _KT]], Tuple[Any, Union[Dict[_KT, _KT], Dict[_KT, _KT]]]]r. c C s t j| jt| ffS r/ )rn rt r_ r9 r2 r* r* r+ r3 s zKeyFuncDict.__reduce__zsqlalchemy.orm.attributesNr z2Union[AttributeEventToken, Literal[(None, False)]])r8 Ú initiatorÚ warn_onlyr& c C s t |¡j}tjj}t||js&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 r@ r6 r Z preloadedZorm_attributesrN r rC rh ÚwarnÚsa_excÚInvalidRequestErrorZ instance_str)r) r8 ru rv r6 Ú
|
attributesZ relationshipr* r* r+ Ú_raise_for_unpopulated s
|
ÿ (ÿz"KeyFuncDict._raise_for_unpopulated)r8 Ú _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©rv NT)r_ r rj rX r{ rB Ú __setitem__©r) r8 r| rC 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?) r_ r rj rX r{ rB rx ry Ú __delitem__r r* r* r+ ÚremoveÓ s2
|
|
ÿ ÿ ýÿzKeyFuncDict.remove)N)N)N)rF rG rH rI r, rV rt r3 r Zpreload_moduler{ r ZappenderZinternally_instrumentedr Zremoverr Ú __classcell__r* r* rq r+ rn I s" ü ý+ ý ýrn c s" G fdddt ttf }|S )Nc s( e Zd Zddd fdd Z ZS )z/_mapped_collection_cls.<locals>._MKeyfuncMappedr r$ )ro r& c s t jf|di d S )NrX )rp r, )r) ro )rL rX r_ r* r+ r, ý s ÿþýz8_mapped_collection_cls.<locals>._MKeyfuncMapped.__init__)rF rG rH r, r r* ©rX r_ rq r+ Ú_MKeyfuncMappedü s r
)rn r )r_ rX r
r* r r+ r^ ù s r^ )2Ú
|
__future__r re Útypingr r r r r r r r
|
r r r r Ú r Ú collectionsr r rx r Zsqlr r r Z util.typingr r r Z sql.elementsr r r r r r0 r` ÚobjectrB ra rl rm rn r^ ZMappedCollectionZmapped_collectionZattribute_mapped_collectionZcolumn_mapped_collectionr* r* r* r+ Ú<module> s\ -:ý9ÿ4ý1 1
|
