,h SrSSKJr SSKrSSKrSSKrSSKJr SSKJr SSKJr SSKJ r SSKJ r SS KJ r SS KJ r SS KJ r SS KJr SS KJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKrSSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJ r SSKJ!r! SSKJ"r" SSKJ#r# SS KJ$r$ SS!K%J&r& SS"K%J'r' SS#K%J(r( SS$K%J)r) SS%K*J+r+ SS&K*J,r, SS'K*J-r- SS(K*J.r. SS)K*J/r/ SS*K*J0r0 SS+K*J1r1 SS,K2J3r3 SS-K2J4r4 SS-K2J4r5 SS.K6J7r7 SS/K8J9r9 SS0K:J;r; SS1Kr> S2S4KJ?r? S2S5KJ@r@ S2S6KAJBrB S2S7KCJDrD S2S8KEJFrF S2S9KGJHrH S2S:KIJJrJ S2S;K@JKrK S2SK@JNrN S2S?KOJPrP S2S@KOJQrQ S2SAKOJRrR S2SBKOJSrS S2SCKOJTrT S2SDKOJUrU S2SEKOJVrV S2SFKOJWrW S2SGKOJXrX S2SHKOJYrY \(a0SSIKZJ[r[ SSJKZJ\r\ SSKK*J]r] SSLKJ^r^ SSMKJ_r_ SS1K40 ;))J-Cc8,,--L $' ||66 Ce , ce3r]rnN) rrrrrrrrrprq)rrrsrtru__annotations__rrvrnr]r[rrs;44$'4034;>4 4r]rc^^SUU4SjjnU$)aDecorator that produces an :func:`_orm.synonym` attribute in conjunction with a Python descriptor. The function being decorated is passed to :func:`_orm.synonym` as the :paramref:`.orm.synonym.descriptor` parameter:: class MyClass(Base): __tablename__ = "my_table" id = Column(Integer, primary_key=True) _job_status = Column("job_status", String(50)) @synonym_for("job_status") @property def job_status(self): return "Status: %s" % self._job_status The :ref:`hybrid properties ` feature of SQLAlchemy is typically preferred instead of synonyms, which is a more legacy feature. .. seealso:: :ref:`synonyms` - Overview of synonyms :func:`_orm.synonym` - the mapper-level function :ref:`mapper_hybrids` - The Hybrid Attribute extension provides an updated approach to augmenting attribute behavior more flexibly than can be achieved with synonyms. c>[TTUS9$)N) map_column descriptor) _orm_synonym)fnrnames r[decoratesynonym_for..decoratesDZBGGr])rCallable[..., Any]rpz Synonym[Any]rn)rrrs`` r[ synonym_forrsHHH Or]cD\rSrSrSSSjjrS SjrS SjrSrg) _declared_attr_commonc[U[5(a URnXlX lX0lUR UlgN)r classmethod__func__fget _cascading_quietr{)selfr cascadingquiets r[r_declared_attr_common.__init__s4 b+ & &B # zz r]c`[R"UR5RS5$)Nrp)r7get_annotationsrrrs r[_collect_return_annotation0_declared_attr_common._collect_return_annotation s"##DII.228< !   99S> !#335 +++00 ;9 "iin ,CIJr])r{rrrN)FF)rrrboolrr)rpzOptional[Type[Any]])rOptional[object]rrrpr)rrrsrtrurrrrvrnr]r[rrs5  " "" "*=%r]rcz\rSrSr\R (a"S S SjjrS SjrS SjrS Sjr SSjr Sr gSr g)_declared_directivei5cgrrnrrrs r[r_declared_directive.__init__: r]cgrrnrrrs r[r_declared_directive.__get__@sr]cgrrnrrrhs r[__set___declared_directive.__set__Bcr]cgrrnrrs r[ __delete___declared_directive.__delete__DSr]cgrrnrrs r[__call___declared_directive.__call__Fs r]rnNF)rzCallable[..., _T]rr)rrrrrprRrrrhrrprqrrrprq)rzCallable[..., _TT]rpz_declared_directive[_TT]) rrrsrtrur?rrrrrrrvrnr]r[rr5s? $ !   MA8 r]rc\rSrSrSr\R (a:SSSjjrSSjrSSjr \ SSj5r \ SSj5r SSjr \ SS j5r \SS j5r\SS j5rS rg ) declared_attriKa Mark a class-level method as representing the definition of a mapped property or Declarative directive. :class:`_orm.declared_attr` is typically applied as a decorator to a class level method, turning the attribute into a scalar-like property that can be invoked from the uninstantiated class. The Declarative mapping process looks for these :class:`_orm.declared_attr` callables as it scans classes, and assumes any attribute marked with :class:`_orm.declared_attr` will be a callable that will produce an object specific to the Declarative mapping or table configuration. :class:`_orm.declared_attr` is usually applicable to :ref:`mixins `, to define relationships that are to be applied to different implementors of the class. It may also be used to define dynamically generated column expressions and other Declarative attributes. Example:: class ProvidesUserMixin: "A mixin that adds a 'user' relationship to classes." user_id: Mapped[int] = mapped_column(ForeignKey("user_table.id")) @declared_attr def user(cls) -> Mapped["User"]: return relationship("User") When used with Declarative directives such as ``__tablename__``, the :meth:`_orm.declared_attr.directive` modifier may be used which indicates to :pep:`484` typing tools that the given method is not dealing with :class:`_orm.Mapped` attributes:: class CreateTableName: @declared_attr.directive def __tablename__(cls) -> str: return cls.__name__.lower() :class:`_orm.declared_attr` can also be applied directly to mapped classes, to allow for attributes that dynamically configure themselves on subclasses when using mapped inheritance schemes. Below illustrates :class:`_orm.declared_attr` to create a dynamic scheme for generating the :paramref:`_orm.Mapper.polymorphic_identity` parameter for subclasses:: class Employee(Base): __tablename__ = "employee" id: Mapped[int] = mapped_column(primary_key=True) type: Mapped[str] = mapped_column(String(50)) @declared_attr.directive def __mapper_args__(cls) -> Dict[str, Any]: if cls.__name__ == "Employee": return { "polymorphic_on": cls.type, "polymorphic_identity": "Employee", } else: return {"polymorphic_identity": cls.__name__} class Engineer(Employee): pass :class:`_orm.declared_attr` supports decorating functions that are explicitly decorated with ``@classmethod``. This is never necessary from a runtime perspective, however may be needed in order to support :pep:`484` typing tools that don't otherwise recognize the decorated function as having class-level behaviors for the ``cls`` parameter:: class SomethingMixin: x: Mapped[int] y: Mapped[int] @declared_attr @classmethod def x_plus_y(cls) -> Mapped[int]: return column_property(cls.x + cls.y) .. versionadded:: 2.0 - :class:`_orm.declared_attr` can accommodate a function decorated with ``@classmethod`` to help with :pep:`484` integration where needed. .. seealso:: :ref:`orm_mixins_toplevel` - Declarative Mixin documentation with background on use patterns for :class:`_orm.declared_attr`. cgrrnrs r[rdeclared_attr.__init__rr]cgrrnrs r[rdeclared_attr.__set__rr]cgrrnrs r[rdeclared_attr.__delete__rr]cgrrnrs r[rdeclared_attr.__get__s),r]cgrrnrs r[rrs?Br]cgrrnrs r[rrs36r]c [S0UD6$Nrn)_stateful_declared_attr)rYrs r[ _statefuldeclared_attr._statefuls&,,,r]c[$r)rrYs r[ directivedeclared_attr.directives #"r]c URSS9$)NT)r)rrs r[rdeclared_attr.cascadings}}t},,r]rnNr)r_DeclaredAttrDecorated[_T]rrrr)rrqrrrpzInstrumentedAttribute[_T])robjectrrrprR)rrrrrpz$Union[InstrumentedAttribute[_T], _T]rrrp_stateful_declared_attr[_T])rpz_declared_directive[Any])rpr)rrrsrtrur{r?rrrrrrr=rr>rrrvrnr]r[rrKsZx $ *   B8  ,  ,), , & ,  , B B 7, 758 7 1 7--##--r]rcH\rSrSr%S\S'S Sjr\S Sj5rS SjrSr g) rizDict[str, Any]rc Xlgrrrrs r[r _stateful_declared_attr.__init__sr]c nURR5nURU5 [S0UD6$r)rcopyupdater)rrnew_kws r[r!_stateful_declared_attr._statefuls+ b&000r]c.[U40URD6$r)rrrs r[r _stateful_declared_attr.__call__sR+477++r]rNrrr)rrrpzdeclared_attr[_T]) rrrsrtrurrr=rrrvrnr]r[rrs&11 ,r]rcU$)aMark a class as providing the feature of "declarative mixin". E.g.:: from sqlalchemy.orm import declared_attr from sqlalchemy.orm import declarative_mixin @declarative_mixin class MyMixin: @declared_attr def __tablename__(cls): return cls.__name__.lower() __table_args__ = {"mysql_engine": "InnoDB"} __mapper_args__ = {"always_refresh": True} id = Column(Integer, primary_key=True) class MyModel(MyMixin, Base): name = Column(String(1000)) The :func:`_orm.declarative_mixin` decorator currently does not modify the given class in any way; it's current purpose is strictly to assist the :ref:`Mypy plugin ` in being able to identify SQLAlchemy declarative mixin classes when no other context is present. .. versionadded:: 1.4.6 .. seealso:: :ref:`orm_mixins_toplevel` :ref:`mypy_declarative_mixins` - in the :ref:`Mypy plugin documentation ` rnrs r[declarative_mixinrs R Jr]cdSUR;aURSnOSnSUR;aURSnOSnURRSS5nUbE[U[5(d[R "S5eUb[R "S5eO[XS9nX0lX0lSUR;aURRUl[US[R5[RLaURRUl gg)Nrtype_annotation_maprzfDeclarative base class has a 'registry' attribute that is not an instance of sqlalchemy.orm.registry()zDeclarative base class has both a 'registry' attribute and a type_annotation_map entry. Per-base type_annotation_maps are not supported. Please apply the type_annotation_map to this registry directly.)rrr) rdrrrr5rrrrXrr constructor)rYrrrs r[_setup_declarative_baser sS\\!<< + ,!ll+@A" ,,  :t ,C #x(())? ! ,))- -  %||,, sJ0FOOC||// Dr]c ^\rSrSrSr\R \R \R \R \R \R \R \R 4SU4SjjjrSrU=r $)MappedAsDataclassi8zMixin class to indicate when mapping this class, also convert it to be a dataclass. .. seealso:: :ref:`orm_declarative_native_dataclasses` - complete background on SQLAlchemy native dataclass mapping .. versionadded:: 2.0 c >UUUUUUUUS.n [US5(aURn [R"U 5 U R 5V V s0sH:upX[ R La U RU [ R 5OU _M< sn n =UlnO U =Uln[TU]$"S0U D6 [U5(d.[R"U5n[R"XU5 ggs sn n f)Ninitrepreqorder unsafe_hash match_argskw_onlydataclass_callable_sa_apply_dc_transformsrn) hasattrrr(_assert_dc_argumentsitemsr9NO_ARGrsuper__init_subclass__r"(_update_annotations_for_non_mapped_class_apply_dataclasses_to_any_class)rYrrrrrrrrrapply_dc_transformscurrentkvcurrent_transformsnew_anno __class__s r[r#MappedAsDataclass.__init_subclass__Es&$"4 4  31 2 211G " 7 7 @0557@7DA4F7;;q&--0AM7@ C '*< $ C '*< !'B'$$&OOH # B B"  %@sAC8rn)rUnion[_NoArg, bool]rr(rr(rr(rr(rr(rr(r'Union[_NoArg, Callable[..., Type[Any]]]rrrprq) rrrsrtrur{r9rrrv __classcell__r&s@r[r r 8s %+MM$*MM"(--%+]]+1==*0--'-}} MM1!1"1 1 # 1 ) 1(1%1 11 11r]r ) metaclassc^\rSrSr%Sr\R (aCSSjrSSjrS\ S'S\ S'S\ S 'S \ S 'S \ S 'S\ S'S\ S'S\ S'S\ S'SSjr SU4Sjjr Sr U=r $)DeclarativeBaseiyaBase class used for declarative class definitions. The :class:`_orm.DeclarativeBase` allows for the creation of new declarative bases in such a way that is compatible with type checkers:: from sqlalchemy.orm import DeclarativeBase class Base(DeclarativeBase): pass The above ``Base`` class is now usable as the base for new declarative mappings. The superclass makes use of the ``__init_subclass__()`` method to set up new classes and metaclasses aren't used. When first used, the :class:`_orm.DeclarativeBase` class instantiates a new :class:`_orm.registry` to be used with the base, assuming one was not provided explicitly. The :class:`_orm.DeclarativeBase` class supports class-level attributes which act as parameters for the construction of this registry; such as to indicate a specific :class:`_schema.MetaData` collection as well as a specific value for :paramref:`_orm.registry.type_annotation_map`:: from typing_extensions import Annotated from sqlalchemy import BigInteger from sqlalchemy import MetaData from sqlalchemy import String from sqlalchemy.orm import DeclarativeBase bigint = Annotated[int, "bigint"] my_metadata = MetaData() class Base(DeclarativeBase): metadata = my_metadata type_annotation_map = { str: String().with_variant(String(255), "mysql", "mariadb"), bigint: BigInteger(), } Class-level attributes which may be specified include: :param metadata: optional :class:`_schema.MetaData` collection. If a :class:`_orm.registry` is constructed automatically, this :class:`_schema.MetaData` collection will be used to construct it. Otherwise, the local :class:`_schema.MetaData` collection will supercede that used by an existing :class:`_orm.registry` passed using the :paramref:`_orm.DeclarativeBase.registry` parameter. :param type_annotation_map: optional type annotation map that will be passed to the :class:`_orm.registry` as :paramref:`_orm.registry.type_annotation_map`. :param registry: supply a pre-existing :class:`_orm.registry` directly. .. versionadded:: 2.0 Added :class:`.DeclarativeBase`, so that declarative base classes may be constructed in such a way that is also recognized by :pep:`484` type checkers. As a result, :class:`.DeclarativeBase` and other subclassing-oriented APIs should be seen as superseding previous "class returned by a function" APIs, namely :func:`_orm.declarative_base` and :meth:`_orm.registry.generate_base`, where the base class returned cannot be recognized by type checkers without using plugins. **__init__ behavior** In a plain Python class, the base-most ``__init__()`` method in the class hierarchy is ``object.__init__()``, which accepts no arguments. However, when the :class:`_orm.DeclarativeBase` subclass is first declared, the class is given an ``__init__()`` method that links to the :paramref:`_orm.registry.constructor` constructor function, if no ``__init__()`` method is already present; this is the usual declarative constructor that will assign keyword arguments as attributes on the instance, assuming those attributes are established at the class level (i.e. are mapped, or are linked to a descriptor). This constructor is **never accessed by a mapped class without being called explicitly via super()**, as mapped classes are themselves given an ``__init__()`` method directly which calls :paramref:`_orm.registry.constructor`, so in the default case works independently of what the base-most ``__init__()`` method does. .. versionchanged:: 2.0.1 :class:`_orm.DeclarativeBase` has a default constructor that links to :paramref:`_orm.registry.constructor` by default, so that calls to ``super().__init__()`` can access this constructor. Previously, due to an implementation mistake, this default constructor was missing, and calling ``super().__init__()`` would invoke ``object.__init__()``. The :class:`_orm.DeclarativeBase` subclass may also declare an explicit ``__init__()`` method which will replace the use of the :paramref:`_orm.registry.constructor` function at this level:: class Base(DeclarativeBase): def __init__(self, id=None): self.id = id Mapped classes still will not invoke this constructor implicitly; it remains only accessible by calling ``super().__init__()``:: class MyClass(Base): def __init__(self, id=None, name=None): self.name = name super().__init__(id=id) Note that this is a different behavior from what functions like the legacy :func:`_orm.declarative_base` would do; the base created by those functions would always install :paramref:`_orm.registry.constructor` for ``__init__()``. cgrrnrs r[_sa_inspect_type DeclarativeBase._sa_inspect_typeCr]cgrrnrs r[_sa_inspect_instance$DeclarativeBase._sa_inspect_instancesr]ClassVar[_RegistryType]rrClassVar[MetaData]rz ClassVar[str]rrClassVar[Mapper[Any]]rczClassVar[FromClause]rVr __tablename____mapper_args____table_args__c grrnrs r[rDeclarativeBase.__init__Csr]c >[UR;a[U[5 [U5 O [ UR XR 5 [TU] "S0UD6 gr) r. __bases___check_not_declarativer r'rrdrrrYrr&s r[r!DeclarativeBase.__init_subclass__EsE cmm + "3 8 #C ( C,,c<< @ !'B'r]rnrpz Mapper[Self]rpzInstanceState[Self]rrrrprq)rrrsrtrur{r?rr0r4rrrrvr*r+s@r[r.r.ys n`7B--)) <%$   *) ('     +((r]r.c URnSU;a'[US5(d[USS5(a%[UR SS5[ 5(a%[ R"SUR<S35eg)NrVrr:z Cannot use zR directly as a declarative base class. Create a Base by creating a subclass of it.) rdcallablerrrror5rrr)rYbasecls_dicts r[rBrBNs}||Hx Xk* + +x ,i88 HLL$7 = =%%$--*+A A   >r]c^\rSrSr%SrS\S'S\S'S\S'S\S 'S \S '\R(a!SS jrSS jr S\S'S\S'S\S'SSjr SU4Sjjr Sr U=r $)DeclarativeBaseNoMetai]zSame as :class:`_orm.DeclarativeBase`, but does not use a metaclass to intercept new attributes. The :class:`_orm.DeclarativeBaseNoMeta` base may be used when use of custom metaclasses is desirable. .. versionadded:: 2.0 r7rrr8rr9rcOptional[FromClause]rVcgrrnrs r[r0&DeclarativeBaseNoMeta._sa_inspect_typer2r]cgrrnrs r[r4*DeclarativeBaseNoMeta._sa_inspect_instancer6r]rr:r;r<c grrnrs r[rDeclarativeBaseNoMeta.__init__r?r]c >[UR;a[U[5 [U5 O [ UR XR 5 [TU] "S0UD6 gr) rMrArBr r'rrdrrrCs r[r'DeclarativeBaseNoMeta.__init_subclass__sF CMM 1 "3(= > #C ( C,,c<< @ !'B'r]rnrErFrrG)rrrsrtrur{rr?rr0r4rrrvr*r+s@r[rMrM]s *)%%8! &%$# 7B    +((r]rMc[XU5 g)aAdd a new mapped attribute to an ORM mapped class. E.g.:: add_mapped_attribute(User, "addresses", relationship(Address)) This may be used for ORM mappings that aren't using a declarative metaclass that intercepts attribute set operations. .. versionadded:: 2.0 Nr%)targetrgattrs r[add_mapped_attributerZs 6%r]BasermapperrYrclass_registryrr r,c:[UUUUS9RUUUUS9$)a Construct a base class for declarative class definitions. The new base class will be given a metaclass that produces appropriate :class:`~sqlalchemy.schema.Table` objects and makes the appropriate :class:`_orm.Mapper` calls based on the information provided declaratively in the class and any subclasses of the class. .. versionchanged:: 2.0 Note that the :func:`_orm.declarative_base` function is superseded by the new :class:`_orm.DeclarativeBase` class, which generates a new "base" class using subclassing, rather than return value of a function. This allows an approach that is compatible with :pep:`484` typing tools. The :func:`_orm.declarative_base` function is a shorthand version of using the :meth:`_orm.registry.generate_base` method. That is, the following:: from sqlalchemy.orm import declarative_base Base = declarative_base() Is equivalent to:: from sqlalchemy.orm import registry mapper_registry = registry() Base = mapper_registry.generate_base() See the docstring for :class:`_orm.registry` and :meth:`_orm.registry.generate_base` for more details. .. versionchanged:: 1.4 The :func:`_orm.declarative_base` function is now a specialization of the more generic :class:`_orm.registry` class. The function also moves to the ``sqlalchemy.orm`` package from the ``declarative.ext`` package. :param metadata: An optional :class:`~sqlalchemy.schema.MetaData` instance. All :class:`~sqlalchemy.schema.Table` objects implicitly declared by subclasses of the base will share this MetaData. A MetaData instance will be created if none is provided. The :class:`~sqlalchemy.schema.MetaData` instance will be available via the ``metadata`` attribute of the generated declarative base class. :param mapper: An optional callable, defaults to :class:`_orm.Mapper`. Will be used to map subclasses to their Tables. :param cls: Defaults to :class:`object`. A type to use as the base for the generated declarative base class. May be a class or tuple of classes. :param name: Defaults to ``Base``. The display name for the generated class. Customizing this is not required, but can improve clarity in tracebacks and debugging. :param constructor: Specify the implementation for the ``__init__`` function on a mapped class that has no ``__init__`` of its own. Defaults to an implementation that assigns \**kwargs for declared fields and relationships to an instance. If ``None`` is supplied, no __init__ will be provided and construction will fall back to cls.__init__ by way of the normal Python semantics. :param class_registry: optional dictionary that will serve as the registry of class names-> mapped classes when string names are used to identify classes inside of :func:`_orm.relationship` and others. Allows two or more declarative base classes to share the same registry of class names for simplified inter-base relationships. :param type_annotation_map: optional dictionary of Python types to SQLAlchemy :class:`_types.TypeEngine` classes or instances. This is used exclusively by the :class:`_orm.MappedColumn` construct to produce column types based on annotations within the :class:`_orm.Mapped` type. .. versionadded:: 2.0 .. seealso:: :ref:`orm_declarative_mapped_column_type_map` :param metaclass: Defaults to :class:`.DeclarativeMeta`. A metaclass or __metaclass__ compatible callable to use as the meta type of the generated declarative base class. .. seealso:: :class:`_orm.registry` )rr^r r)r]rYrr,)r generate_baser\s r[declarative_baseras;\ %/   m    r]c f\rSrSr%SrS\S'S\S'S\S'S \S 'S \S 'S \S'S\S'S\S'S\S'SSS\S.S2SjjrS3SjrS4S5Sjjr \ S6Sj5r S7Sjr S8Sjr \S9Sj5r\S9Sj5rS:SjrS;SjrSS?S"jjrS>S?S#jjrS=S$jrS\S%\4S@S&jjr\R8"\\\\ \!\"\#\$\%4 S'9\&SAS(j55r'\&SBS)S)S)S)S)S)S)S)S*.SCS+jjj5r'SD\(RR\(RR\(RR\(RR\(RR\(RR\(RR\(RRS*.SES,jjjr'SFS-jr*SGS.jr+SHS/jr,SDSIS0jjr-S1r.g)JriVa\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. zclsregistry._ClsRegistryType_class_registryz;weakref.WeakKeyDictionary[ClassManager[Any], Literal[True]] _managersz5weakref.WeakKeyDictionary[Mapper[Any], Literal[True]]_non_primary_mappersr;rz&CallableReference[Callable[..., None]]r _MutableTypeAnnotationMapTyperzSet[_RegistryType] _dependents _dependenciesr _new_mappersN)rr^rr cU=(d [5nUc[R"5nX l[R"5Ul[R"5UlXPlX@l0Ul UbURU5 [5Ul [5Ul SUl[R  S[R"U'SSS5 g!,(df  g=f)aConstruct a new :class:`_orm.registry` :param metadata: An optional :class:`_schema.MetaData` instance. All :class:`_schema.Table` objects generated using declarative table mapping will make use of this :class:`_schema.MetaData` collection. If this argument is left at its default of ``None``, a blank :class:`_schema.MetaData` collection is created. :param constructor: Specify the implementation for the ``__init__`` function on a mapped class that has no ``__init__`` of its own. Defaults to an implementation that assigns \**kwargs for declared fields and relationships to an instance. If ``None`` is supplied, no __init__ will be provided and construction will fall back to cls.__init__ by way of the normal Python semantics. :param class_registry: optional dictionary that will serve as the registry of class names-> mapped classes when string names are used to identify classes inside of :func:`_orm.relationship` and others. Allows two or more declarative base classes to share the same registry of class names for simplified inter-base relationships. :param type_annotation_map: optional dictionary of Python types to SQLAlchemy :class:`_types.TypeEngine` classes or instances. The provided dict will update the default type mapping. This is used exclusively by the :class:`_orm.MappedColumn` construct to produce column types based on annotations within the :class:`_orm.Mapped` type. .. versionadded:: 2.0 .. seealso:: :ref:`orm_declarative_mapped_column_type_map` NFT)r;weakrefWeakValueDictionaryrcWeakKeyDictionaryrdrerr rupdate_type_annotation_mapsetrgrhrir_CONFIGURE_MUTEX_mapper_registries)rrr^rr  lcl_metadatas r[rregistry.__init__s^ -8:  !$88:N- 224$+$=$=$?!$ &#%  *  + +,? @5 U!  ' '15I ( ( .( ' 's C C-c URRUR5VVs0sHup#[U5U_M snn5 gs snnf)zIupdate the :paramref:`_orm.registry.type_annotation_map` with new values.N)rrrrB)rrtypsqltypes r[rn#registry.update_type_annotation_mapsO   ''%8$=$=$? $?LC+3/8$?   sA c6^ [U5(a;[U5(aUm UT 4/U 4Sj[5Q7nODURm UT 44nO2[ U[ 5(aUm ST R 5nOUm UT 44nUHnupEURRU5nUc[R"U5nUcM>[R"U5nURT UU5nUcMlUs $ U(aSn Sn [U5(a=Un [U 5(aU Rn [U 5(aM[U 5n Sn [!U5(a [#U5n Sn U b/UR%U S5n U bU ce['SU SUS3S 5 U $g) Nc3*># UHoT4v M g7frrn).0ltpython_type_types r[ )registry._resolve_type..sE}+,}sc3(# UHoU4v M g7frrn)rzpts r[r}r~sB)A22h)As TypeAliasTypeNewTypeFzMatching the provided z 'z' on its resolved value without matching it in the type_annotation_map is deprecated; add this type to the type_annotation_map to allow it to match explicitly.z2.0)rDrErI __origin__rrerWrrr8 _type_map_get to_instance_resolve_for_python_typerG __value__rBrFrC _resolve_typer@) r python_type _do_fallbackssearchr flattenedsql_type sql_type_instresolved_sql_typepython_type_to_checkkindres_after_fallbackr|s @r[rregistry._resolve_types k " "+&&#. !"23E}E $/#9#9 &(89;  T * ** B)9)A)ABF* "$457F#MB//33B7H#11"5# ( 4 4X > %2$J$J$%! %0,,)$. (, D%%'2$ 455+?+I+I( 455'A(($'+&&'6{'C$ #/%)%7%7(%&"&1+++#0b F&&  .-r]cl[SUR55RUR5$)z9read only collection of all :class:`_orm.Mapper` objects.c38# UHoRv M g7fr)r]rzrs r[r}#registry.mappers..(sF~G~s) frozensetrdunionrers r[mappersregistry.mappers$s/Ft~~FFLL  % %  r]czXLagURRU5 URRU5 gr)rgaddrh)rrs r[_set_depends_onregistry._set_depends_on,s3     & x(r]cvSUlUR(agURU15H nSUlM gNT)_ready_for_configureri_recurse_with_dependents)rr]rs r[_flag_new_mapperregistry._flag_new_mapper2s5&*#    00$8C#C 9r]c#8# Un[5nU(aUR5nURU5 URURR U55 Uv URURR U55 U(aMgg7fr)ropoprrrg differencerY registriestododoners r[r!registry._recurse_with_dependents:sru((*C HHSM KK2248 9I KK2248 9d BBBc#8# Un[5nU(aUR5nURU5 URURR U55 Uv URURR U55 U(aMgg7fr)rorrrrhrrs r[_recurse_with_dependencies#registry._recurse_with_dependenciesMsvu((*C HHSM KK))44T: ;I KK))44T: ;drc[R"S[UR55S[UR555$)Nc3# UH^nUR(dMURR(aM3URR(dMPURv M` g7fr)rr] configuredrrs r[r}1registry._mappers_to_configure..csN 3G$$ 11NN77 3sA(A(A(A(c3r# UH-nUR(aMUR(dM)Uv M/ g7fr)rr)rznpms r[r}rjs. :C~~*-*B*B:s 77 7) itertoolschainlistrdrers r[_mappers_to_configureregistry._mappers_to_configureasA #DNN3   9 9:   r]c"SURU'gr)re)r np_mappers r[_add_non_primary_mapper registry._add_non_primary_mapperqs/3!!),r]cZ[R"URXR5 gr)r remove_classrrrcrrYs r[ _dispose_clsregistry._dispose_clsts  s4H4HIr]cSURU'UR(a#[R"SUR-5eUR beXlg)NTz1Class '%s' already has a primary mapper defined. )rdrr5 ArgumentErrorrZr)rrs r[ _add_managerregistry._add_managerwsU"&w   ##C..! '''r]c0[R"U1US9 g)auConfigure all as-yet unconfigured mappers in this :class:`_orm.registry`. The configure step is used to reconcile and initialize the :func:`_orm.relationship` linkages between mapped classes, as well as to invoke configuration events such as the :meth:`_orm.MapperEvents.before_configured` and :meth:`_orm.MapperEvents.after_configured`, which may be used by ORM extensions or user-defined extension hooks. If one or more mappers in this registry contain :func:`_orm.relationship` constructs that refer to mapped classes in other registries, this registry is said to be *dependent* on those registries. In order to configure those dependent registries automatically, the :paramref:`_orm.registry.configure.cascade` flag should be set to ``True``. Otherwise, if they are not configured, an exception will be raised. The rationale behind this behavior is to allow an application to programmatically invoke configuration of registries while controlling whether or not the process implicitly reaches other registries. As an alternative to invoking :meth:`_orm.registry.configure`, the ORM function :func:`_orm.configure_mappers` function may be used to ensure configuration is complete for all :class:`_orm.registry` objects in memory. This is generally simpler to use and also predates the usage of :class:`_orm.registry` objects overall. However, this function will impact all mappings throughout the running Python process and may be more memory/time consuming for an application that has many registries in use for different purposes that may not be needed immediately. .. seealso:: :func:`_orm.configure_mappers` .. versionadded:: 1.4.0b2 cascadeN)r_configure_registriesrrs r[ configureregistry.configuresN ''@r]c0[R"U1US9 g)a6Dispose of all mappers in this :class:`_orm.registry`. After invocation, all the classes that were mapped within this registry will no longer have class instrumentation associated with them. This method is the per-:class:`_orm.registry` analogue to the application-wide :func:`_orm.clear_mappers` function. If this registry contains mappers that are dependencies of other registries, typically via :func:`_orm.relationship` links, then those registries must be disposed as well. When such registries exist in relation to this one, their :meth:`_orm.registry.dispose` method will also be called, if the :paramref:`_orm.registry.dispose.cascade` flag is set to ``True``; otherwise, an error is raised if those registries were not already disposed. .. versionadded:: 1.4.0b2 .. seealso:: :func:`_orm.clear_mappers` rN)r_dispose_registriesrs r[disposeregistry.disposes0 %%tfg>r]cSUR;aURnUR5 URnUR U5 [ R RU5 g)Nr])rdr]_set_dispose_flagsrZrr_instrumentation_factory unregister)rrr]rZs r[_dispose_manager_and_mapper$registry._dispose_manager_and_mappersP w'' '^^F  % % ' &!00;;FCr]r[cbURn[U[5(+=(a U4=(d Un[XS9n[U[5(aUR US'UR bUR US'SUS'U(aXS'[US5(a S SjnXS'U"X6U5$) aOGenerate a declarative base class. Classes that inherit from the returned class object will be automatically mapped using declarative mapping. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() Base = mapper_registry.generate_base() class MyClass(Base): __tablename__ = "my_table" id = Column(Integer, primary_key=True) The above dynamically generated class is equivalent to the non-dynamic example below:: from sqlalchemy.orm import registry from sqlalchemy.orm.decl_api import DeclarativeMeta mapper_registry = registry() class Base(metaclass=DeclarativeMeta): __abstract__ = True registry = mapper_registry metadata = mapper_registry.metadata __init__ = mapper_registry.constructor .. versionchanged:: 2.0 Note that the :meth:`_orm.registry.generate_base` method is superseded by the new :class:`_orm.DeclarativeBase` class, which generates a new "base" class using subclassing, rather than return value of a function. This allows an approach that is compatible with :pep:`484` typing tools. The :meth:`_orm.registry.generate_base` method provides the implementation for the :func:`_orm.declarative_base` function, which creates the :class:`_orm.registry` and base class all at once. See the section :ref:`orm_declarative_mapping` for background and examples. :param mapper: An optional callable, defaults to :class:`_orm.Mapper`. This function is used to generate new :class:`_orm.Mapper` objects. :param cls: Defaults to :class:`object`. A type to use as the base for the generated declarative base class. May be a class or tuple of classes. :param name: Defaults to ``Base``. The display name for the generated class. Customizing this is not required, but can improve clarity in tracebacks and debugging. :param metaclass: Defaults to :class:`.DeclarativeMeta`. A metaclass or __metaclass__ compatible callable to use as the meta type of the generated declarative base class. .. seealso:: :ref:`orm_declarative_mapping` :func:`_orm.declarative_base` )rrr{rTr__mapper_cls____class_getitem__cU$rrnrls r[r1registry.generate_base..__class_getitem__/s r])rYType[_T]rgrrpr)rrtupledictrer{r r) rr]rYrr,rr class_dictrs r[r`registry.generate_bases`==sE**5v<%)4%K c4 $'KKJy !    '%)%5%5Jz "%) >" +1' ( 3+ , , /@* +j11r]r|cgrrn)r_registry__clss r[mapped_as_dataclassregistry.mapped_as_dataclass7s ADr].rcgrrn) rrrrrrrrrrs r[rrGs*-r]c V^^^^^^^^^ SU UUUUUUUU4 Sjjn U(aU "U5$U $)a'Class decorator that will apply the Declarative mapping process to a given class, and additionally convert the class to be a Python dataclass. .. seealso:: :ref:`orm_declarative_native_dataclasses` - complete background on SQLAlchemy native dataclass mapping .. versionadded:: 2.0 c `> [USTTTTT TTTS.5 [TXR5 U$)Nrr)setattrr'rd) rYrrrrrrrrrs r[r.registry.mapped_as_dataclass..decoratetsC )  "#.",&*<   D#|| 4Jr]rYType[_O]rprrn) rrrrrrrrrrrs ` ```````` r[rrVs"<  $ E? "Or]c2[XUR5 U$)aClass decorator that will apply the Declarative mapping process to a given class. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() @mapper_registry.mapped class Foo: __tablename__ = "some_table" id = Column(Integer, primary_key=True) name = Column(String) See the section :ref:`orm_declarative_mapping` for complete details and examples. :param cls: class to be mapped. :return: the class that was passed. .. seealso:: :ref:`orm_declarative_mapping` :meth:`_orm.registry.generate_base` - generates a base class that will apply Declarative mapping to subclasses automatically using a Python metaclass. .. seealso:: :meth:`_orm.registry.mapped_as_dataclass` )r'rdrs r[mappedregistry.mappedsL 3<<0 r]c ^^SUU4SjjnU$)a( Class decorator which will invoke :meth:`_orm.registry.generate_base` for a given base class. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() @mapper_registry.as_declarative_base() class Base: @declared_attr def __tablename__(cls): return cls.__name__.lower() id = Column(Integer, primary_key=True) class MyMappedClass(Base): ... All keyword arguments passed to :meth:`_orm.registry.as_declarative_base` are passed along to :meth:`_orm.registry.generate_base`. cP>UTS'URTS'TR"S0TD6$)NrYrrn)rrr`)rYrrs r[r.registry.as_declarative_base..decorates-BuIBvJ%%++ +r]rYrrprrn)rrrs`` r[as_declarative_baseregistry.as_declarative_bases< , , r]cF[XUR5 UR$)aMap a class declaratively. In this form of mapping, the class is scanned for mapping information, including for columns to be associated with a table, and/or an actual table object. Returns the :class:`_orm.Mapper` object. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() class Foo: __tablename__ = "some_table" id = Column(Integer, primary_key=True) name = Column(String) mapper = mapper_registry.map_declaratively(Foo) This function is more conveniently invoked indirectly via either the :meth:`_orm.registry.mapped` class decorator or by subclassing a declarative metaclass generated from :meth:`_orm.registry.generate_base`. See the section :ref:`orm_declarative_mapping` for complete details and examples. :param cls: class to be mapped. :return: a :class:`_orm.Mapper` object. .. seealso:: :ref:`orm_declarative_mapping` :meth:`_orm.registry.mapped` - more common decorator interface to this function. :meth:`_orm.registry.map_imperatively` )r'rdrcrs r[map_declarativelyregistry.map_declarativelys^ 3<<0~~r]c [XX#5$)aMap a class imperatively. In this form of mapping, the class is not scanned for any mapping information. Instead, all mapping constructs are passed as arguments. This method is intended to be fully equivalent to the now-removed SQLAlchemy ``mapper()`` function, except that it's in terms of a particular registry. E.g.:: from sqlalchemy.orm import registry mapper_registry = registry() my_table = Table( "my_table", mapper_registry.metadata, Column("id", Integer, primary_key=True), ) class MyClass: pass mapper_registry.map_imperatively(MyClass, my_table) See the section :ref:`orm_imperative_mapping` for complete background and usage examples. :param class\_: The class to be mapped. Corresponds to the :paramref:`_orm.Mapper.class_` parameter. :param local_table: the :class:`_schema.Table` or other :class:`_sql.FromClause` object that is the subject of the mapping. Corresponds to the :paramref:`_orm.Mapper.local_table` parameter. :param \**kw: all other keyword arguments are passed to the :class:`_orm.Mapper` constructor directly. .. seealso:: :ref:`orm_imperative_mapping` :ref:`orm_declarative_mapping` r,)rrZ local_tablers r[map_imperativelyregistry.map_imperatively spt[55r]) rcrhrgrdrirer rr)rOptional[MetaData]r^&Optional[clsregistry._ClsRegistryType]r Optional[_TypeAnnotationMapType]r Callable[..., None])r_TypeAnnotationMapTyperprq)T)rrQrrrpz"Optional[sqltypes.TypeEngine[Any]])rpzFrozenSet[Mapper[Any]])rrrprq)r] Mapper[Any]rprq)rzSet[RegistryType]rpzIterator[RegistryType])rpzIterator[Mapper[Any]])rrrprq)rYrrprq)rzClassManager[Any]rprqr)rrrprq) r]$Optional[Callable[..., Mapper[Any]]]rY Type[Any]rror,rrpr)rrrpr).)rz Literal[None]rr(rr(rr(rr(rr(rr(rr(rr)rpzCallable[[Type[_O]], Type[_O]]r)rzOptional[Type[_O]]rr(rr(rr(rr(rr(rr(rr(rr)rpz/Union[Type[_O], Callable[[Type[_O]], Type[_O]]]rrrrpzCallable[[Type[_T]], Type[_T]])rYrrp Mapper[_O])rZrrrNrrrpr )/rrrsrtrur{rr)rrnrpropertyrrrrrrrrrrrrrrrr` compat_typingdataclass_transformr1r2r.r/rrrrrrrr9rrrrrrvrnr]r[rrVsn@21JJOO7766##%% (,AE@D+C B6%B6? B6 > B6 ) B6H  3     BFO)O:>O +Ob  ) $:*: ::$<*< <<& 4J 'AR?4D8<. g24g2g2 g2  g2 g2R&&           C D  # -%($'"%%(+.*-'*FI - -" - " - -# -) -( -% -D - ( - - %)3%+MM$*MM"(--%+]]+1==*0--'-}} MM3!3" 3 " 3 3#3)3(3%3 3 93j'R#J0j-18686*86 86  8686r]rc zURSS5URSS5p![XS9R"S0UD6$)aS Class decorator which will adapt a given class into a :func:`_orm.declarative_base`. This function makes use of the :meth:`_orm.registry.as_declarative_base` method, by first creating a :class:`_orm.registry` automatically and then invoking the decorator. E.g.:: from sqlalchemy.orm import as_declarative @as_declarative() class Base: @declared_attr def __tablename__(cls): return cls.__name__.lower() id = Column(Integer, primary_key=True) class MyMappedClass(Base): ... .. seealso:: :meth:`_orm.registry.as_declarative_base` rNr^)rr^rn)rrr)rrr^s r[as_declarativerMsP> z4  &      r]c[U5nUc1[R"U5(a[R"U5 U$r)r!r*has_clsraise_unmapped_for_cls)rYmps r[_inspect_decl_metarus7!6c :B z ( ( - - ! 8 8 = Ir])rYrrprr)rrorrrpz,Callable[[Callable[..., Any]], Synonym[Any]]r)rYrrprq)rYrrJrrprq)rXrrgrorYzMapperProperty[Any]rprq)rrr]rrYrrror^rrrr rr,rrprr)rYrrpzOptional[Mapper[Any]])r{ __future__rrrr?rrrrrr r r r r rrrrrrrrkrrrrr_orm_constructorsrrrrrr rJr!r"r#r$ decl_baser&r'r(r)r*r+r-descriptor_propsr.r/rr]r0 propertiesr1 relationshipsr2stater3r5r6r7sqlr8sql.baser9 sql.elementsr: sql.schemar;sql.selectabler<r=r>r r@ util.typingrArBrCrDrErFrGrHrIrJ_typingrKrLrMrNrO sql._typingrP sql.type_apirQrRrTrrf_DeclaredAttrDecoratedr\rer_ Inspectablerxr rrrrr_MappedAttributerrrr r r.rBrMrZrrarrr _inspectsrrnr]r[r)s8"  (',+&-'"%&-/,%'%5$/ ,!'!*"+4)$$$#!'&.-*$1- T e3!&@!@A $S*D%D E!vbz=,.?.CC DD & 'T ' 6#;' ""  8:8 8434>#(' ''1'T>>B/,E-J//35JE-P ,mB/ , )X&0R>"8>BR(=-.+R(j  h(=-.h(V& &&&9& &*$(37=A<@'?*x x 1x  x  x ; x:x%xx xvm 6m 6` M% P _&Cr]