sqlalchemy.orm.base.InspectionAttrInfo

class documentation

class InspectionAttrInfo(InspectionAttr): (source)

Known subclasses: sqlalchemy.ext.associationproxy.AssociationProxy, sqlalchemy.ext.hybrid.hybrid_method, sqlalchemy.ext.hybrid.hybrid_property, sqlalchemy.orm.interfaces.MapperProperty, sqlalchemy.orm.state.InstanceState

View In Hierarchy

Adds the ``.info`` attribute to :class:`.InspectionAttr`. The rationale for :class:`.InspectionAttr` vs. :class:`.InspectionAttrInfo` is that the former is compatible as a mixin for classes that specify ``__slots__``; this is essentially an implementation artifact.

Class Variable	`__slots__`	Undocumented
Property	`info`	Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.InspectionAttr`.

Inherited from InspectionAttr:

Class Variable	`is_aliased_class`	True if this object is an instance of :class:`.AliasedClass`.
Class Variable	`is_attribute`	True if this object is a Python :term:`descriptor`.
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.

__slots__: tuple = (source) ¶

overrides sqlalchemy.orm.base.InspectionAttr.__slots__

overridden in sqlalchemy.orm.interfaces.MapperProperty, sqlalchemy.orm.state.InstanceState

Undocumented

@util.ro_memoized_property
info: _InfoType = (source) ¶

overridden in sqlalchemy.ext.associationproxy.AssociationProxy, sqlalchemy.orm.interfaces.MapperProperty

Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.InspectionAttr`. The dictionary is generated when first accessed. Alternatively, it can be specified as a constructor argument to the :func:`.column_property`, :func:`_orm.relationship`, or :func:`.composite` functions. .. versionchanged:: 1.0.0 :attr:`.MapperProperty.info` is also available on extension types via the :attr:`.InspectionAttrInfo.info` attribute, so that it can apply to a wider variety of ORM and extension constructs. .. seealso:: :attr:`.QueryableAttribute.info` :attr:`.SchemaItem.info`