sqlalchemy.sql.visitors.ExternallyTraversible

class documentation

class ExternallyTraversible(HasTraverseInternals, Visitable): (source)

Known subclasses: sqlalchemy.sql.annotation.SupportsAnnotations, sqlalchemy.sql.elements.ClauseElement

Undocumented

Method	`get_children`	Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`.
Class Variable	`__slots__`	Undocumented
Method	`_annotate`	Undocumented
Method	`_clone`	clone this element
Method	`_copy_internals`	Reassign internal elements to be clones of themselves.

Inherited from HasTraverseInternals:

Class Variable	`_is_immutable`	Undocumented
Class Variable	`_traverse_internals`	Undocumented

Inherited from Visitable (via HasTraverseInternals):

Method	`__class_getitem__`	Undocumented
Method	`__init_subclass__`	Undocumented
Class Variable	`__visit_name__`	Undocumented
Class Method	`_generate_compiler_dispatch`	Undocumented
Method	`_compiler_dispatch`	Undocumented
Class Variable	`_original_compiler_dispatch`	Undocumented

def get_children(self, *, omit_attrs: Tuple[str, ...] = (), **kw: Any) -> Iterable[ExternallyTraversible]: (source) ¶

overrides sqlalchemy.sql.visitors.HasTraverseInternals.get_children

overridden in sqlalchemy.sql.elements.ClauseElement, sqlalchemy.sql.elements.ClauseElement, sqlalchemy.sql.selectable.Select

Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`. This is used for visit traversal. \**kw may contain flags that change the collection that is returned, for example to return a subset of items in order to cut down on larger traversals, or to return child items from a different context (such as schema-level collections instead of clause-level).

__slots__: tuple = (source) ¶

overrides sqlalchemy.sql.visitors.HasTraverseInternals.__slots__

overridden in sqlalchemy.sql.annotation.SupportsAnnotations

Undocumented

def _annotate(self, values: _AnnotationDict) -> Self: (source) ¶

overridden in sqlalchemy.sql.annotation.SupportsAnnotations

Undocumented

def _clone(self, **kw: Any) -> Self: (source) ¶

overridden in sqlalchemy.orm.query.Query, sqlalchemy.orm.util.Bundle, sqlalchemy.sql.annotation.Annotated, sqlalchemy.sql.elements.ClauseElement, sqlalchemy.sql.elements.ClauseElement

clone this element

def _copy_internals(self, *, omit_attrs: Tuple[str, ...] = (), **kw: Any): (source) ¶

overridden in sqlalchemy.dialects.postgresql.aggregate_order_by, sqlalchemy.dialects.postgresql.aggregate_order_by, sqlalchemy.sql.elements.Label, sqlalchemy.sql.elements.Label, sqlalchemy.sql.elements.TableValuedColumn, sqlalchemy.sql.elements.TableValuedColumn, sqlalchemy.sql.lambdas.LambdaElement, sqlalchemy.sql.lambdas.LambdaElement, sqlalchemy.sql.selectable.AliasedReturnsRows, sqlalchemy.sql.selectable.AliasedReturnsRows, sqlalchemy.sql.selectable.AnnotatedFromClause, sqlalchemy.sql.selectable.Join, sqlalchemy.sql.selectable.Join, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.crud._multiparam_column, sqlalchemy.sql.crud._multiparam_column

Reassign internal elements to be clones of themselves. Called during a copy-and-traverse operation on newly shallow-copied elements to create a deep copy. The given clone function should be used, which may be applying additional transformations to the element (i.e. replacement traversal, cloned traversal, annotations).