class documentation

class InstrumentedAttribute(QueryableAttribute[_T]): (source)

View In Hierarchy

Class bound instrumented attribute which adds basic :term:`descriptor` methods. See :class:`.QueryableAttribute` for a description of most features.

Method __delete__ Undocumented
Method __doc__ Undocumented
Method __get__ Undocumented
Method __set__ Undocumented
Class Variable __slots__ Undocumented
Class Variable inherit_cache :meta private:
Method __doc__.setter Undocumented
Instance Variable _doc Undocumented

Inherited from QueryableAttribute:

Method __clause_element__ Undocumented
Method __getattr__ Undocumented
Method __init__ Undocumented
Method __reduce__ Undocumented
Method __str__ Undocumented
Method adapt_to_entity Return a copy of this PropComparator which will use the given :class:`.AliasedInsp` to produce corresponding expressions.
Method and_ Add additional criteria to the ON clause that's represented by this relationship attribute.
Method get_history Undocumented
Method hasparent Undocumented
Method label Undocumented
Method of_type Redefine this object in terms of a polymorphic subclass, :func:`_orm.with_polymorphic` construct, or :func:`_orm.aliased` construct.
Method operate Operate on an argument.
Method reverse_operate Reverse operate on an argument.
Class Variable __visit_name__ Undocumented
Class Variable dispatch Undocumented
Class Variable expression The SQL expression object represented by this :class:`.QueryableAttribute`.
Class Variable is_attribute True if this object is a Python :term:`descriptor`.
Class Variable parententity Undocumented
Instance Variable class_ Undocumented
Instance Variable comparator Undocumented
Instance Variable impl Undocumented
Instance Variable key Undocumented
Instance Variable parent Return an inspection instance representing the parent.
Property info Return the 'info' dictionary for the underlying SQL element.
Method _bulk_update_tuples Return setter tuples for a bulk UPDATE.
Method _clone Undocumented
Method _memoized_attr__propagate_attrs Undocumented
Method _memoized_attr_expression Undocumented
Method _memoized_attr_property Undocumented
Class Variable _cache_key_traversal Undocumented
Instance Variable _extra_criteria Undocumented
Instance Variable _of_type Undocumented
Instance Variable _parententity Undocumented
Property _annotations Undocumented
Property _entity_namespace Undocumented
Property _from_objects Undocumented
Property _impl_uses_objects Undocumented

Inherited from Mapped (via QueryableAttribute, _DeclarativeMapped):

Class Method _empty_constructor Undocumented

Inherited from InspectionAttr (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression):

Class Variable is_aliased_class True if this object is an instance of :class:`.AliasedClass`.
Class Variable is_bundle True if this object is an instance of :class:`.Bundle`.
Class Variable is_clause_element True if this object is an instance of :class:`_expression.ClauseElement`.
Class Variable is_instance True if this object is an instance of :class:`.InstanceState`.
Class Variable is_mapper True if this object is an instance of :class:`_orm.Mapper`.
Class Variable is_property True if this object is an instance of :class:`.MapperProperty`.
Class Variable is_selectable Return True if this object is an instance of :class:`_expression.Selectable`.
Class Variable _is_internal_proxy True if this object is an internal proxy object.

Inherited from PropComparator (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr):

Method any Return a SQL expression representing true if this element references a member which meets the given criterion.
Method has Return a SQL expression representing true if this element references a member which meets the given criterion.
Class Variable any_op Undocumented
Class Variable has_op Undocumented
Class Variable of_type_op Undocumented
Instance Variable prop Undocumented
Property adapter Produce a callable that adapts column expressions to suit an aliased version of this comparator.
Property property Return the :class:`.MapperProperty` associated with this :class:`.PropComparator`.
Static Method _any_op Undocumented
Static Method _has_op Undocumented
Static Method _of_type_op Undocumented
Method _criterion_exists Undocumented
Instance Variable _adapt_to_entity Undocumented
Property _parentmapper legacy; this is renamed to _parententity to be compatible with QueryableAttribute.

Inherited from SQLCoreOperations (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression):

