You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1046 lines
32KB

  1. # sql/coercions.py
  2. # Copyright (C) 2005-2021 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: http://www.opensource.org/licenses/mit-license.php
  7. import numbers
  8. import re
  9. from . import operators
  10. from . import roles
  11. from . import visitors
  12. from .base import Options
  13. from .traversals import HasCacheKey
  14. from .visitors import Visitable
  15. from .. import exc
  16. from .. import inspection
  17. from .. import util
  18. from ..util import collections_abc
  19. elements = None
  20. lambdas = None
  21. schema = None
  22. selectable = None
  23. sqltypes = None
  24. traversals = None
  25. def _is_literal(element):
  26. """Return whether or not the element is a "literal" in the context
  27. of a SQL expression construct.
  28. """
  29. return (
  30. not isinstance(
  31. element,
  32. (Visitable, schema.SchemaEventTarget),
  33. )
  34. and not hasattr(element, "__clause_element__")
  35. )
  36. def _deep_is_literal(element):
  37. """Return whether or not the element is a "literal" in the context
  38. of a SQL expression construct.
  39. does a deeper more esoteric check than _is_literal. is used
  40. for lambda elements that have to distinguish values that would
  41. be bound vs. not without any context.
  42. """
  43. if isinstance(element, collections_abc.Sequence) and not isinstance(
  44. element, str
  45. ):
  46. for elem in element:
  47. if not _deep_is_literal(elem):
  48. return False
  49. else:
  50. return True
  51. return (
  52. not isinstance(
  53. element,
  54. (
  55. Visitable,
  56. schema.SchemaEventTarget,
  57. HasCacheKey,
  58. Options,
  59. util.langhelpers._symbol,
  60. ),
  61. )
  62. and not hasattr(element, "__clause_element__")
  63. and (
  64. not isinstance(element, type)
  65. or not issubclass(element, HasCacheKey)
  66. )
  67. )
  68. def _document_text_coercion(paramname, meth_rst, param_rst):
  69. return util.add_parameter_text(
  70. paramname,
  71. (
  72. ".. warning:: "
  73. "The %s argument to %s can be passed as a Python string argument, "
  74. "which will be treated "
  75. "as **trusted SQL text** and rendered as given. **DO NOT PASS "
  76. "UNTRUSTED INPUT TO THIS PARAMETER**."
  77. )
  78. % (param_rst, meth_rst),
  79. )
  80. def _expression_collection_was_a_list(attrname, fnname, args):
  81. if args and isinstance(args[0], (list, set, dict)) and len(args) == 1:
  82. util.warn_deprecated_20(
  83. 'The "%s" argument to %s() is now passed as a series of '
  84. "positional "
  85. "elements, rather than as a list. " % (attrname, fnname)
  86. )
  87. return args[0]
  88. else:
  89. return args
  90. def expect(
  91. role,
  92. element,
  93. apply_propagate_attrs=None,
  94. argname=None,
  95. post_inspect=False,
  96. **kw
  97. ):
  98. if (
  99. role.allows_lambda
  100. # note callable() will not invoke a __getattr__() method, whereas
  101. # hasattr(obj, "__call__") will. by keeping the callable() check here
  102. # we prevent most needless calls to hasattr() and therefore
  103. # __getattr__(), which is present on ColumnElement.
  104. and callable(element)
  105. and hasattr(element, "__code__")
  106. ):
  107. return lambdas.LambdaElement(
  108. element,
  109. role,
  110. lambdas.LambdaOptions(**kw),
  111. apply_propagate_attrs=apply_propagate_attrs,
  112. )
  113. # major case is that we are given a ClauseElement already, skip more
  114. # elaborate logic up front if possible
  115. impl = _impl_lookup[role]
  116. original_element = element
  117. if not isinstance(
  118. element,
  119. (elements.ClauseElement, schema.SchemaItem, schema.FetchedValue),
  120. ):
  121. resolved = None
  122. if impl._resolve_literal_only:
  123. resolved = impl._literal_coercion(element, **kw)
  124. else:
  125. original_element = element
  126. is_clause_element = False
  127. # this is a special performance optimization for ORM
  128. # joins used by JoinTargetImpl that we don't go through the
  129. # work of creating __clause_element__() when we only need the
  130. # original QueryableAttribute, as the former will do clause
  131. # adaption and all that which is just thrown away here.
  132. if (
  133. impl._skip_clauseelement_for_target_match
  134. and isinstance(element, role)
  135. and hasattr(element, "__clause_element__")
  136. ):
  137. is_clause_element = True
  138. else:
  139. while hasattr(element, "__clause_element__"):
  140. is_clause_element = True
  141. if not getattr(element, "is_clause_element", False):
  142. element = element.__clause_element__()
  143. else:
  144. break
  145. if not is_clause_element:
  146. if impl._use_inspection:
  147. insp = inspection.inspect(element, raiseerr=False)
  148. if insp is not None:
  149. if post_inspect:
  150. insp._post_inspect
  151. try:
  152. resolved = insp.__clause_element__()
  153. except AttributeError:
  154. impl._raise_for_expected(original_element, argname)
  155. if resolved is None:
  156. resolved = impl._literal_coercion(
  157. element, argname=argname, **kw
  158. )
  159. else:
  160. resolved = element
  161. else:
  162. resolved = element
  163. if (
  164. apply_propagate_attrs is not None
  165. and not apply_propagate_attrs._propagate_attrs
  166. and resolved._propagate_attrs
  167. ):
  168. apply_propagate_attrs._propagate_attrs = resolved._propagate_attrs
  169. if impl._role_class in resolved.__class__.__mro__:
  170. if impl._post_coercion:
  171. resolved = impl._post_coercion(
  172. resolved,
  173. argname=argname,
  174. original_element=original_element,
  175. **kw
  176. )
  177. return resolved
  178. else:
  179. return impl._implicit_coercions(
  180. original_element, resolved, argname=argname, **kw
  181. )
  182. def expect_as_key(role, element, **kw):
  183. kw["as_key"] = True
  184. return expect(role, element, **kw)
  185. def expect_col_expression_collection(role, expressions):
  186. for expr in expressions:
  187. strname = None
  188. column = None
  189. resolved = expect(role, expr)
  190. if isinstance(resolved, util.string_types):
  191. strname = resolved = expr
  192. else:
  193. cols = []
  194. visitors.traverse(resolved, {}, {"column": cols.append})
  195. if cols:
  196. column = cols[0]
  197. add_element = column if column is not None else strname
  198. yield resolved, column, strname, add_element
  199. class RoleImpl(object):
  200. __slots__ = ("_role_class", "name", "_use_inspection")
  201. def _literal_coercion(self, element, **kw):
  202. raise NotImplementedError()
  203. _post_coercion = None
  204. _resolve_literal_only = False
  205. _skip_clauseelement_for_target_match = False
  206. def __init__(self, role_class):
  207. self._role_class = role_class
  208. self.name = role_class._role_name
  209. self._use_inspection = issubclass(role_class, roles.UsesInspection)
  210. def _implicit_coercions(self, element, resolved, argname=None, **kw):
  211. self._raise_for_expected(element, argname, resolved)
  212. def _raise_for_expected(
  213. self,
  214. element,
  215. argname=None,
  216. resolved=None,
  217. advice=None,
  218. code=None,
  219. err=None,
  220. ):
  221. if resolved is not None and resolved is not element:
  222. got = "%r object resolved from %r object" % (resolved, element)
  223. else:
  224. got = repr(element)
  225. if argname:
  226. msg = "%s expected for argument %r; got %s." % (
  227. self.name,
  228. argname,
  229. got,
  230. )
  231. else:
  232. msg = "%s expected, got %s." % (self.name, got)
  233. if advice:
  234. msg += " " + advice
  235. util.raise_(exc.ArgumentError(msg, code=code), replace_context=err)
  236. class _Deannotate(object):
  237. __slots__ = ()
  238. def _post_coercion(self, resolved, **kw):
  239. from .util import _deep_deannotate
  240. return _deep_deannotate(resolved)
  241. class _StringOnly(object):
  242. __slots__ = ()
  243. _resolve_literal_only = True
  244. class _ReturnsStringKey(object):
  245. __slots__ = ()
  246. def _implicit_coercions(
  247. self, original_element, resolved, argname=None, **kw
  248. ):
  249. if isinstance(original_element, util.string_types):
  250. return original_element
  251. else:
  252. self._raise_for_expected(original_element, argname, resolved)
  253. def _literal_coercion(self, element, **kw):
  254. return element
  255. class _ColumnCoercions(object):
  256. __slots__ = ()
  257. def _warn_for_scalar_subquery_coercion(self):
  258. util.warn(
  259. "implicitly coercing SELECT object to scalar subquery; "
  260. "please use the .scalar_subquery() method to produce a scalar "
  261. "subquery.",
  262. )
  263. def _implicit_coercions(
  264. self, original_element, resolved, argname=None, **kw
  265. ):
  266. if not getattr(resolved, "is_clause_element", False):
  267. self._raise_for_expected(original_element, argname, resolved)
  268. elif resolved._is_select_statement:
  269. self._warn_for_scalar_subquery_coercion()
  270. return resolved.scalar_subquery()
  271. elif resolved._is_from_clause and isinstance(
  272. resolved, selectable.Subquery
  273. ):
  274. self._warn_for_scalar_subquery_coercion()
  275. return resolved.element.scalar_subquery()
  276. elif self._role_class.allows_lambda and resolved._is_lambda_element:
  277. return resolved
  278. else:
  279. self._raise_for_expected(original_element, argname, resolved)
  280. def _no_text_coercion(
  281. element, argname=None, exc_cls=exc.ArgumentError, extra=None, err=None
  282. ):
  283. util.raise_(
  284. exc_cls(
  285. "%(extra)sTextual SQL expression %(expr)r %(argname)sshould be "
  286. "explicitly declared as text(%(expr)r)"
  287. % {
  288. "expr": util.ellipses_string(element),
  289. "argname": "for argument %s" % (argname,) if argname else "",
  290. "extra": "%s " % extra if extra else "",
  291. }
  292. ),
  293. replace_context=err,
  294. )
  295. class _NoTextCoercion(object):
  296. __slots__ = ()
  297. def _literal_coercion(self, element, argname=None, **kw):
  298. if isinstance(element, util.string_types) and issubclass(
  299. elements.TextClause, self._role_class
  300. ):
  301. _no_text_coercion(element, argname)
  302. else:
  303. self._raise_for_expected(element, argname)
  304. class _CoerceLiterals(object):
  305. __slots__ = ()
  306. _coerce_consts = False
  307. _coerce_star = False
  308. _coerce_numerics = False
  309. def _text_coercion(self, element, argname=None):
  310. return _no_text_coercion(element, argname)
  311. def _literal_coercion(self, element, argname=None, **kw):
  312. if isinstance(element, util.string_types):
  313. if self._coerce_star and element == "*":
  314. return elements.ColumnClause("*", is_literal=True)
  315. else:
  316. return self._text_coercion(element, argname, **kw)
  317. if self._coerce_consts:
  318. if element is None:
  319. return elements.Null()
  320. elif element is False:
  321. return elements.False_()
  322. elif element is True:
  323. return elements.True_()
  324. if self._coerce_numerics and isinstance(element, (numbers.Number)):
  325. return elements.ColumnClause(str(element), is_literal=True)
  326. self._raise_for_expected(element, argname)
  327. class LiteralValueImpl(RoleImpl):
  328. _resolve_literal_only = True
  329. def _implicit_coercions(
  330. self, element, resolved, argname, type_=None, **kw
  331. ):
  332. if not _is_literal(resolved):
  333. self._raise_for_expected(
  334. element, resolved=resolved, argname=argname, **kw
  335. )
  336. return elements.BindParameter(None, element, type_=type_, unique=True)
  337. def _literal_coercion(self, element, argname=None, type_=None, **kw):
  338. return element
  339. class _SelectIsNotFrom(object):
  340. __slots__ = ()
  341. def _raise_for_expected(self, element, argname=None, resolved=None, **kw):
  342. if isinstance(element, roles.SelectStatementRole) or isinstance(
  343. resolved, roles.SelectStatementRole
  344. ):
  345. advice = (
  346. "To create a "
  347. "FROM clause from a %s object, use the .subquery() method."
  348. % (resolved.__class__ if resolved is not None else element,)
  349. )
  350. code = "89ve"
  351. else:
  352. advice = code = None
  353. return super(_SelectIsNotFrom, self)._raise_for_expected(
  354. element,
  355. argname=argname,
  356. resolved=resolved,
  357. advice=advice,
  358. code=code,
  359. **kw
  360. )
  361. class HasCacheKeyImpl(RoleImpl):
  362. __slots__ = ()
  363. def _implicit_coercions(
  364. self, original_element, resolved, argname=None, **kw
  365. ):
  366. if isinstance(original_element, traversals.HasCacheKey):
  367. return original_element
  368. else:
  369. self._raise_for_expected(original_element, argname, resolved)
  370. def _literal_coercion(self, element, **kw):
  371. return element
  372. class ExpressionElementImpl(_ColumnCoercions, RoleImpl):
  373. __slots__ = ()
  374. def _literal_coercion(
  375. self, element, name=None, type_=None, argname=None, is_crud=False, **kw
  376. ):
  377. if element is None:
  378. return elements.Null()
  379. else:
  380. try:
  381. return elements.BindParameter(
  382. name, element, type_, unique=True, _is_crud=is_crud
  383. )
  384. except exc.ArgumentError as err:
  385. self._raise_for_expected(element, err=err)
  386. def _raise_for_expected(self, element, argname=None, resolved=None, **kw):
  387. if isinstance(element, roles.AnonymizedFromClauseRole):
  388. advice = (
  389. "To create a "
  390. "column expression from a FROM clause row "
  391. "as a whole, use the .table_valued() method."
  392. )
  393. else:
  394. advice = None
  395. return super(ExpressionElementImpl, self)._raise_for_expected(
  396. element, argname=argname, resolved=resolved, advice=advice, **kw
  397. )
  398. class BinaryElementImpl(ExpressionElementImpl, RoleImpl):
  399. __slots__ = ()
  400. def _literal_coercion(
  401. self, element, expr, operator, bindparam_type=None, argname=None, **kw
  402. ):
  403. try:
  404. return expr._bind_param(operator, element, type_=bindparam_type)
  405. except exc.ArgumentError as err:
  406. self._raise_for_expected(element, err=err)
  407. def _post_coercion(self, resolved, expr, **kw):
  408. if resolved.type._isnull and not expr.type._isnull:
  409. resolved = resolved._with_binary_element_type(expr.type)
  410. return resolved
  411. class InElementImpl(RoleImpl):
  412. __slots__ = ()
  413. def _implicit_coercions(
  414. self, original_element, resolved, argname=None, **kw
  415. ):
  416. if resolved._is_from_clause:
  417. if (
  418. isinstance(resolved, selectable.Alias)
  419. and resolved.element._is_select_statement
  420. ):
  421. self._warn_for_implicit_coercion(resolved)
  422. return self._post_coercion(resolved.element, **kw)
  423. else:
  424. self._warn_for_implicit_coercion(resolved)
  425. return self._post_coercion(resolved.select(), **kw)
  426. else:
  427. self._raise_for_expected(original_element, argname, resolved)
  428. def _warn_for_implicit_coercion(self, elem):
  429. util.warn(
  430. "Coercing %s object into a select() for use in IN(); "
  431. "please pass a select() construct explicitly"
  432. % (elem.__class__.__name__)
  433. )
  434. def _literal_coercion(self, element, expr, operator, **kw):
  435. if isinstance(element, collections_abc.Iterable) and not isinstance(
  436. element, util.string_types
  437. ):
  438. non_literal_expressions = {}
  439. element = list(element)
  440. for o in element:
  441. if not _is_literal(o):
  442. if not isinstance(o, operators.ColumnOperators):
  443. self._raise_for_expected(element, **kw)
  444. else:
  445. non_literal_expressions[o] = o
  446. elif o is None:
  447. non_literal_expressions[o] = elements.Null()
  448. if non_literal_expressions:
  449. return elements.ClauseList(
  450. *[
  451. non_literal_expressions[o]
  452. if o in non_literal_expressions
  453. else expr._bind_param(operator, o)
  454. for o in element
  455. ]
  456. )
  457. else:
  458. return expr._bind_param(operator, element, expanding=True)
  459. else:
  460. self._raise_for_expected(element, **kw)
  461. def _post_coercion(self, element, expr, operator, **kw):
  462. if element._is_select_statement:
  463. # for IN, we are doing scalar_subquery() coercion without
  464. # a warning
  465. return element.scalar_subquery()
  466. elif isinstance(element, elements.ClauseList):
  467. assert not len(element.clauses) == 0
  468. return element.self_group(against=operator)
  469. elif isinstance(element, elements.BindParameter):
  470. element = element._clone(maintain_key=True)
  471. element.expanding = True
  472. element.expand_op = operator
  473. return element
  474. else:
  475. return element
  476. class OnClauseImpl(_CoerceLiterals, _ColumnCoercions, RoleImpl):
  477. __slots__ = ()
  478. _coerce_consts = True
  479. def _implicit_coercions(
  480. self, original_element, resolved, argname=None, legacy=False, **kw
  481. ):
  482. if legacy and isinstance(resolved, str):
  483. return resolved
  484. else:
  485. return super(OnClauseImpl, self)._implicit_coercions(
  486. original_element,
  487. resolved,
  488. argname=argname,
  489. legacy=legacy,
  490. **kw
  491. )
  492. def _text_coercion(self, element, argname=None, legacy=False):
  493. if legacy and isinstance(element, str):
  494. util.warn_deprecated_20(
  495. "Using strings to indicate relationship names in "
  496. "Query.join() is deprecated and will be removed in "
  497. "SQLAlchemy 2.0. Please use the class-bound attribute "
  498. "directly."
  499. )
  500. return element
  501. return super(OnClauseImpl, self)._text_coercion(element, argname)
  502. def _post_coercion(self, resolved, original_element=None, **kw):
  503. # this is a hack right now as we want to use coercion on an
  504. # ORM InstrumentedAttribute, but we want to return the object
  505. # itself if it is one, not its clause element.
  506. # ORM context _join and _legacy_join() would need to be improved
  507. # to look for annotations in a clause element form.
  508. if isinstance(original_element, roles.JoinTargetRole):
  509. return original_element
  510. return resolved
  511. class WhereHavingImpl(_CoerceLiterals, _ColumnCoercions, RoleImpl):
  512. __slots__ = ()
  513. _coerce_consts = True
  514. def _text_coercion(self, element, argname=None):
  515. return _no_text_coercion(element, argname)
  516. class StatementOptionImpl(_CoerceLiterals, RoleImpl):
  517. __slots__ = ()
  518. _coerce_consts = True
  519. def _text_coercion(self, element, argname=None):
  520. return elements.TextClause(element)
  521. class ColumnArgumentImpl(_NoTextCoercion, RoleImpl):
  522. __slots__ = ()
  523. class ColumnArgumentOrKeyImpl(_ReturnsStringKey, RoleImpl):
  524. __slots__ = ()
  525. class StrAsPlainColumnImpl(_CoerceLiterals, RoleImpl):
  526. __slots__ = ()
  527. def _text_coercion(self, element, argname=None):
  528. return elements.ColumnClause(element)
  529. class ByOfImpl(_CoerceLiterals, _ColumnCoercions, RoleImpl, roles.ByOfRole):
  530. __slots__ = ()
  531. _coerce_consts = True
  532. def _text_coercion(self, element, argname=None):
  533. return elements._textual_label_reference(element)
  534. class OrderByImpl(ByOfImpl, RoleImpl):
  535. __slots__ = ()
  536. def _post_coercion(self, resolved, **kw):
  537. if (
  538. isinstance(resolved, self._role_class)
  539. and resolved._order_by_label_element is not None
  540. ):
  541. return elements._label_reference(resolved)
  542. else:
  543. return resolved
  544. class GroupByImpl(ByOfImpl, RoleImpl):
  545. __slots__ = ()
  546. def _implicit_coercions(
  547. self, original_element, resolved, argname=None, **kw
  548. ):
  549. if isinstance(resolved, roles.StrictFromClauseRole):
  550. return elements.ClauseList(*resolved.c)
  551. else:
  552. return resolved
  553. class DMLColumnImpl(_ReturnsStringKey, RoleImpl):
  554. __slots__ = ()
  555. def _post_coercion(self, element, as_key=False, **kw):
  556. if as_key:
  557. return element.key
  558. else:
  559. return element
  560. class ConstExprImpl(RoleImpl):
  561. __slots__ = ()
  562. def _literal_coercion(self, element, argname=None, **kw):
  563. if element is None:
  564. return elements.Null()
  565. elif element is False:
  566. return elements.False_()
  567. elif element is True:
  568. return elements.True_()
  569. else:
  570. self._raise_for_expected(element, argname)
  571. class TruncatedLabelImpl(_StringOnly, RoleImpl):
  572. __slots__ = ()
  573. def _implicit_coercions(
  574. self, original_element, resolved, argname=None, **kw
  575. ):
  576. if isinstance(original_element, util.string_types):
  577. return resolved
  578. else:
  579. self._raise_for_expected(original_element, argname, resolved)
  580. def _literal_coercion(self, element, argname=None, **kw):
  581. """coerce the given value to :class:`._truncated_label`.
  582. Existing :class:`._truncated_label` and
  583. :class:`._anonymous_label` objects are passed
  584. unchanged.
  585. """
  586. if isinstance(element, elements._truncated_label):
  587. return element
  588. else:
  589. return elements._truncated_label(element)
  590. class DDLExpressionImpl(_Deannotate, _CoerceLiterals, RoleImpl):
  591. __slots__ = ()
  592. _coerce_consts = True
  593. def _text_coercion(self, element, argname=None):
  594. # see #5754 for why we can't easily deprecate this coercion.
  595. # essentially expressions like postgresql_where would have to be
  596. # text() as they come back from reflection and we don't want to
  597. # have text() elements wired into the inspection dictionaries.
  598. return elements.TextClause(element)
  599. class DDLConstraintColumnImpl(_Deannotate, _ReturnsStringKey, RoleImpl):
  600. __slots__ = ()
  601. class DDLReferredColumnImpl(DDLConstraintColumnImpl):
  602. __slots__ = ()
  603. class LimitOffsetImpl(RoleImpl):
  604. __slots__ = ()
  605. def _implicit_coercions(self, element, resolved, argname=None, **kw):
  606. if resolved is None:
  607. return None
  608. else:
  609. self._raise_for_expected(element, argname, resolved)
  610. def _literal_coercion(self, element, name, type_, **kw):
  611. if element is None:
  612. return None
  613. else:
  614. value = util.asint(element)
  615. return selectable._OffsetLimitParam(
  616. name, value, type_=type_, unique=True
  617. )
  618. class LabeledColumnExprImpl(ExpressionElementImpl):
  619. __slots__ = ()
  620. def _implicit_coercions(
  621. self, original_element, resolved, argname=None, **kw
  622. ):
  623. if isinstance(resolved, roles.ExpressionElementRole):
  624. return resolved.label(None)
  625. else:
  626. new = super(LabeledColumnExprImpl, self)._implicit_coercions(
  627. original_element, resolved, argname=argname, **kw
  628. )
  629. if isinstance(new, roles.ExpressionElementRole):
  630. return new.label(None)
  631. else:
  632. self._raise_for_expected(original_element, argname, resolved)
  633. class ColumnsClauseImpl(_SelectIsNotFrom, _CoerceLiterals, RoleImpl):
  634. __slots__ = ()
  635. _coerce_consts = True
  636. _coerce_numerics = True
  637. _coerce_star = True
  638. _guess_straight_column = re.compile(r"^\w\S*$", re.I)
  639. def _text_coercion(self, element, argname=None):
  640. element = str(element)
  641. guess_is_literal = not self._guess_straight_column.match(element)
  642. raise exc.ArgumentError(
  643. "Textual column expression %(column)r %(argname)sshould be "
  644. "explicitly declared with text(%(column)r), "
  645. "or use %(literal_column)s(%(column)r) "
  646. "for more specificity"
  647. % {
  648. "column": util.ellipses_string(element),
  649. "argname": "for argument %s" % (argname,) if argname else "",
  650. "literal_column": "literal_column"
  651. if guess_is_literal
  652. else "column",
  653. }
  654. )
  655. class ReturnsRowsImpl(RoleImpl):
  656. __slots__ = ()
  657. class StatementImpl(_CoerceLiterals, RoleImpl):
  658. __slots__ = ()
  659. def _implicit_coercions(
  660. self, original_element, resolved, argname=None, **kw
  661. ):
  662. if resolved._is_lambda_element:
  663. return resolved
  664. else:
  665. return super(StatementImpl, self)._implicit_coercions(
  666. original_element, resolved, argname=argname, **kw
  667. )
  668. def _text_coercion(self, element, argname=None):
  669. util.warn_deprecated_20(
  670. "Using plain strings to indicate SQL statements without using "
  671. "the text() construct is "
  672. "deprecated and will be removed in version 2.0. Ensure plain "
  673. "SQL statements are passed using the text() construct."
  674. )
  675. return elements.TextClause(element)
  676. class SelectStatementImpl(_NoTextCoercion, RoleImpl):
  677. __slots__ = ()
  678. def _implicit_coercions(
  679. self, original_element, resolved, argname=None, **kw
  680. ):
  681. if resolved._is_text_clause:
  682. return resolved.columns()
  683. else:
  684. self._raise_for_expected(original_element, argname, resolved)
  685. class HasCTEImpl(ReturnsRowsImpl):
  686. __slots__ = ()
  687. class JoinTargetImpl(RoleImpl):
  688. __slots__ = ()
  689. _skip_clauseelement_for_target_match = True
  690. def _literal_coercion(self, element, legacy=False, **kw):
  691. if isinstance(element, str):
  692. return element
  693. def _implicit_coercions(
  694. self, original_element, resolved, argname=None, legacy=False, **kw
  695. ):
  696. if isinstance(original_element, roles.JoinTargetRole):
  697. # note that this codepath no longer occurs as of
  698. # #6550, unless JoinTargetImpl._skip_clauseelement_for_target_match
  699. # were set to False.
  700. return original_element
  701. elif legacy and isinstance(resolved, str):
  702. util.warn_deprecated_20(
  703. "Using strings to indicate relationship names in "
  704. "Query.join() is deprecated and will be removed in "
  705. "SQLAlchemy 2.0. Please use the class-bound attribute "
  706. "directly."
  707. )
  708. return resolved
  709. elif legacy and isinstance(resolved, roles.WhereHavingRole):
  710. return resolved
  711. elif legacy and resolved._is_select_statement:
  712. util.warn_deprecated(
  713. "Implicit coercion of SELECT and textual SELECT "
  714. "constructs into FROM clauses is deprecated; please call "
  715. ".subquery() on any Core select or ORM Query object in "
  716. "order to produce a subquery object.",
  717. version="1.4",
  718. )
  719. # TODO: doing _implicit_subquery here causes tests to fail,
  720. # how was this working before? probably that ORM
  721. # join logic treated it as a select and subquery would happen
  722. # in _ORMJoin->Join
  723. return resolved
  724. else:
  725. self._raise_for_expected(original_element, argname, resolved)
  726. class FromClauseImpl(_SelectIsNotFrom, _NoTextCoercion, RoleImpl):
  727. __slots__ = ()
  728. def _implicit_coercions(
  729. self,
  730. original_element,
  731. resolved,
  732. argname=None,
  733. explicit_subquery=False,
  734. allow_select=True,
  735. **kw
  736. ):
  737. if resolved._is_select_statement:
  738. if explicit_subquery:
  739. return resolved.subquery()
  740. elif allow_select:
  741. util.warn_deprecated(
  742. "Implicit coercion of SELECT and textual SELECT "
  743. "constructs into FROM clauses is deprecated; please call "
  744. ".subquery() on any Core select or ORM Query object in "
  745. "order to produce a subquery object.",
  746. version="1.4",
  747. )
  748. return resolved._implicit_subquery
  749. elif resolved._is_text_clause:
  750. return resolved
  751. else:
  752. self._raise_for_expected(original_element, argname, resolved)
  753. def _post_coercion(self, element, deannotate=False, **kw):
  754. if deannotate:
  755. return element._deannotate()
  756. else:
  757. return element
  758. class StrictFromClauseImpl(FromClauseImpl):
  759. __slots__ = ()
  760. def _implicit_coercions(
  761. self,
  762. original_element,
  763. resolved,
  764. argname=None,
  765. allow_select=False,
  766. **kw
  767. ):
  768. if resolved._is_select_statement and allow_select:
  769. util.warn_deprecated(
  770. "Implicit coercion of SELECT and textual SELECT constructs "
  771. "into FROM clauses is deprecated; please call .subquery() "
  772. "on any Core select or ORM Query object in order to produce a "
  773. "subquery object.",
  774. version="1.4",
  775. )
  776. return resolved._implicit_subquery
  777. else:
  778. self._raise_for_expected(original_element, argname, resolved)
  779. class AnonymizedFromClauseImpl(StrictFromClauseImpl):
  780. __slots__ = ()
  781. def _post_coercion(self, element, flat=False, name=None, **kw):
  782. assert name is None
  783. return element._anonymous_fromclause(flat=flat)
  784. class DMLTableImpl(_SelectIsNotFrom, _NoTextCoercion, RoleImpl):
  785. __slots__ = ()
  786. def _post_coercion(self, element, **kw):
  787. if "dml_table" in element._annotations:
  788. return element._annotations["dml_table"]
  789. else:
  790. return element
  791. class DMLSelectImpl(_NoTextCoercion, RoleImpl):
  792. __slots__ = ()
  793. def _implicit_coercions(
  794. self, original_element, resolved, argname=None, **kw
  795. ):
  796. if resolved._is_from_clause:
  797. if (
  798. isinstance(resolved, selectable.Alias)
  799. and resolved.element._is_select_statement
  800. ):
  801. return resolved.element
  802. else:
  803. return resolved.select()
  804. else:
  805. self._raise_for_expected(original_element, argname, resolved)
  806. class CompoundElementImpl(_NoTextCoercion, RoleImpl):
  807. __slots__ = ()
  808. def _raise_for_expected(self, element, argname=None, resolved=None, **kw):
  809. if isinstance(element, roles.FromClauseRole):
  810. if element._is_subquery:
  811. advice = (
  812. "Use the plain select() object without "
  813. "calling .subquery() or .alias()."
  814. )
  815. else:
  816. advice = (
  817. "To SELECT from any FROM clause, use the .select() method."
  818. )
  819. else:
  820. advice = None
  821. return super(CompoundElementImpl, self)._raise_for_expected(
  822. element, argname=argname, resolved=resolved, advice=advice, **kw
  823. )
  824. _impl_lookup = {}
  825. for name in dir(roles):
  826. cls = getattr(roles, name)
  827. if name.endswith("Role"):
  828. name = name.replace("Role", "Impl")
  829. if name in globals():
  830. impl = globals()[name](cls)
  831. _impl_lookup[cls] = impl