Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/sqlalchemy/orm/__init__.py: 99%

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""" 

9Functional constructs for ORM configuration. 

10 

11See the SQLAlchemy object relational tutorial and mapper configuration 

12documentation for an overview of how this module is used. 

13 

14""" 

15 

16from __future__ import annotations 

17 

18from typing import Any 

19 

20from . import exc as exc 

21from . import mapper as mapperlib 

22from . import strategy_options as strategy_options 

23from ._orm_constructors import _mapper_fn as mapper 

24from ._orm_constructors import aliased as aliased 

25from ._orm_constructors import backref as backref 

26from ._orm_constructors import clear_mappers as clear_mappers 

27from ._orm_constructors import column_property as column_property 

28from ._orm_constructors import composite as composite 

29from ._orm_constructors import contains_alias as contains_alias 

30from ._orm_constructors import create_session as create_session 

31from ._orm_constructors import deferred as deferred 

32from ._orm_constructors import dynamic_loader as dynamic_loader 

33from ._orm_constructors import join as join 

34from ._orm_constructors import mapped_column as mapped_column 

35from ._orm_constructors import orm_insert_sentinel as orm_insert_sentinel 

36from ._orm_constructors import outerjoin as outerjoin 

37from ._orm_constructors import query_expression as query_expression 

38from ._orm_constructors import relationship as relationship 

39from ._orm_constructors import synonym as synonym 

40from ._orm_constructors import with_loader_criteria as with_loader_criteria 

41from ._orm_constructors import with_polymorphic as with_polymorphic 

42from .attributes import AttributeEventToken as AttributeEventToken 

43from .attributes import InstrumentedAttribute as InstrumentedAttribute 

44from .attributes import QueryableAttribute as QueryableAttribute 

45from .base import class_mapper as class_mapper 

46from .base import DynamicMapped as DynamicMapped 

47from .base import InspectionAttrExtensionType as InspectionAttrExtensionType 

48from .base import LoaderCallableStatus as LoaderCallableStatus 

49from .base import Mapped as Mapped 

50from .base import NotExtension as NotExtension 

51from .base import ORMDescriptor as ORMDescriptor 

52from .base import PassiveFlag as PassiveFlag 

53from .base import SQLORMExpression as SQLORMExpression 

54from .base import WriteOnlyMapped as WriteOnlyMapped 

55from .context import FromStatement as FromStatement 

56from .context import QueryContext as QueryContext 

57from .decl_api import add_mapped_attribute as add_mapped_attribute 

58from .decl_api import as_declarative as as_declarative 

59from .decl_api import declarative_base as declarative_base 

60from .decl_api import declarative_mixin as declarative_mixin 

61from .decl_api import DeclarativeBase as DeclarativeBase 

62from .decl_api import DeclarativeBaseNoMeta as DeclarativeBaseNoMeta 

63from .decl_api import DeclarativeMeta as DeclarativeMeta 

64from .decl_api import declared_attr as declared_attr 

65from .decl_api import has_inherited_table as has_inherited_table 

66from .decl_api import mapped_as_dataclass as mapped_as_dataclass 

67from .decl_api import MappedAsDataclass as MappedAsDataclass 

68from .decl_api import registry as registry 

69from .decl_api import synonym_for as synonym_for 

70from .decl_api import TypeResolve as TypeResolve 

71from .decl_api import unmapped_dataclass as unmapped_dataclass 

72from .decl_base import MappedClassProtocol as MappedClassProtocol 

73from .descriptor_props import Composite as Composite 

74from .descriptor_props import CompositeProperty as CompositeProperty 

75from .descriptor_props import Synonym as Synonym 

76from .descriptor_props import SynonymProperty as SynonymProperty 

77from .dynamic import AppenderQuery as AppenderQuery 

78from .events import AttributeEvents as AttributeEvents 

79from .events import InstanceEvents as InstanceEvents 

80from .events import InstrumentationEvents as InstrumentationEvents 

81from .events import MapperEvents as MapperEvents 

82from .events import QueryEvents as QueryEvents 

83from .events import RegistryEvents as RegistryEvents 

84from .events import SessionEvents as SessionEvents 

85from .identity import IdentityMap as IdentityMap 

86from .instrumentation import ClassManager as ClassManager 

87from .interfaces import EXT_CONTINUE as EXT_CONTINUE 

88from .interfaces import EXT_SKIP as EXT_SKIP 

