codekingpro/portable-devtools
115k
1�
2 ��ji� � �t � S r SSKJr SSKJr SSKJr SSKrSSKrSSK r SSK J3r4 SSK J r SSK J r SS K J
r
SS5K Jr SS K Jr SS K Jr SS
K Jr SSK Jr SSK Jr SSK Jr SSK Jr SSK Jr SSK Jr SSK Jr SSK Jr SSKJr SSKJ r SSK J r SSK J r SSK J!r! SS K J"r" SS K J#r# \( a S S K$J%r% S S K&J'r' \ R. ( d \ ( d
S S!K(J)r) S S"K(J*r+ O SS!K,J)r) SS"K,J*r+ / S#Qr- " S$ S%\"5 r. " S& S'5 r/ " S( S)\5 r0\\\1\04 r2 " S* S+5 r3 " S, S-\"5 r4 " S. S/5 r5\0r6SPS0 jr7\5Rp r8\7" 5 " S1 S2\3\/5 r9\" S3\9S49r:\" S5S6S49r;\ \:/S4 r< " S7 S8\"5 r= " S9 S:\"\: 5 r>\" S;S<S49r? " S= S<\ R� 5 rA " S> S?\A5 rB " S@ SA\B5 rC\/rD\ArE\BrF\CrG\ R� 4 SQSB jjrI\ SRSC j5 rJ\ SSSD j5 rJ STSE jrJ\ SUSF j5 rK\ SVSG j5 rK SWSH jrK\ SUSI j5 rL\ SXSJ j5 rL SWSK jrL\ SYSL j5 rM\ SZSM j5 rM\ S[SN j5 rM S\SO jrMg)]z2Visitor/traversal interface and library functions.� )� annotations)�deque)�EnumN)�Any)�Callable)�cast)�ClassVar)�Dict)�Iterable)�Iterator)�List)�Mapping)�Optional)�overload)�Tuple)�Type)�
TYPE_CHECKING)�TypeVar)�Union� )�exc)�util)� langhelpers)�HAS_CYEXTENSION)�Literal)�Protocol)�Self� )�_AnnotationDict)�
ColumnElement)�prefix_anon_map)�cache_anon_map) �iterate�traverse_using�traverse�cloned_traverse�replacement_traverse� Visitable�ExternalTraversal�InternalTraversal�anon_mapc � � \ rS rSrSS jrSrg)�_CompilerDispatchType�G c � � g �N� )�_self�self�visitor�kws �]D:\code\apps\devtools\python\user_packages\Python313\site-packages\sqlalchemy/sql/visitors.py�__call__� _CompilerDispatchType.__call__H s � �#� r1 N)r3 r( r4 r r5 r �returnr ��__name__�6__module__� __qualname__�__firstlineno__r7 �__static_attributes__r1 r9 r6 r- r- G s � �Mr9 r- c � ^ � \ rS rSr% SrSrS\S' S\S' \R ( a S S jr S
U 4S jjr7\ S
S8 j5 r SS jr
SrU =r$ )r( �K a Base class for visitable objects.9 10:class:`.Visitable` is used to implement the SQL compiler dispatch11functions. Other forms of traversal such as for cache key generation12are implemented separately using the :class:`.HasTraverseInternals`13interface.14 15.. versionchanged:: 2.0 The :class:`.Visitable` class was named16 :class:`.Traversible` in the 1.4 series; the name is changed back17 to :class:`.Visitable` in 2.0 which is what it was prior to 1.4.18 19 Both names remain importable in both 1.4 and 2.0 versions.20 21r1 �str�__visit_name__r- �_original_compiler_dispatchc � � g r0 r1 )r3 r4 r5 s r6 �_compiler_dispatch� Visitable._compiler_dispatchc s � �cr9 c �b >� SU R ; a U R 5 [ TU ]
5 g )NrD )�__dict__�_generate_compiler_dispatch�super�__init_subclass__)�cls� __class__s �r6 rM �Visitable.__init_subclass__e s& �� � �s�|�|� +� � +� +� -�
��!�#r9 c �F ^� U R nSU R ; a U R U l g [ U[22 5 ( d$ [ R " SU R S35 eSU- n[ R " U5 m SU4S jjnU=U l U l g )NrG z__visit_name__ on class z$ must be a string at the class level�visit_%sc �| >� T" U5 nU" U 40 UD6$ ! [ a nUR " X40 UD6s SnA$ SnAff = f)zgLook for an attribute named "visit_<visit_name>" on the23visitor, and call it with the same kw params.24 25N)�AttributeError� visit_unsupported_compilation)r3 r4 r5 �meth�err�getters �r6 rG �AVisitable._generate_compiler_dispatch.<locals>._compiler_dispatch~ sM �� �
(� �g��� �D�'�B�'�'�� "�
N� �<�<�T�M�"�M�M��
N�s � �26;�6�;�;)r3 r( r4 r r5 r r: rC ) rD rJ rG rE �27isinstancerC r �InvalidRequestErrorr< �operator�28attrgetter)rN �29visit_name�namerG rX s @r6 rK �%Visitable._generate_compiler_dispatchj s� �� ��'�'�30� �3�<�<� /� /2�.D�.D�C� +� ��*�c�*�*��)�)�*�3�<�<�.� 9%� %��
�31 �J�&���$�$�T�*�� (�� (�&)� (�14� (�
� (�
� �� � � +r9 c � � U $ r0 r1 )rN �keys r6 �__class_getitem__�Visitable.__class_getitem__� s � ��32r9 )r4 r r5 r r: rC �r: �None)rb r r: r )r< r= r> r? �__doc__� __slots__�__annotations__�typingr rG rM � classmethodrK rc r@ �
__classcell__)rO s @r6 r( r( K sK �� �
� �I���!6�6�
���I�$�33 �# � �# �J� r9 r( c �� � \ rS rSrSrSr Sr Sr Sr Sr Sr34 S r S35r S r
S r S
r Sr Sr Sr Sr Sr Sr Sr Sr Sr Sr Sr Sr Sr Sr S r S r S r S r! S r" S!r# S"r$ S#r% S$r& S%r' S&r( S'r) S(r* S)r+S*r,g+),r* � a� Defines visitor symbols used for internal traversal.36 37The :class:`.InternalTraversal` class is used in two ways. One is that38it can serve as the superclass for an object that implements the39various visit methods of the class. The other is that the symbols40themselves of :class:`.InternalTraversal` are used within41the ``_traverse_internals`` collection. Such as, the :class:`.Case`42object defines ``_traverse_internals`` as ::43 44 class Case(ColumnElement[_T]):45 _traverse_internals = [46 ("value", InternalTraversal.dp_clauseelement),47 ("whens", InternalTraversal.dp_clauseelement_tuples),48 ("else_", InternalTraversal.dp_clauseelement),49 ]50 51Above, the :class:`.Case` class indicates its internal state as the52attributes named ``value``, ``whens``, and ``else_``. They each53link to an :class:`.InternalTraversal` method which indicates the type54of datastructure to which each attribute refers.55 56Using the ``_traverse_internals`` structure, objects of type57:class:`.InternalTraversible` will have the following methods automatically58implemented:59 60* :meth:`.HasTraverseInternals.get_children`61 62* :meth:`.HasTraverseInternals._copy_internals`63 64* :meth:`.HasCacheKey._gen_cache_key`65 66Subclasses can also implement these methods directly, particularly for the67:meth:`.HasTraverseInternals._copy_internals` method, when special steps68are needed.69 70.. versionadded:: 1.471 72�HC�HL�CE�FC�CTS�CL�CT�EO�WC�CO�S�SL�AN�B�O�T�PD�DO�CD�MD�AK�PO�DD�PS�TH�SJ�ME�SH�UK�DML_OV�DML_V�DML_MV�PA�IG�IS�M�MT�HT�ILr1 N)-r< r= r> r? rg �dp_has_cache_key�dp_has_cache_key_list�dp_clauseelement�)dp_fromclause_canonical_column_collection�dp_clauseelement_tuples�dp_clauseelement_list�dp_clauseelement_tuple�dp_executable_options�dp_with_context_options�dp_fromclause_ordered_set� dp_string�dp_string_list� dp_anon_name�73dp_boolean� dp_operator�dp_type�
dp_plain_dict�dp_dialect_options� dp_string_clauseelement_dict�dp_string_multi_dict�dp_annotations_key� dp_plain_obj�dp_named_ddl_element�dp_prefix_sequence�dp_table_hint_list�dp_setup_join_tuple�dp_memoized_select_entities�dp_statement_hint_list�dp_unknown_structure�dp_dml_ordered_values�
dp_dml_values�dp_dml_multi_values�dp_propagate_attrs� dp_ignore�dp_inspectable�dp_multi�
dp_multi_list�dp_has_cache_key_tuples�dp_inspectable_listr@ r1 r9 r6 r* r* � s� � �%�N ��/� ��8���<�04�-� � $���74 !��� "��� !�� "�� $� �K��I�� �N�"��L�� �J�� �K�� �G�� �M�� ��,�#'� ��75 ���76 ��� �L�� ��� ���77 ���78 ��"&� � !��� ��� %��+� �M��79 #���80 ��)�� �I�� �N�%� �H� � �M�'� #���81 �� r9 r* c �| � \ rS rSr% SrSrS\S' SrS\S' \R " S 5 SS82. S
S jj5 r83Sr g )�HasTraverseInternalsi� a� base for classes that have a "traverse internals" element,84which defines all kinds of ways of traversing the elements of an object.85 86Compared to :class:`.Visitable`, which relies upon an external visitor to87define how the object is traversed (i.e. the :class:`.SQLCompiler`), the88:class:`.HasTraverseInternals` interface allows classes to define their own89traversal, that is, what attributes are accessed and in what order.90 91r1 �_TraverseInternalsType�_traverse_internalsF�bool�
_is_immutablezsqlalchemy.sql.traversals��92omit_attrsc � ^^� [ R R n U R nUR93 R n[ R R UU4S jU" XS5 5 5 $ ! [ a / s $ f = f)a� Return immediate child :class:`.visitors.HasTraverseInternals`94elements of this :class:`.visitors.HasTraverseInternals`.95 96This is used for visit traversal.97 98\**kw may contain flags that change the collection that is99returned, for example to return a subset of items in order to100cut down on larger traversals, or to return child items from a101different context (such as schema-level collections instead of102clause-level).103 104c 3 �V ># � U H u pnUT; d M Uc M U" U40 TD6v � M g 7fr0 r1 )�.0�attrname�objrV r5 r� s ��r6 � <genexpr>�4HasTraverseInternals.get_children.<locals>.<genexpr>� s? �� � � -105�(�#��t� �z�)�
� /2�
�D��O��O�(�s �
)�)�)�!_generated_get_children_traversal)106r � preloaded�sql_traversalsr� rT �
_get_children�run_generated_dispatch� itertools�chain�
from_iterable)r3 r� r5 �107traversals�traverse_internals�dispatchs `` r6 � get_children�!HasTraverseInternals.get_children� s} �� �" �^�^�2�2�108� �!%�!9�!9� �109 �+�+�B�B�����,�,� -110�'/��*M�(�-111� 112� 113�� � ��I� �s � A1 �1 B �?B N)r� �Tuple[str, ...]r5 r r: z Iterable[HasTraverseInternals]) r< r= r> r? rg rh ri r� r �preload_moduler� r@ r1 r9 r6 r� r� � sW � �� �I�/�/� �M�4� � ���4�5�/1� 114� ,� 115�9<� 116� '� 117� 6� 118r9 r� c � � \ rS rSrSS jrSrg)� _InternalTraversalDispatchTypei� c � � g r0 r1 )�sr3 r4 s r6 r7 �'_InternalTraversalDispatchType.__call__� s � �r9 r1 N)r3 �objectr4 �HasTraversalDispatchr: r r; r1 r9 r6 r� r� � s � �Lr9 r� c � � \ rS rSr% SrSr0 rS\S' S S jr S S jr S
S jr119 SS jr Sr g120)r� i� z[Define infrastructure for classes that perform internal traversals121 122.. versionadded:: 2.0123 124r1 z2ClassVar[Dict[Union[InternalTraversal, str], str]]�_dispatch_lookupc �, � [ U n[ XS5 $ )zdGiven a method from :class:`.HasTraversalDispatch`, return the125corresponding method on a subclass.126 127N)r� �getattr)r3 � visit_symbolr_ s r6 r� � HasTraversalDispatch.dispatch� s � �128 � �-���t�4�(�(r9 c � � UR R U nU" X5 $ ! [ a U R UR X#5 n N0f = fr0 )rO rJ �KeyError�generate_dispatch)r3 �target�internal_dispatch�generate_dispatcher_name�129dispatchers r6 r� �+HasTraversalDispatch.run_generated_dispatch sZ � � � �)�)�2�2�3K�L�J� �&�'�'�� � �130 �/�/�� � �"3��J� �s �# �&A � A c �@ � U R X#5 n[ XU5 U$ r0 )�_generate_dispatcher�setattr)r3 �131target_clsr� r� r� s r6 r� �&HasTraversalDispatch.generate_dispatch s) � � �.�.� �132�133� �134�j�A��r9 c � � / nU H6 u pEU R U5 nUc M [ U nUR XG45 M8 SSR S U 5 5 - S- nSU- U- S- n [ [135 [ R " U 0 U5 5 $ )Nz
return [136z, 137c 3 �D # � U H u pS U< SU< SU< S3v � M g7f)z (z, self.z138, visitor.�)Nr1 )r� r� r^ s r6 r� �<HasTraversalDispatch._generate_dispatcher.<locals>.<genexpr>. s' � � � � 16�,��*� ��:�7�05�s � z139 ]140zdef %s(self, visitor):141�142)r� r� �append�joinr r� r �_exec_code_in_env)143r3 r� � method_name�namesr� � visit_symrV r^ �code� meth_texts144 r6 r� �)HasTraversalDispatch._generate_dispatcher! s� � � ��#4� �H��=�=��+�D�� � -�i� 8�145�� � �h� 3�4� $5� �� � � � 16� � �
� �
�
� 0�+�=��E��L� �� *� � )� )�)�R�� E�146� 147r9 N)r� r* r: zCallable[..., Any])r� r� r� r� r� rC r: r )r� z Type[object]r� r� r� rC r: r� )r� r� r� rC r: r� )
r< r= r> r? rg rh r� ri r� r� r� r� r@ r1 r9 r6 r� r� � s� � �� �I�KM��H�M�)�(��(� 2�(� #&� (�148 149
� (�& � � � 2� � #&� �150 151(� �152�!7�153�FI�154� '�155r9 r� c �� � [ n [ HY nUR nUR S5 ( d M' UR SS5 nUR156 nX@; d U5 eU=X' X' M[ g )N�dp_�visit_)r� r* r_ �157startswith�replace�value)�lookup�symrb � visit_key�sym_names r6 � _generate_traversal_dispatchr
@ sb � �
�F� ���h�h�� �>�>�%� � �� � �E�8�4�I��y�y�H��)� 3�8� 3�)�-6� 6�F�K�&�*�
!r9 c � � \ rS rSr% Sr\R rS\S' \ R ( a S S jr SS. S S jjr S
S jr
SS. SS jjrSrg158)�ExternallyTraversibleiP r1 zMapping[Any, Any]� _annotationsc � � g r0 r1 )r3 �valuess r6 � _annotate� ExternallyTraversible._annotateW s � �cr9 r� c � � g r0 r1 �r3 r� r5 s r6 r� �"ExternallyTraversible.get_childrenY s � �.1r9 c � � [ 5 e)zclone this element��NotImplementedError)r3 r5 s r6 �_clone� ExternallyTraversible._clone] s � �!�#�#r9 c � � [ 5 e)aD Reassign internal elements to be clones of themselves.159 160Called during a copy-and-traverse operation on newly161shallow-copied elements to create a deep copy.162 163The given clone function should be used, which may be applying164additional transformations to the element (i.e. replacement165traversal, cloned traversal, annotations).166 167r r s r6 �_copy_internals�%ExternallyTraversible._copy_internalsa s
� � "�#�#r9 N)r r r: r )r� r� r5 r r: � Iterable[ExternallyTraversible])r5 r r: r )r� r� r5 r r: rf )r< r= r> r? rh r �168EMPTY_DICTr ri rj r r r� r r r@ r1 r9 r6 r r P sp � ��I�&*�o�o�L�#�5�
���A� 46� 2�!0� 2�=@� 2�
,� 2�$�169 02�
$� ,�
$�9<�
$�
�
$�
$r9 r �_ET)�bound�_CEzColumnElement[Any]c � � \ rS rSrSS jrSrg)�_CloneCallableTypeix c � � g r0 r1 �r3 �elementr5 s r6 r7 �_CloneCallableType.__call__y s � �r9 r1 N)r) r" r5 r r: r" r; r1 r9 r6 r& r& x s � �;r9 r& c � � \ rS rSrSS jrSrg)� _TraverseTransformCallableTypei| c � � g r0 r1 r( s r6 r7 �'_TraverseTransformCallableType.__call__} s � �#r9 r1 N)r) r" r5 r r: z
Optional[_ET]r; r1 r9 r6 r, r, | s � �Er9 r, �_ExtTr) c �� � \ rS rSr% SrSr0 rS\S' S\S' SS jr SS jr \170SS171 j5 r \172 SS j5 r SS jr SS
jr \
SS j5 rSS jrSrg)r) i� z�Base class for visitor objects which can traverse externally using173the :func:`.visitors.traverse` function.174 175Direct usage of the :func:`.visitors.traverse` function is usually176preferred.177 178)�
_visitor_dict�_nextzDict[str, Any]�__traverse_options__zOptional[ExternalTraversal]r2 c � � U R H/ n[ USUR - S 5 nU( d M& U" U40 UD6s $ g )NrR )�visitor_iteratorr� rD )r3 r� r5 �vrV s r6 �traverse_single�!ExternalTraversal.traverse_single� s> � ��&�&�A��1�j�3�+=�+=� =�t�D�D��t��C��2��&� 'r9 c �, � [ XR 5 $ )zQTraverse the given expression structure, returning an iterator179of all elements.180 181)r# r3 �r3 r� s r6 r# �ExternalTraversal.iterate� s � � �s� 5� 5�6�6r9 c � � g r0 r1 r: s r6 r% �ExternalTraversal.traverse� � � �47r9 c � � g r0 r1 r: s r6 r% r= � � � � !$r9 c �B � [ XR U R 5 $ ��2Traverse and visit the given expression structure.)r% r3 r1 r: s r6 r% r= � s � �182 �� 6� 6��8J�8J�K�Kr9 c �~ � 0 n[ U 5 H+ nUR S5 ( d M [ X5 XSS ' M- U$ )Nr � )�dirr r� )r3 �visitorsr_ s r6 � _memoized_attr__visitor_dict�.ExternalTraversal._memoized_attr__visitor_dict� s@ � � ����I�D����x�(�(�%,�T�%8��a�b��"� � �r9 c # �T # � U nU( a Uv � [ USS5 nU( a M gg7f)z8Iterate through this visitor and each 'chained' visitor.r2 N)r� )r3 r6 s r6 r5 �"ExternalTraversal.visitor_iterator� s) � � � *.����G���7�D�)�A� �a�s �"(�(c �B � [ U R 5 S nXl U $ )z�'Chain' an additional ExternalTraversal onto this ExternalTraversal183 184The chained visitor will receive all visit events after this one.185 186�����)�listr5 r2 )r3 r4 �tails r6 r� �ExternalTraversal.chain� s# � � �D�)�)�*�2�.�� �187�� r9 r1 N)r� r( r5 r r: r )r� � Optional[ExternallyTraversible]r: � Iterator[ExternallyTraversible]�r� �
Literal[None]r: rf �r� r r: r �r� rQ r: rQ )r: z%Dict[str, _TraverseCallableType[Any]])r: zIterator[ExternalTraversal])r3 r/ r4 r) r: r/ )r< r= r> r? rg rh r3 ri r7 r# r r% rH �propertyr5 r� r@ r1 r9 r6 r) r) � s� � �� +�I�+-��.�-� &�&�'� 7�2�7� (�7� �7� �7�
�$�(�$� �$� �$�L�2�L� (�L�� .�� �*� �*�r9 c �p � \ rS rSrSrSr S S jr\S188S j5 r\ S S j5 r S S jrSr g)
�CloningExternalTraversali� z�Base class for visitor objects which can traverse using189the :func:`.visitors.cloned_traverse` function.190 191Direct usage of the :func:`.visitors.cloned_traverse` function is usually192preferred.193 194 195r1 c �N � U Vs/ s H o R U5 PM sn$ s snf )zPApply cloned traversal to the given list of elements, and return196the new list.197 198)r% )r3 �list_�xs r6 �copy_and_process�)CloningExternalTraversal.copy_and_process� s# � � +0�0�%�Q�
�
�a� �%�0�0��0s �"c � � g r0 r1 r: s r6 r% �!CloningExternalTraversal.traverse� r> r9 c � � g r0 r1 r: s r6 r% r` � r@ r9 c �B � [ XR U R 5 $ rB )r& r3 r1 r: s r6 r% r` � s" � �199 � �*�*�D�,>�,>�200� 201r9 N)r[ �List[ExternallyTraversible]r: rc rS rU rV )202r< r= r> r? rg rh r] r r% r@ r1 r9 r6 rY rY � sj � �� �I�1�0�1� $�1� �7� �7�
�$�(�$� �$� �$�203�2�204� (�205r9 rY c �p � \ rS rSrSrSr S S jr\S206S j5 r\ S S j5 r S S jrSr g)
�ReplacingExternalTraversali� z�Base class for visitor objects which can traverse using207the :func:`.visitors.replacement_traverse` function.208 209Direct usage of the :func:`.visitors.replacement_traverse` function is210usually preferred.211 212r1 c � � g)z�Receive pre-copied elements during a cloning traversal.213 214If the method returns a new element, the element is used215instead of creating a simple copy of the element. Traversal216will halt on the newly returned element if it is re-encountered.217Nr1 )r3 �elems r6 r �"ReplacingExternalTraversal.replace� s � � r9 c � � g r0 r1 r: s r6 r% �#ReplacingExternalTraversal.traverse218 r> r9 c � � g r0 r1 r: s r6 r% rj
r@ r9 c �N ^ � SU 4S jjn[ UT R U5 $ )rC c �x >� TR H) n[ [ U5 R U 5 nUc M' Us $ g r0 )r5 r re r )r) r5 r6 �er3 s �r6 r �4ReplacingExternalTraversal.traverse.<locals>.replace s< �� � �*�*���3�Q�7�?�?��H���=� �H� +�219 r9 )r) r r5 r r: rQ )r' r3 )r3 r� r s ` r6 r% rj s9 �� �220 �*� �� � -� � $�C��)B�)B�G�L�Lr9 N)rg r r: rQ rS rU rV )221r< r= r> r? rg rh r r r% r@ r1 r9 r6 re re � sm � �� �I� �)� � (� � �7� �7�
�$�(�$� �$� �$�M�2�M� (�Mr9 re c # � # � U c gU v � U R " S0 UD6nU( d g[ U/5 nU( aH UR 5 nU H( nUv � UR UR " S0 UD65 M* U( a MG gg7f)a Traverse the given expression structure, returning an iterator.222 223Traversal is configured to be breadth-first.224 225The central API feature used by the :func:`.visitors.iterate`226function is the227:meth:`_expression.ClauseElement.get_children` method of228:class:`_expression.ClauseElement` objects. This method should return all229the :class:`_expression.ClauseElement` objects which are associated with a230particular :class:`_expression.ClauseElement` object. For example, a231:class:`.Case` structure will refer to a series of232:class:`_expression.ColumnElement` objects within its "whens" and "else\_"233member variables.234 235:param obj: :class:`_expression.ClauseElement` structure to be traversed236 237:param opts: dictionary of iteration options. This dictionary is usually238 empty in modern usage.239 240Nr1 )r� r �popleftr� )r� �opts�children�stack�241t_iterator�ts r6 r# r# - su � � �0 �{��242
�I�� � �'�$�'�H� �� �8�*� �E�243��]�]�_�244��A��G� �L�L�� � �/�$�/� 0� � �%�s �A;B�?Bc � � g r0 r1 ��iteratorr� rG s r6 r$ r$ V � � �245 r9 c � � g r0 r1 rx s r6 r$ r$ ^ � � �246 r9 c �r � U H0 nUR UR S5 nU( d M( U" U5 M2 U$ )a� Visit the given expression structure using the given iterator of247objects.248 249:func:`.visitors.traverse_using` is usually called internally as the result250of the :func:`.visitors.traverse` function.251 252:param iterator: an iterable or sequence which will yield253 :class:`_expression.ClauseElement`254 structures; the iterator is assumed to be the255 product of the :func:`.visitors.iterate` function.256 257:param obj: the :class:`_expression.ClauseElement`258 that was used as the target of the259 :func:`.iterate` function.260 261:param visitors: dictionary of visit functions. See :func:`.traverse`262 for details on this dictionary.263 264.. seealso::265 266 :func:`.traverse`267 268 269N)�getrD )ry r� rG r� rV s r6 r$ r$ f s7 � �: ���|�|�F� 1� 1�4�8�� �4� ��L� � �Jr9 c � � g r0 r1 �r� rr rG s r6 r% r% � rz r9 c � � g r0 r1 r� s r6 r% r% � r| r9 c �, � [ [ X5 X5 $ )a� Traverse and visit the given expression structure using the default270iterator.271 272 e.g.::273 274 from sqlalchemy.sql import visitors275 276 stmt = select(some_table).where(some_table.c.foo == "bar")277 278 279 def visit_bindparam(bind_param):280 print("found bound value: %s" % bind_param.value)281 282 283 visitors.traverse(stmt, {}, {"bindparam": visit_bindparam})284 285The iteration of objects uses the :func:`.visitors.iterate` function,286which does a breadth-first traversal using a stack.287 288:param obj: :class:`_expression.ClauseElement` structure to be traversed289 290:param opts: dictionary of iteration options. This dictionary is usually291 empty in modern usage.292 293:param visitors: dictionary of visit functions. The dictionary should294 have strings as keys, each of which would correspond to the295 ``__visit_name__`` of a particular kind of SQL expression object, and296 callable functions as values, each of which represents a visitor function297 for that kind of object.298 299)r$ r# r� s r6 r% r% � s � �H �'�#�,�c� <�<r9 c � � g r0 r1 r� s r6 r& r& � rz r9 c � � g r0 r1 r� s r6 r& r& � � � �300 r9 c � ^^^^^� 0 m[ TR S/ 5 5 m SUU4S jjnSUUUU4S jjmU b T" U 4SU0TD6n SmU $ )a� Clone the given expression structure, allowing modifications by301visitors for mutable objects.302 303Traversal usage is the same as that of :func:`.visitors.traverse`.304The visitor functions present in the ``visitors`` dictionary may also305modify the internals of the given structure as the traversal proceeds.306 307The :func:`.cloned_traverse` function does **not** provide objects that are308part of the :class:`.Immutable` interface to the visit methods (this309primarily includes :class:`.ColumnClause`, :class:`.Column`,310:class:`.TableClause` and :class:`.Table` objects). As this traversal is311only intended to allow in-place mutation of objects, :class:`.Immutable`312objects are skipped. The :meth:`.Immutable._clone` method is still called313on each object to allow for objects to replace themselves with a different314object based on a clone of their sub-internals (e.g. a315:class:`.ColumnClause` that clones its subquery to return a new316:class:`.ColumnClause`).317 318.. versionchanged:: 2.0 The :func:`.cloned_traverse` function omits319 objects that are part of the :class:`.Immutable` interface.320 321The central API feature used by the :func:`.visitors.cloned_traverse`322and :func:`.visitors.replacement_traverse` functions, in addition to the323:meth:`_expression.ClauseElement.get_children`324function that is used to achieve325the iteration, is the :meth:`_expression.ClauseElement._copy_internals`326method.327For a :class:`_expression.ClauseElement`328structure to support cloning and replacement329traversals correctly, it needs to be able to pass a cloning function into330its internal members in order to make copies of them.331 332.. seealso::333 334 :func:`.visitors.traverse`335 336 :func:`.visitors.replacement_traverse`337 338�stop_onc � >� [ U TT5 $ r0 )r& r� s ��r6 �deferred_copy_internals�0cloned_traverse.<locals>.deferred_copy_internals s �� � �s�D�(�3�3r9 c � >� U T; a U $ [ U 5 T; a� SU; a3 [ [ [ US " U 5 5 nUb UT[ U 5 ' U$ U R " SST0UD6=T[ U 5 ' nUR339 " SST0UD6 U R ( d+ TR UR S 5 nU( a U" U5 T[ U 5 $ )Nr �cloner1 ) �idr r r r r r� r~ rD )rg r5 �newelemrV r� �clonedr� rG s ����r6 r� � cloned_traverse.<locals>.clone340 s� �� � �7�?��K��$�x�v�%� ��?� "� �!6�7��I� �t�9L� �G� �*�+2��r�$�x�(� &�� .2�[�[�-K�u�-K��-K�K��r�$�x� �7��'�'�:�e�:�r�:�341 �)�)�#�<�<��(>�(>��E�D�� �W�
��"�T�(�#� #r9 Nr� rU �rg r r5 r r: r )�setr~ )r� rr rG r� r� r� r� s `` @@@r6 r& r& � st �� �Z 02�F��$�(�(�9�b�)�*�G�4�
"�4� �4� 4�342 $� $�< ��� �343�)@�344�DH�345��
�E� �Jr9 c � � g r0 r1 �r� rr r s r6 r' r' 0 rz r9 c � � g r0 r1 r� s r6 r' r' 8 r� r9 c � � g r0 r1 r� s r6 r' r' @ r| r9 c �� ^^^^^� 0 mTR S/ 5 Vs1 s H n[ U5 iM snm SUU4S jjnSUUUU4S jjmU b T" U 4SU0TD6n SmU $ s snf )a Clone the given expression structure, allowing element346replacement by a given replacement function.347 348This function is very similar to the :func:`.visitors.cloned_traverse`349function, except instead of being passed a dictionary of visitors, all350elements are unconditionally passed into the given replace function.351The replace function then has the option to return an entirely new object352which will replace the one given. If it returns ``None``, then the object353is kept in place.354 355The difference in usage between :func:`.visitors.cloned_traverse` and356:func:`.visitors.replacement_traverse` is that in the former case, an357already-cloned object is passed to the visitor function, and the visitor358function can then manipulate the internal state of the object.359In the case of the latter, the visitor function should only return an360entirely different object, or do nothing.361 362The use case for :func:`.visitors.replacement_traverse` is that of363replacing a FROM clause inside of a SQL structure with a different one,364as is a common use case within the ORM.365 366r� c � >� [ U TT5 $ r0 )r' r� s ��r6 r� �5replacement_traverse.<locals>.deferred_copy_internalsg s �� � $�C��w�7�7r9 c �L >� [ U 5 T; d SU R ; a U $ T" U 5 nUb TR [ U5 5 U$ [ U 5 nUT; aF SU; a US " U 5 nUb UTU' U$ U R " S0 UD6=TU' nUR " SST0UD6 TU $ )N�no_replacement_traverser r� r1 )r� r �addr r )rg r5 r� �id_elemr� r� r r� s ����r6 r� �#replacement_traverse.<locals>.clonel s� �� � �t�H�� �(�D�,=�,=�=��K� �d�m�G��"�� � �B�w�K�(� ��367 �T�(���&�(� �B��"$�Y�-��"5��"�.�.5�F�7�O�#*�N�04� � �0A�b�0A�A�F�7�O�g��+�+�>�%�>�2�>� �g��&r9 Nr� rU r� )r~ r� )r� rr r r\ r� r� r� r� s `` @@@r6 r' r' H s� �� �8 �F� "�h�h�y�"� 5�6� 5��r�!�u� 5�6�G�8�
"�8� �8� 8�368'� '�6 ��� �369�)@�370�DH�371��
�E� �J��O 7s �A re )r� rQ rr �Mapping[str, Any]r: rR )ry r r� rT rG �(Mapping[str, _TraverseCallableType[Any]]r: rf )ry r r� r rG r� r: r )ry r r� rQ rG r� r: rQ )r� rT rr r� rG r� r: rf )r� r rr r� rG r� r: r )r� rQ rr r� rG r� r: rQ )r� r" rr r� rG r� r: r" )r� rT rr r� r �#_TraverseTransformCallableType[Any]r: rf )r� r$ rr r� r r� r: r$ )r� r rr r� r r� r: r )r� rQ rr r� r r� r: rQ )Nrg �372__future__r � collectionsr �enumr r� r\ rj r r r r r373 r r r
r r r r r r r r � r r r � util._has_cyr � util.typingr r r �374annotationr �elementsr �_py_utilr! r" r+ �sqlalchemy.cyextension.util�__all__r- r( r* rC r� r� r� r� �ExtendedInternalTraversalr
r� r r" r$ �_TraverseCallableTyper& r, r/ �
MemoizedSlotsr) rY re � Traversible�
ClauseVisitor�CloningVisitor�ReplacingCloningVisitorr! r# r$ r% r& r' r1 r9 r6 �<module>r� s� �� 9� "� � � � �
� � � � � � � � � � � � � � � � � � � � *� !� "� ��+�'� ����<�4���375 376 ��N�H� N�G� G�TP �� P �f �e�C�):�$:� ;�<� �377�1378� 1379�hM�X� M�L380� L381�^ .� � 7� (�8�8� � � � $� 0�)� $�B �e�0�1��
�e�/�0�� �#����-� �<�� <�F�X�c�]� F� �� 2�3��G��*�*� G�T$382� 0� $383�N.M�!9� .M�d � �!�
�)��4� �384 #�o�o�&1� (�&1�385�&1� %�&1�R 386��-�� �� 7�� 387� � 388�� 389� �-� � � � 7� � � � 390� �!�-�!� (�!� 7�!� %� !�H 391�� ��392�� 7�� 393� � 394�� 395� � � �396� � 7� � � � 397� �$=� (�$=�398�$=� 7�$=� %� $=�N 399�� ��400�� 7�� 401� � 402�� 403�� ��404�� 7�� � � 405��X� (�X�406�X� 7�X� %� X�v 407�� ��408�� 1�� 409� � 410�� 411�� ��412�� 1�� � � 413�� 414� � � �415� � 1� � � � 416� �D� (�D�417�D� 1�D� %� Dr9