1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
|
"""Evaluating SQL expressions on ORM objects"""
from sqlalchemy import and_
from sqlalchemy import bindparam
from sqlalchemy import ForeignKey
from sqlalchemy import inspect
from sqlalchemy import Integer
from sqlalchemy import JSON
from sqlalchemy import not_
from sqlalchemy import or_
from sqlalchemy import String
from sqlalchemy import testing
from sqlalchemy import tuple_
from sqlalchemy.orm import evaluator
from sqlalchemy.orm import exc as orm_exc
from sqlalchemy.orm import relationship
from sqlalchemy.testing import assert_raises
from sqlalchemy.testing import assert_raises_message
from sqlalchemy.testing import eq_
from sqlalchemy.testing import expect_raises_message
from sqlalchemy.testing import expect_warnings
from sqlalchemy.testing import fixtures
from sqlalchemy.testing import is_
from sqlalchemy.testing.fixtures import fixture_session
from sqlalchemy.testing.schema import Column
from sqlalchemy.testing.schema import Table
compiler = evaluator.EvaluatorCompiler()
def eval_eq(clause, testcases=None):
evaluator = compiler.process(clause)
def testeval(obj=None, expected_result=None):
assert evaluator(obj) == expected_result, "%s != %r for %s with %r" % (
evaluator(obj),
expected_result,
clause,
obj,
)
if testcases:
for an_obj, result in testcases:
testeval(an_obj, result)
return testeval
class EvaluateTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"users",
metadata,
Column("id", Integer, primary_key=True),
Column("name", String(64)),
Column("othername", String(64)),
Column("json", JSON),
)
@classmethod
def setup_classes(cls):
class User(cls.Basic):
pass
@classmethod
def setup_mappers(cls):
users, User = cls.tables.users, cls.classes.User
cls.mapper_registry.map_imperatively(User, users)
def test_compare_to_value(self):
User = self.classes.User
eval_eq(
User.name == "foo",
testcases=[
(User(name="foo"), True),
(User(name="bar"), False),
(User(name=None), None),
],
)
eval_eq(
User.id < 5,
testcases=[
(User(id=3), True),
(User(id=5), False),
(User(id=None), None),
],
)
def test_compare_to_callable_bind(self):
User = self.classes.User
eval_eq(
User.name == bindparam("x", callable_=lambda: "foo"),
testcases=[
(User(name="foo"), True),
(User(name="bar"), False),
(User(name=None), None),
],
)
def test_compare_to_none(self):
User = self.classes.User
eval_eq(
User.name == None, # noqa
testcases=[
(User(name="foo"), False),
(User(name=None), True),
(None, None),
],
)
def test_warn_on_unannotated_matched_column(self):
User = self.classes.User
compiler = evaluator.EvaluatorCompiler(User)
with expect_warnings(
r"Evaluating non-mapped column expression 'othername' "
"onto ORM instances; this is a deprecated use case."
):
meth = compiler.process(User.name == Column("othername", String))
u1 = User(id=5)
meth(u1)
def test_raise_on_unannotated_unmatched_column(self):
User = self.classes.User
compiler = evaluator.EvaluatorCompiler(User)
assert_raises_message(
evaluator.UnevaluatableError,
"Cannot evaluate column: foo",
compiler.process,
User.id == Column("foo", Integer),
)
# if we let the above method through as we did
# prior to [ticket:3366], we would get
# AttributeError: 'User' object has no attribute 'foo'
# u1 = User(id=5)
# meth(u1)
def test_true_false(self):
User = self.classes.User
eval_eq(
User.name == False, # noqa
testcases=[
(User(name="foo"), False),
(User(name=True), False),
(User(name=False), True),
(None, None),
],
)
eval_eq(
User.name == True, # noqa
testcases=[
(User(name="foo"), False),
(User(name=True), True),
(User(name=False), False),
(None, None),
],
)
def test_boolean_ops(self):
User = self.classes.User
eval_eq(
and_(User.name == "foo", User.id == 1),
testcases=[
(User(id=1, name="foo"), True),
(User(id=2, name="foo"), False),
(User(id=1, name="bar"), False),
(User(id=2, name="bar"), False),
(User(id=1, name=None), None),
(None, None),
],
)
eval_eq(
or_(User.name == "foo", User.id == 1),
testcases=[
(User(id=1, name="foo"), True),
(User(id=2, name="foo"), True),
(User(id=1, name="bar"), True),
(User(id=2, name="bar"), False),
(User(id=1, name=None), True),
(User(id=2, name=None), None),
(None, None),
],
)
eval_eq(
not_(User.id == 1),
testcases=[
(User(id=1), False),
(User(id=2), True),
(User(id=None), None),
],
)
@testing.combinations(
lambda User: User.name + "_foo" == "named_foo",
# not implemented in 1.4
# lambda User: User.name.startswith("nam"),
# lambda User: User.name.endswith("named"),
)
def test_string_ops(self, expr):
User = self.classes.User
test_expr = testing.resolve_lambda(expr, User=User)
eval_eq(
test_expr,
testcases=[
(User(name="named"), True),
(User(name="othername"), False),
],
)
def test_in(self):
User = self.classes.User
eval_eq(
User.name.in_(["foo", "bar"]),
testcases=[
(User(id=1, name="foo"), True),
(User(id=2, name="bat"), False),
(User(id=1, name="bar"), True),
(User(id=1, name=None), None),
(None, None),
],
)
eval_eq(
User.name.not_in(["foo", "bar"]),
testcases=[
(User(id=1, name="foo"), False),
(User(id=2, name="bat"), True),
(User(id=1, name="bar"), False),
(User(id=1, name=None), None),
(None, None),
],
)
def test_in_tuples(self):
User = self.classes.User
eval_eq(
tuple_(User.id, User.name).in_([(1, "foo"), (2, "bar")]),
testcases=[
(User(id=1, name="foo"), True),
(User(id=2, name="bat"), False),
(User(id=1, name="bar"), False),
(User(id=2, name="bar"), True),
(User(id=1, name=None), None),
(None, None),
],
)
eval_eq(
tuple_(User.id, User.name).not_in([(1, "foo"), (2, "bar")]),
testcases=[
(User(id=1, name="foo"), False),
(User(id=2, name="bat"), True),
(User(id=1, name="bar"), True),
(User(id=2, name="bar"), False),
(User(id=1, name=None), None),
(None, None),
],
)
def test_null_propagation(self):
User = self.classes.User
eval_eq(
(User.name == "foo") == (User.id == 1),
testcases=[
(User(id=1, name="foo"), True),
(User(id=2, name="foo"), False),
(User(id=1, name="bar"), False),
(User(id=2, name="bar"), True),
(User(id=None, name="foo"), None),
(User(id=None, name=None), None),
(None, None),
],
)
@testing.combinations(
(lambda User: User.id + 5, "id", 10, 15, None),
(
lambda User: User.name + " name",
"name",
"some value",
"some value name",
None,
),
(
lambda User: User.id + "name",
"id",
10,
evaluator.UnevaluatableError,
r"Cannot evaluate math operator \"add\" for "
r"datatypes INTEGER, VARCHAR",
),
(
lambda User: User.json + 12,
"json",
{"foo": "bar"},
evaluator.UnevaluatableError,
r"Cannot evaluate math operator \"add\" for "
r"datatypes JSON, INTEGER",
),
(
lambda User: User.json - 12,
"json",
{"foo": "bar"},
evaluator.UnevaluatableError,
r"Cannot evaluate math operator \"sub\" for "
r"datatypes JSON, INTEGER",
),
(
lambda User: User.json - "foo",
"json",
{"foo": "bar"},
evaluator.UnevaluatableError,
r"Cannot evaluate math operator \"sub\" for "
r"datatypes JSON, VARCHAR",
),
)
def test_math_op_type_exclusions(
self, expr, attrname, initial_value, expected, message
):
"""test #8507"""
User = self.classes.User
expr = testing.resolve_lambda(expr, User=User)
if expected is evaluator.UnevaluatableError:
with expect_raises_message(evaluator.UnevaluatableError, message):
compiler.process(expr)
else:
obj = User(**{attrname: initial_value})
new_value = compiler.process(expr)(obj)
eq_(new_value, expected)
class M2OEvaluateTest(fixtures.DeclarativeMappedTest):
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class Parent(Base):
__tablename__ = "parent"
id = Column(Integer, primary_key=True)
class Child(Base):
__tablename__ = "child"
_id_parent = Column(
"id_parent", Integer, ForeignKey(Parent.id), primary_key=True
)
name = Column(String(50), primary_key=True)
parent = relationship(Parent)
def test_delete_not_expired(self):
Parent, Child = self.classes("Parent", "Child")
session = fixture_session(expire_on_commit=False)
p = Parent(id=1)
session.add(p)
session.commit()
c = Child(name="foo", parent=p)
session.add(c)
session.commit()
session.query(Child).filter(Child.parent == p).delete("evaluate")
is_(inspect(c).deleted, True)
def test_delete_expired(self):
Parent, Child = self.classes("Parent", "Child")
session = fixture_session()
p = Parent(id=1)
session.add(p)
session.commit()
c = Child(name="foo", parent=p)
session.add(c)
session.commit()
session.query(Child).filter(Child.parent == p).delete("evaluate")
# because it's expired
is_(inspect(c).deleted, False)
# but it's gone
assert_raises(orm_exc.ObjectDeletedError, lambda: c.name)
|