summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/orm/relationships.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2022-11-04 11:04:13 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2022-11-04 13:38:06 -0400
commitc0b8bdcaf020e8d043b9f9bce3e53d19e4fb79a0 (patch)
treeceeb184a053a61c93428de120052f3a0d27a879d /lib/sqlalchemy/orm/relationships.py
parentb96321ae79a0366c33ca739e6e67aaf5f4420db4 (diff)
downloadsqlalchemy-c0b8bdcaf020e8d043b9f9bce3e53d19e4fb79a0.tar.gz
support renamed symbols in annotation scans
Added support in ORM declarative annotations for class names specified for :func:`_orm.relationship`, as well as the name of the :class:`_orm.Mapped` symbol itself, to be different names than their direct class name, to support scenarios such as where :class:`_orm.Mapped` is imported as ``from sqlalchemy.orm import Mapped as M``, or where related class names are imported with an alternate name in a similar fashion. Additionally, a target class name given as the lead argument for :func:`_orm.relationship` will always supersede the name given in the left hand annotation, so that otherwise un-importable names that also don't match the class name can still be used in annotations. Fixes: #8759 Change-Id: I74a00de7e1a45bf62dad50fd385bb75cf343f9f3
Diffstat (limited to 'lib/sqlalchemy/orm/relationships.py')
-rw-r--r--lib/sqlalchemy/orm/relationships.py20
1 files changed, 18 insertions, 2 deletions
diff --git a/lib/sqlalchemy/orm/relationships.py b/lib/sqlalchemy/orm/relationships.py
index 6d388a630..e0922a538 100644
--- a/lib/sqlalchemy/orm/relationships.py
+++ b/lib/sqlalchemy/orm/relationships.py
@@ -88,6 +88,7 @@ from ..sql.util import selectables_overlap
from ..sql.util import visit_binary_product
from ..util.typing import de_optionalize_union_types
from ..util.typing import Literal
+from ..util.typing import resolve_name_to_real_class_name
if typing.TYPE_CHECKING:
from ._typing import _EntityType
@@ -1729,6 +1730,7 @@ class RelationshipProperty(
return
argument = extracted_mapped_annotation
+ assert originating_module is not None
is_write_only = mapped_container is not None and issubclass(
mapped_container, WriteOnlyMapped
@@ -1765,7 +1767,10 @@ class RelationshipProperty(
type_arg = argument.__args__[0] # type: ignore
if hasattr(type_arg, "__forward_arg__"):
str_argument = type_arg.__forward_arg__
- argument = str_argument
+
+ argument = resolve_name_to_real_class_name(
+ str_argument, originating_module
+ )
else:
argument = type_arg
else:
@@ -1775,6 +1780,10 @@ class RelationshipProperty(
elif hasattr(argument, "__forward_arg__"):
argument = argument.__forward_arg__ # type: ignore
+ argument = resolve_name_to_real_class_name(
+ argument, originating_module
+ )
+
# we don't allow the collection class to be a
# __forward_arg__ right now, so if we see a forward arg here,
# we know there was no collection class either
@@ -1785,7 +1794,14 @@ class RelationshipProperty(
):
self.uselist = False
- self.argument = cast("_RelationshipArgumentType[_T]", argument)
+ # ticket #8759
+ # if a lead argument was given to relationship(), like
+ # `relationship("B")`, use that, don't replace it with class we
+ # found in the annotation. The declarative_scan() method call here is
+ # still useful, as we continue to derive collection type and do
+ # checking of the annotation in any case.
+ if self.argument is None:
+ self.argument = cast("_RelationshipArgumentType[_T]", argument)
@util.preload_module("sqlalchemy.orm.mapper")
def _setup_entity(self, __argument: Any = None) -> None: