Classe « registry »

Informations générales

Héritage

builtins.object
    registry

Définition

class registry(builtins.object):

help(registry)

Generalized registry for mapping classes.

The :class:`_orm.registry` serves as the basis for maintaining a collection
of mappings, and provides configurational hooks used to map classes.

The three general kinds of mappings supported are Declarative Base,
Declarative Decorator, and Imperative Mapping.   All of these mapping
styles may be used interchangeably:

* :meth:`_orm.registry.generate_base` returns a new declarative base
  class, and is the underlying implementation of the
  :func:`_orm.declarative_base` function.

* :meth:`_orm.registry.mapped` provides a class decorator that will
  apply declarative mapping to a class without the use of a declarative
  base class.

* :meth:`_orm.registry.map_imperatively` will produce a
  :class:`_orm.Mapper` for a class without scanning the class for
  declarative class attributes. This method suits the use case historically
  provided by the ``sqlalchemy.orm.mapper()`` classical mapping function,
  which is removed as of SQLAlchemy 2.0.

.. versionadded:: 1.4

.. seealso::

    :ref:`orm_mapping_classes_toplevel` - overview of class mapping
    styles.

Constructeur(s)

Signature du constructeur	Description
__init__(self, *, metadata: 'Optional[MetaData]' = None, class_registry: 'Optional[clsregistry._ClsRegistryType]' = None, type_annotation_map: 'Optional[_TypeAnnotationMapType]' = None, constructor: 'Callable[..., None]' = <function _declarative_constructor at 0x0000020DA13BC2C0>)	Construct a new :class:`_orm.registry` _{[extrait de __init__.__doc__]}

Liste des propriétés

Nom de la propriété	Description
mappers	read only collection of all :class:`_orm.Mapper` objects. _{[extrait de mappers.__doc__]}

Liste des opérateurs

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

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

Liste des méthodes

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

Signature de la méthode	Description
as_declarative_base(self, **kw: 'Any') -> 'Callable[[Type[_T]], Type[_T]]'
configure(self, cascade: 'bool' = False) -> 'None'	Configure all as-yet unconfigured mappers in this _{[extrait de configure.__doc__]}
dispose(self, cascade: 'bool' = False) -> 'None'	Dispose of all mappers in this :class:`_orm.registry`. _{[extrait de dispose.__doc__]}
generate_base(self, mapper: 'Optional[Callable[..., Mapper[Any]]]' = None, cls: 'Type[Any]' = <class 'object'>, name: 'str' = 'Base', metaclass: 'Type[Any]' = <class 'sqlalchemy.orm.decl_api.DeclarativeMeta'>) -> 'Any'	Generate a declarative base class. _{[extrait de generate_base.__doc__]}
map_declaratively(self, cls: 'Type[_O]') -> 'Mapper[_O]'	Map a class declaratively. _{[extrait de map_declaratively.__doc__]}
map_imperatively(self, class_: 'Type[_O]', local_table: 'Optional[FromClause]' = None, **kw: 'Any') -> 'Mapper[_O]'	Map a class imperatively. _{[extrait de map_imperatively.__doc__]}
mapped(self, cls: 'Type[_O]') -> 'Type[_O]'	Class decorator that will apply the Declarative mapping process _{[extrait de mapped.__doc__]}
mapped_as_dataclass(self, _registry__cls: 'Optional[Type[_O]]' = None, *, init: 'Union[_NoArg, bool]' = _NoArg.NO_ARG, repr: 'Union[_NoArg, bool]' = _NoArg.NO_ARG, eq: 'Union[_NoArg, bool]' = _NoArg.NO_ARG, order: 'Union[_NoArg, bool]' = _NoArg.NO_ARG, unsafe_hash: 'Union[_NoArg, bool]' = _NoArg.NO_ARG, match_args: 'Union[_NoArg, bool]' = _NoArg.NO_ARG, kw_only: 'Union[_NoArg, bool]' = _NoArg.NO_ARG, dataclass_callable: 'Union[_NoArg, Callable[..., Type[Any]]]' = _NoArg.NO_ARG) -> 'Union[Type[_O], Callable[[Type[_O]], Type[_O]]]'	Class decorator that will apply the Declarative mapping process _{[extrait de mapped_as_dataclass.__doc__]}
update_type_annotation_map(self, type_annotation_map: '_TypeAnnotationMapType') -> 'None'	update the :paramref:`_orm.registry.type_annotation_map` with new _{[extrait de update_type_annotation_map.__doc__]}