Classe « Mapped »

Informations générales

Héritage

            builtins.object
                SQLRole
                    DDLConstraintColumnRole
            builtins.object
                TypingOnly
            builtins.object
                Generic
                    _MappedAnnotationBase
            builtins.object
                TypingOnly
            builtins.object
                Generic
                    ORMDescriptor
            builtins.object
                TypingOnly
        builtins.object
            TypingOnly
builtins.object
    SQLRole
builtins.object
    Generic
        TypedColumnsClauseRole
            ExpressionElementRole
    builtins.object
        TypingOnly
builtins.object
    Operators
        ColumnOperators
    builtins.object
        Generic
            SQLCoreOperations
                SQLColumnExpression
        builtins.object
            TypingOnly
    builtins.object
        TypingOnly
builtins.object
    Operators
        ColumnOperators
    builtins.object
        Generic
            SQLCoreOperations
                SQLORMOperations
                    SQLORMExpression
                        Mapped

Définition

class Mapped(SQLORMExpression, ORMDescriptor, _MappedAnnotationBase, DDLConstraintColumnRole):

help(Mapped)

Represent an ORM mapped attribute on a mapped class.

This class represents the complete descriptor interface for any class
attribute that will have been :term:`instrumented` by the ORM
:class:`_orm.Mapper` class.   Provides appropriate information to type
checkers such as pylance and mypy so that ORM-mapped attributes
are correctly typed.

The most prominent use of :class:`_orm.Mapped` is in
the :ref:`Declarative Mapping <orm_explicit_declarative_base>` form
of :class:`_orm.Mapper` configuration, where used explicitly it drives
the configuration of ORM attributes such as :func:`_orm.mapped_class`
and :func:`_orm.relationship`.

.. seealso::

    :ref:`orm_explicit_declarative_base`

    :ref:`orm_declarative_table`

.. tip::

    The :class:`_orm.Mapped` class represents attributes that are handled
    directly by the :class:`_orm.Mapper` class. It does not include other
    Python descriptor classes that are provided as extensions, including
    :ref:`hybrids_toplevel` and the :ref:`associationproxy_toplevel`.
    While these systems still make use of ORM-specific superclasses
    and structures, they are not :term:`instrumented` by the
    :class:`_orm.Mapper` and instead provide their own functionality
    when they are accessed on a class.

.. versionadded:: 1.4

Constructeur(s)

Signature du constructeur	Description
__init__(self, /, args, *kwargs)	Initialize self. See help(type(self)) for accurate signature. _{[extrait de __init__.__doc__]}

Liste des attributs statiques

Nom de l'attribut	Valeur
allows_lambda	False
timetuple	None
uses_inspection	False

Liste des opérateurs

Opérateurs hérités de la classe ColumnOperators

__add__, __contains__, __eq__, __floordiv__, __ge__, __getitem__, __gt__, __le__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __radd__, __rfloordiv__, __rmod__, __rmul__, __rshift__, __rsub__, __rtruediv__, __sub__, __truediv__

Liste des opérateurs

Opérateurs hérités de la classe Operators

__and__, __invert__, __or__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
__class_getitem__	Parameterizes a generic class. _{[extrait de __class_getitem__.__doc__]}

Méthodes héritées de la classe DDLConstraintColumnRole

__init_subclass__, __subclasshook__

Méthodes héritées de la classe ExpressionElementRole

label

Méthodes héritées de la classe ColumnOperators

all_, any_, asc, between, bitwise_and, bitwise_lshift, bitwise_not, bitwise_or, bitwise_rshift, bitwise_xor, collate, concat, contains, desc, distinct, endswith, icontains, iendswith, ilike, in_, is_, is_distinct_from, is_not, is_not_distinct_from, isnot, isnot_distinct_from, istartswith, like, match, not_ilike, not_in, not_like, notilike, notin_, notlike, nulls_first, nulls_last, nullsfirst, nullslast, regexp_match, regexp_replace, startswith