summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/orm/query.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2020-10-12 15:17:25 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2020-10-13 14:43:38 -0400
commit348260943a52ddd7ee3388eaac8e05da3794958b (patch)
tree6acc17d97e8f1b11f29ffbd86386155cb5e80c1a /lib/sqlalchemy/orm/query.py
parenta3e2eb7c3c3fe6b2bebd14a7e9d661b2b4519d1f (diff)
downloadsqlalchemy-348260943a52ddd7ee3388eaac8e05da3794958b.tar.gz
Deprecate strings indicating attribute names
Using strings to represent relationship names in ORM operations such as :meth:`_orm.Query.join`, as well as strings for all ORM attribute names in loader options like :func:`_orm.selectinload` is deprecated and will be removed in SQLAlchemy 2.0. The class-bound attribute should be passed instead. This provides much better specificity to the given method, allows for modifiers such as ``of_type()``, and reduces internal complexity. Additionally, the ``aliased`` and ``from_joinpoint`` parameters to :meth:`_orm.Query.join` are also deprecated. The :func:`_orm.aliased` construct now provides for a great deal of flexibility and capability and should be used directly. Fixes: #4705 Fixes: #5202 Change-Id: I32f61663d68026154906932913c288f269991adc
Diffstat (limited to 'lib/sqlalchemy/orm/query.py')
-rw-r--r--lib/sqlalchemy/orm/query.py40
1 files changed, 32 insertions, 8 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py
index e278d81f3..df1a048f3 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -718,9 +718,12 @@ class Query(
"""
self._compile_options += {"_current_path": path}
- # TODO: removed in 2.0
@_generative
@_assertions(_no_clauseelement_condition)
+ @util.deprecated_20(
+ ":meth:`_orm.Query.with_polymorphic`",
+ alternative="Use the orm.with_polymorphic() standalone function",
+ )
def with_polymorphic(
self, cls_or_mappers, selectable=None, polymorphic_on=None
):
@@ -2094,6 +2097,9 @@ class Query(
**Legacy Features of Query.join()**
+ .. deprecated:: 1.4 The following features are deprecated and will
+ be removed in SQLAlchemy 2.0.
+
The :meth:`_query.Query.join` method currently supports several
usage patterns and arguments that are considered to be legacy
as of SQLAlchemy 1.3. A deprecation path will follow
@@ -2218,6 +2224,14 @@ class Query(
kwargs.pop("isouter", False),
kwargs.pop("full", False),
)
+
+ if aliased or from_joinpoint:
+ util.warn_deprecated_20(
+ "The ``aliased`` and ``from_joinpoint`` keyword arguments "
+ "to Query.join() are deprecated and will be removed "
+ "in SQLAlchemy 2.0."
+ )
+
if kwargs:
raise TypeError(
"unknown arguments: %s" % ", ".join(sorted(kwargs))
@@ -2249,6 +2263,10 @@ class Query(
_single = []
for prop in (target,) + props:
if isinstance(prop, tuple):
+ util.warn_deprecated_20(
+ "Query.join() will no longer accept tuples as "
+ "arguments in SQLAlchemy 2.0."
+ )
if _single:
_props.extend((_s,) for _s in _single)
_single = []
@@ -2286,7 +2304,7 @@ class Query(
# legacy ^^^^^^^^^^^^^^^^^^^^^^^^^^^
- self._legacy_setup_joins += tuple(
+ joins_to_add = tuple(
(
coercions.expect(
roles.JoinTargetRole,
@@ -2295,9 +2313,9 @@ class Query(
apply_propagate_attrs=self,
),
(
- coercions.expect(roles.OnClauseRole, prop[1])
- if not isinstance(prop[1], str)
- else prop[1]
+ coercions.expect(roles.OnClauseRole, prop[1], legacy=True)
+ # if not isinstance(prop[1], str)
+ # else prop[1]
)
if len(prop) == 2
else None,
@@ -2313,6 +2331,14 @@ class Query(
for i, prop in enumerate(_props)
)
+ if len(joins_to_add) > 1:
+ util.warn_deprecated_20(
+ "Passing a chain of multiple join conditions to Query.join() "
+ "is deprecated and will be removed in SQLAlchemy 2.0. "
+ "Please use individual join() calls per relationship."
+ )
+ self._legacy_setup_joins += joins_to_add
+
self.__dict__.pop("_last_joined_entity", None)
def outerjoin(self, target, *props, **kwargs):
@@ -3038,9 +3064,7 @@ class Query(
"""
- bulk_del = BulkDelete(
- self,
- )
+ bulk_del = BulkDelete(self)
if self.dispatch.before_compile_delete:
for fn in self.dispatch.before_compile_delete:
new_query = fn(bulk_del.query, bulk_del)