__init__.py 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. # orm/__init__.py
  2. # Copyright (C) 2005-2025 the SQLAlchemy authors and contributors
  3. # <see AUTHORS file>
  4. #
  5. # This module is part of SQLAlchemy and is released under
  6. # the MIT License: https://www.opensource.org/licenses/mit-license.php
  7. """
  8. Functional constructs for ORM configuration.
  9. See the SQLAlchemy object relational tutorial and mapper configuration
  10. documentation for an overview of how this module is used.
  11. """
  12. from __future__ import annotations
  13. from typing import Any
  14. from . import exc as exc
  15. from . import mapper as mapperlib
  16. from . import strategy_options as strategy_options
  17. from ._orm_constructors import _mapper_fn as mapper
  18. from ._orm_constructors import aliased as aliased
  19. from ._orm_constructors import backref as backref
  20. from ._orm_constructors import clear_mappers as clear_mappers
  21. from ._orm_constructors import column_property as column_property
  22. from ._orm_constructors import composite as composite
  23. from ._orm_constructors import contains_alias as contains_alias
  24. from ._orm_constructors import create_session as create_session
  25. from ._orm_constructors import deferred as deferred
  26. from ._orm_constructors import dynamic_loader as dynamic_loader
  27. from ._orm_constructors import join as join
  28. from ._orm_constructors import mapped_column as mapped_column
  29. from ._orm_constructors import orm_insert_sentinel as orm_insert_sentinel
  30. from ._orm_constructors import outerjoin as outerjoin
  31. from ._orm_constructors import query_expression as query_expression
  32. from ._orm_constructors import relationship as relationship
  33. from ._orm_constructors import synonym as synonym
  34. from ._orm_constructors import with_loader_criteria as with_loader_criteria
  35. from ._orm_constructors import with_polymorphic as with_polymorphic
  36. from .attributes import AttributeEventToken as AttributeEventToken
  37. from .attributes import InstrumentedAttribute as InstrumentedAttribute
  38. from .attributes import QueryableAttribute as QueryableAttribute
  39. from .base import class_mapper as class_mapper
  40. from .base import DynamicMapped as DynamicMapped
  41. from .base import InspectionAttrExtensionType as InspectionAttrExtensionType
  42. from .base import LoaderCallableStatus as LoaderCallableStatus
  43. from .base import Mapped as Mapped
  44. from .base import NotExtension as NotExtension
  45. from .base import ORMDescriptor as ORMDescriptor
  46. from .base import PassiveFlag as PassiveFlag
  47. from .base import SQLORMExpression as SQLORMExpression
  48. from .base import WriteOnlyMapped as WriteOnlyMapped
  49. from .context import FromStatement as FromStatement
  50. from .context import QueryContext as QueryContext
  51. from .decl_api import add_mapped_attribute as add_mapped_attribute
  52. from .decl_api import as_declarative as as_declarative
  53. from .decl_api import declarative_base as declarative_base
  54. from .decl_api import declarative_mixin as declarative_mixin
  55. from .decl_api import DeclarativeBase as DeclarativeBase
  56. from .decl_api import DeclarativeBaseNoMeta as DeclarativeBaseNoMeta
  57. from .decl_api import DeclarativeMeta as DeclarativeMeta
  58. from .decl_api import declared_attr as declared_attr
  59. from .decl_api import has_inherited_table as has_inherited_table
  60. from .decl_api import MappedAsDataclass as MappedAsDataclass
  61. from .decl_api import registry as registry
  62. from .decl_api import synonym_for as synonym_for
  63. from .decl_base import MappedClassProtocol as MappedClassProtocol
  64. from .descriptor_props import Composite as Composite
  65. from .descriptor_props import CompositeProperty as CompositeProperty
  66. from .descriptor_props import Synonym as Synonym
  67. from .descriptor_props import SynonymProperty as SynonymProperty
  68. from .dynamic import AppenderQuery as AppenderQuery
  69. from .events import AttributeEvents as AttributeEvents
  70. from .events import InstanceEvents as InstanceEvents
  71. from .events import InstrumentationEvents as InstrumentationEvents
  72. from .events import MapperEvents as MapperEvents
  73. from .events import QueryEvents as QueryEvents
  74. from .events import SessionEvents as SessionEvents
  75. from .identity import IdentityMap as IdentityMap
  76. from .instrumentation import ClassManager as ClassManager
  77. from .interfaces import EXT_CONTINUE as EXT_CONTINUE
  78. from .interfaces import EXT_SKIP as EXT_SKIP
  79. from .interfaces import EXT_STOP as EXT_STOP
  80. from .interfaces import InspectionAttr as InspectionAttr
  81. from .interfaces import InspectionAttrInfo as InspectionAttrInfo
  82. from .interfaces import MANYTOMANY as MANYTOMANY
  83. from .interfaces import MANYTOONE as MANYTOONE
  84. from .interfaces import MapperProperty as MapperProperty
  85. from .interfaces import NO_KEY as NO_KEY
  86. from .interfaces import NO_VALUE as NO_VALUE
  87. from .interfaces import ONETOMANY as ONETOMANY
  88. from .interfaces import PropComparator as PropComparator
  89. from .interfaces import RelationshipDirection as RelationshipDirection
  90. from .interfaces import UserDefinedOption as UserDefinedOption
  91. from .loading import merge_frozen_result as merge_frozen_result
  92. from .loading import merge_result as merge_result
  93. from .mapped_collection import attribute_keyed_dict as attribute_keyed_dict
  94. from .mapped_collection import (
  95. attribute_mapped_collection as attribute_mapped_collection,
  96. )
  97. from .mapped_collection import column_keyed_dict as column_keyed_dict
  98. from .mapped_collection import (
  99. column_mapped_collection as column_mapped_collection,
  100. )
  101. from .mapped_collection import keyfunc_mapping as keyfunc_mapping
  102. from .mapped_collection import KeyFuncDict as KeyFuncDict
  103. from .mapped_collection import mapped_collection as mapped_collection
  104. from .mapped_collection import MappedCollection as MappedCollection
  105. from .mapper import configure_mappers as configure_mappers
  106. from .mapper import Mapper as Mapper
  107. from .mapper import reconstructor as reconstructor
  108. from .mapper import validates as validates
  109. from .properties import ColumnProperty as ColumnProperty
  110. from .properties import MappedColumn as MappedColumn
  111. from .properties import MappedSQLExpression as MappedSQLExpression
  112. from .query import AliasOption as AliasOption
  113. from .query import Query as Query
  114. from .relationships import foreign as foreign
  115. from .relationships import Relationship as Relationship
  116. from .relationships import RelationshipProperty as RelationshipProperty
  117. from .relationships import remote as remote
  118. from .scoping import QueryPropertyDescriptor as QueryPropertyDescriptor
  119. from .scoping import scoped_session as scoped_session
  120. from .session import close_all_sessions as close_all_sessions
  121. from .session import make_transient as make_transient
  122. from .session import make_transient_to_detached as make_transient_to_detached
  123. from .session import object_session as object_session
  124. from .session import ORMExecuteState as ORMExecuteState
  125. from .session import Session as Session
  126. from .session import sessionmaker as sessionmaker
  127. from .session import SessionTransaction as SessionTransaction
  128. from .session import SessionTransactionOrigin as SessionTransactionOrigin
  129. from .state import AttributeState as AttributeState
  130. from .state import InstanceState as InstanceState
  131. from .strategy_options import contains_eager as contains_eager
  132. from .strategy_options import defaultload as defaultload
  133. from .strategy_options import defer as defer
  134. from .strategy_options import immediateload as immediateload
  135. from .strategy_options import joinedload as joinedload
  136. from .strategy_options import lazyload as lazyload
  137. from .strategy_options import Load as Load
  138. from .strategy_options import load_only as load_only
  139. from .strategy_options import noload as noload
  140. from .strategy_options import raiseload as raiseload
  141. from .strategy_options import selectin_polymorphic as selectin_polymorphic
  142. from .strategy_options import selectinload as selectinload
  143. from .strategy_options import subqueryload as subqueryload
  144. from .strategy_options import undefer as undefer
  145. from .strategy_options import undefer_group as undefer_group
  146. from .strategy_options import with_expression as with_expression
  147. from .unitofwork import UOWTransaction as UOWTransaction
  148. from .util import Bundle as Bundle
  149. from .util import CascadeOptions as CascadeOptions
  150. from .util import LoaderCriteriaOption as LoaderCriteriaOption
  151. from .util import object_mapper as object_mapper
  152. from .util import polymorphic_union as polymorphic_union
  153. from .util import was_deleted as was_deleted
  154. from .util import with_parent as with_parent
  155. from .writeonly import WriteOnlyCollection as WriteOnlyCollection
  156. from .. import util as _sa_util
  157. def __go(lcls: Any) -> None:
  158. _sa_util.preloaded.import_prefix("sqlalchemy.orm")
  159. _sa_util.preloaded.import_prefix("sqlalchemy.ext")
  160. __go(locals())