Method __add__ Implement the ``+`` operator.
Method __and__ Implement the ``&`` operator.
Method __contains__ Undocumented
Method __eq__ Implement the ``==`` operator.
Method __floordiv__ Implement the ``//`` operator.
Method __ge__ Implement the ``>=`` operator.
Method __getitem__ Implement the [] operator.
Method __gt__ Implement the ``>`` operator.
Method __invert__ Implement the ``~`` operator.
Method __le__ Implement the ``<=`` operator.
Method __lt__ Implement the ``<`` operator.
Method __mod__ Implement the ``%`` operator.
Method __mul__ Implement the ``*`` operator.
Method __ne__ Implement the ``!=`` operator.
Method __neg__ Implement the ``-`` operator.
Method __or__ Implement the ``|`` operator.
Method __radd__ Implement the ``+`` operator in reverse.
Method __rfloordiv__ Implement the ``//`` operator in reverse.
Method __rmod__ Implement the ``%`` operator in reverse.
Method __rmul__ Implement the ``*`` operator in reverse.
Method __rsub__ Implement the ``-`` operator in reverse.
Method __rtruediv__ Implement the ``/`` operator in reverse.
Method __sub__ Implement the ``-`` operator.
Method __truediv__ Implement the ``/`` operator.
Method all_ Produce an :func:`_expression.all_` clause against the parent object.
Method any_ Produce an :func:`_expression.any_` clause against the parent object.
Method asc Produce a :func:`_expression.asc` clause against the parent object.
Method between Produce a :func:`_expression.between` clause against the parent object, given the lower and upper range.
Method bool_op Return a custom boolean operator.
Method collate Produce a :func:`_expression.collate` clause against the parent object, given the collation string.
Method concat Implement the 'concat' operator.
Method contains Implement the 'contains' operator.
Method desc Produce a :func:`_expression.desc` clause against the parent object.
Method distinct Produce a :func:`_expression.distinct` clause against the parent object.
Method endswith Implement the 'endswith' operator.
Method ilike Implement the ``ilike`` operator, e.g. case insensitive LIKE.
Method in_ Implement the ``in`` operator.
Method is_ Implement the ``IS`` operator.
Method is_distinct_from Implement the ``IS DISTINCT FROM`` operator.
Method is_not Implement the ``IS NOT`` operator.
Method is_not_distinct_from Implement the ``IS NOT DISTINCT FROM`` operator.
Method isnot Undocumented
Method like Implement the ``like`` operator.
Method match Implements a database-specific 'match' operator.
Method not_ilike implement the ``NOT ILIKE`` operator.
Method not_in implement the ``NOT IN`` operator.
Method not_like implement the ``NOT LIKE`` operator.
Method notilike Undocumented
Method notin_ Undocumented
Method notlike Undocumented
Method nulls_first Produce a :func:`_expression.nulls_first` clause against the parent object.
Method nulls_last Produce a :func:`_expression.nulls_last` clause against the parent object.
Method nullsfirst Undocumented
Method nullslast Undocumented
Method op Produce a generic operator function.
Method regexp_match Implements a database-specific 'regexp match' operator.
Method regexp_replace Implements a database-specific 'regexp replace' operator.
Method startswith Implement the ``startswith`` operator.
Property _propagate_attrs Undocumented

Inherited from ExpressionElementRole (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression, SQLCoreOperations):

Class Variable _role_name Undocumented

Inherited from ColumnOperators (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute):

Method __lshift__ implement the << operator.
Method __rshift__ implement the >> operator.
Method bitwise_and Produce a bitwise AND operation, typically via the ``&`` operator.
Method bitwise_lshift Produce a bitwise LSHIFT operation, typically via the ``<<`` operator.
Method bitwise_not Produce a bitwise NOT operation, typically via the ``~`` operator.
Method bitwise_or Produce a bitwise OR operation, typically via the ``|`` operator.
Method bitwise_rshift Produce a bitwise RSHIFT operation, typically via the ``>>`` operator.
Method bitwise_xor Produce a bitwise XOR operation, typically via the ``^`` operator, or ``#`` for PostgreSQL.
Method icontains Implement the ``icontains`` operator, e.g. case insensitive version of :meth:`.ColumnOperators.contains`.
Method iendswith Implement the ``iendswith`` operator, e.g. case insensitive version of :meth:`.ColumnOperators.endswith`.
Method isnot_distinct_from Undocumented
Method istartswith Implement the ``istartswith`` operator, e.g. case insensitive version of :meth:`.ColumnOperators.startswith`.
Class Variable timetuple Hack, allows datetime objects to be compared on the LHS.
Method _rconcat Implement an 'rconcat' operator.

Inherited from TypingOnly (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators):

Method __init_subclass__ Undocumented

Inherited from AllowsLambdaRole (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, DDLConstraintColumnRole, JoinTargetRole, OnClauseRole):

Class Variable allows_lambda Undocumented

Inherited from UsesInspection (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, DDLConstraintColumnRole, JoinTargetRole, OnClauseRole, AllowsLambdaRole):

Class Variable uses_inspection Undocumented
Class Variable _post_inspect Undocumented

Inherited from Immutable (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, DDLConstraintColumnRole, JoinTargetRole, OnClauseRole, AllowsLambdaRole, UsesInspection, StructuralRole, SQLRole):

Method params Undocumented
Method unique_params Undocumented
Method _copy_internals Undocumented
Class Variable _is_immutable Undocumented

Inherited from SlotsMemoizedHasCacheKey (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, DDLConstraintColumnRole, JoinTargetRole, OnClauseRole, AllowsLambdaRole, UsesInspection, StructuralRole, SQLRole, Immutable):

Method _memoized_method__generate_cache_key Undocumented

Inherited from HasCacheKey (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, DDLConstraintColumnRole, JoinTargetRole, OnClauseRole, AllowsLambdaRole, UsesInspection, StructuralRole, SQLRole, Immutable, SlotsMemoizedHasCacheKey):

Class Method _generate_cache_attrs generate cache key dispatcher for a new class.
Class Method _generate_cache_key_for_object Undocumented
Method _gen_cache_key return an optional cache key.
Method _generate_cache_key return a cache key.
Class Variable _generated_cache_key_traversal Undocumented
Class Variable _hierarchy_supports_caching private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses.
Class Variable _is_has_cache_key Undocumented

Inherited from MemoizedSlots (via QueryableAttribute, _DeclarativeMapped, Mapped, SQLORMExpression, InspectionAttr, PropComparator, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, DDLConstraintColumnRole, JoinTargetRole, OnClauseRole, AllowsLambdaRole, UsesInspection, StructuralRole, SQLRole, Immutable, SlotsMemoizedHasCacheKey, HasCacheKey):

Method _fallback_getattr Undocumented
def __delete__(self, instance: object): (source)

Undocumented

@__doc__.classlevel
def __doc__(cls) -> Optional[str]: (source)

Undocumented

@overload
def __get__(self, instance: None, owner: Any) -> InstrumentedAttribute[_T]:
@overload
def __get__(self, instance: object, owner: Any) -> _T:
(source)

Undocumented

def __set__(self, instance: object, value: Any): (source)

Undocumented

@__doc__.setter
def __doc__(self, value: Optional[str]): (source)

Undocumented