89from .interfaces import EXT_STOP as EXT_STOP 

90from .interfaces import InspectionAttr as InspectionAttr 

91from .interfaces import InspectionAttrInfo as InspectionAttrInfo 

92from .interfaces import MANYTOMANY as MANYTOMANY 

93from .interfaces import MANYTOONE as MANYTOONE 

94from .interfaces import MapperProperty as MapperProperty 

95from .interfaces import NO_KEY as NO_KEY 

96from .interfaces import NO_VALUE as NO_VALUE 

97from .interfaces import ONETOMANY as ONETOMANY 

98from .interfaces import PropComparator as PropComparator 

99from .interfaces import RelationshipDirection as RelationshipDirection 

100from .interfaces import UserDefinedOption as UserDefinedOption 

101from .loading import merge_frozen_result as merge_frozen_result 

102from .loading import merge_result as merge_result 

103from .mapped_collection import attribute_keyed_dict as attribute_keyed_dict 

104from .mapped_collection import ( 

105 attribute_mapped_collection as attribute_mapped_collection, 

106) 

107from .mapped_collection import column_keyed_dict as column_keyed_dict 

108from .mapped_collection import ( 

109 column_mapped_collection as column_mapped_collection, 

110) 

111from .mapped_collection import keyfunc_mapping as keyfunc_mapping 

112from .mapped_collection import KeyFuncDict as KeyFuncDict 

113from .mapped_collection import mapped_collection as mapped_collection 

114from .mapped_collection import MappedCollection as MappedCollection 

115from .mapper import configure_mappers as configure_mappers 

116from .mapper import Mapper as Mapper 

117from .mapper import reconstructor as reconstructor 

118from .mapper import validates as validates 

119from .properties import ColumnProperty as ColumnProperty 

120from .properties import MappedColumn as MappedColumn 

121from .properties import MappedSQLExpression as MappedSQLExpression 

122from .query import AliasOption as AliasOption 

123from .query import Query as Query 

124from .relationships import foreign as foreign 

125from .relationships import Relationship as Relationship 

126from .relationships import RelationshipProperty as RelationshipProperty 

127from .relationships import remote as remote 

128from .scoping import QueryPropertyDescriptor as QueryPropertyDescriptor 

129from .scoping import scoped_session as scoped_session 

130from .session import close_all_sessions as close_all_sessions 

131from .session import make_transient as make_transient 

132from .session import make_transient_to_detached as make_transient_to_detached 

133from .session import object_session as object_session 

134from .session import ORMExecuteState as ORMExecuteState 

135from .session import Session as Session 

136from .session import sessionmaker as sessionmaker 

137from .session import SessionTransaction as SessionTransaction 

138from .session import SessionTransactionOrigin as SessionTransactionOrigin 

139from .state import AttributeState as AttributeState 

140from .state import InstanceState as InstanceState 

141from .strategy_options import contains_eager as contains_eager 

142from .strategy_options import defaultload as defaultload 

143from .strategy_options import defer as defer 

144from .strategy_options import immediateload as immediateload 

145from .strategy_options import joinedload as joinedload 

146from .strategy_options import lazyload as lazyload 

147from .strategy_options import Load as Load 

148from .strategy_options import load_only as load_only 

149from .strategy_options import noload as noload 

150from .strategy_options import raiseload as raiseload 

151from .strategy_options import selectin_polymorphic as selectin_polymorphic 

152from .strategy_options import selectinload as selectinload 

153from .strategy_options import subqueryload as subqueryload 

154from .strategy_options import undefer as undefer 

155from .strategy_options import undefer_group as undefer_group 

156from .strategy_options import with_expression as with_expression 

157from .unitofwork import UOWTransaction as UOWTransaction 

158from .util import Bundle as Bundle 

159from .util import CascadeOptions as CascadeOptions 

160from .util import LoaderCriteriaOption as LoaderCriteriaOption 

161from .util import object_mapper as object_mapper 

162from .util import polymorphic_union as polymorphic_union 

163from .util import was_deleted as was_deleted 

164from .util import with_parent as with_parent 

165from .writeonly import WriteOnlyCollection as WriteOnlyCollection 

166from .. import util as _sa_util 

167 

168 

169def __go(lcls: Any) -> None: 

170 _sa_util.preloaded.import_prefix("sqlalchemy.orm") 

171 _sa_util.preloaded.import_prefix("sqlalchemy.ext") 

172 

173 

174__go(locals())