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 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
|
from sqlalchemy import Column
from sqlalchemy import event
from sqlalchemy import exc
from sqlalchemy import ForeignKey
from sqlalchemy import func
from sqlalchemy import inspect
from sqlalchemy import Integer
from sqlalchemy import select
from sqlalchemy import Table
from sqlalchemy import testing
from sqlalchemy import update
from sqlalchemy.ext.asyncio import async_object_session
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.ext.asyncio import exc as async_exc
from sqlalchemy.ext.asyncio.base import ReversibleProxy
from sqlalchemy.orm import relationship
from sqlalchemy.orm import selectinload
from sqlalchemy.orm import Session
from sqlalchemy.orm import sessionmaker
from sqlalchemy.testing import async_test
from sqlalchemy.testing import engines
from sqlalchemy.testing import eq_
from sqlalchemy.testing import expect_raises_message
from sqlalchemy.testing import is_
from sqlalchemy.testing import is_true
from sqlalchemy.testing import mock
from sqlalchemy.testing.assertions import is_false
from .test_engine_py3k import AsyncFixture as _AsyncFixture
from ...orm import _fixtures
class AsyncFixture(_AsyncFixture, _fixtures.FixtureTest):
__requires__ = ("async_dialect",)
@classmethod
def setup_mappers(cls):
cls._setup_stock_mapping()
@testing.fixture
def async_engine(self):
return engines.testing_engine(asyncio=True, transfer_staticpool=True)
@testing.fixture
def async_session(self, async_engine):
return AsyncSession(async_engine)
class AsyncSessionTest(AsyncFixture):
def test_requires_async_engine(self, async_engine):
testing.assert_raises_message(
exc.ArgumentError,
"AsyncEngine expected, got Engine",
AsyncSession,
bind=async_engine.sync_engine,
)
def test_info(self, async_session):
async_session.info["foo"] = "bar"
eq_(async_session.sync_session.info, {"foo": "bar"})
def test_init(self, async_engine):
ss = AsyncSession(bind=async_engine)
is_(ss.bind, async_engine)
binds = {Table: async_engine}
ss = AsyncSession(binds=binds)
is_(ss.binds, binds)
class AsyncSessionQueryTest(AsyncFixture):
@async_test
@testing.combinations(
{}, dict(execution_options={"logging_token": "test"}), argnames="kw"
)
async def test_execute(self, async_session, kw):
User = self.classes.User
stmt = (
select(User)
.options(selectinload(User.addresses))
.order_by(User.id)
)
result = await async_session.execute(stmt, **kw)
eq_(result.scalars().all(), self.static.user_address_result)
@async_test
async def test_scalar(self, async_session):
User = self.classes.User
stmt = select(User.id).order_by(User.id).limit(1)
result = await async_session.scalar(stmt)
eq_(result, 7)
@testing.combinations(
("scalars",), ("stream_scalars",), argnames="filter_"
)
@async_test
async def test_scalars(self, async_session, filter_):
User = self.classes.User
stmt = (
select(User)
.options(selectinload(User.addresses))
.order_by(User.id)
)
if filter_ == "scalars":
result = (await async_session.scalars(stmt)).all()
elif filter_ == "stream_scalars":
result = await (await async_session.stream_scalars(stmt)).all()
eq_(result, self.static.user_address_result)
@async_test
async def test_get(self, async_session):
User = self.classes.User
u1 = await async_session.get(User, 7)
eq_(u1.name, "jack")
u2 = await async_session.get(User, 7)
is_(u1, u2)
u3 = await async_session.get(User, 12)
is_(u3, None)
@async_test
async def test_get_loader_options(self, async_session):
User = self.classes.User
u = await async_session.get(
User, 7, options=[selectinload(User.addresses)]
)
eq_(u.name, "jack")
eq_(len(u.__dict__["addresses"]), 1)
@async_test
@testing.requires.independent_cursors
@testing.combinations(
{}, dict(execution_options={"logging_token": "test"}), argnames="kw"
)
async def test_stream_partitions(self, async_session, kw):
User = self.classes.User
stmt = (
select(User)
.options(selectinload(User.addresses))
.order_by(User.id)
)
result = await async_session.stream(stmt, **kw)
assert_result = []
async for partition in result.scalars().partitions(3):
assert_result.append(partition)
eq_(
assert_result,
[
self.static.user_address_result[0:3],
self.static.user_address_result[3:],
],
)
@testing.combinations("statement", "execute", argnames="location")
@async_test
async def test_no_ss_cursor_w_execute(self, async_session, location):
User = self.classes.User
stmt = select(User)
if location == "statement":
stmt = stmt.execution_options(stream_results=True)
with expect_raises_message(
async_exc.AsyncMethodRequired,
r"Can't use the AsyncSession.execute\(\) method with a "
r"server-side cursor. Use the AsyncSession.stream\(\) "
r"method for an async streaming result set.",
):
if location == "execute":
await async_session.execute(
stmt, execution_options={"stream_results": True}
)
else:
await async_session.execute(stmt)
class AsyncSessionTransactionTest(AsyncFixture):
run_inserts = None
@async_test
async def test_interrupt_ctxmanager_connection(
self, async_trans_ctx_manager_fixture, async_session
):
fn = async_trans_ctx_manager_fixture
await fn(async_session, trans_on_subject=True, execute_on_subject=True)
@async_test
async def test_sessionmaker_block_one(self, async_engine):
User = self.classes.User
maker = sessionmaker(async_engine, class_=AsyncSession)
session = maker()
async with session.begin():
u1 = User(name="u1")
assert session.in_transaction()
session.add(u1)
assert not session.in_transaction()
async with maker() as session:
result = await session.execute(
select(User).where(User.name == "u1")
)
u1 = result.scalar_one()
eq_(u1.name, "u1")
@async_test
async def test_sessionmaker_block_two(self, async_engine):
User = self.classes.User
maker = sessionmaker(async_engine, class_=AsyncSession)
async with maker.begin() as session:
u1 = User(name="u1")
assert session.in_transaction()
session.add(u1)
assert not session.in_transaction()
async with maker() as session:
result = await session.execute(
select(User).where(User.name == "u1")
)
u1 = result.scalar_one()
eq_(u1.name, "u1")
@async_test
async def test_trans(self, async_session, async_engine):
async with async_engine.connect() as outer_conn:
User = self.classes.User
async with async_session.begin():
eq_(await outer_conn.scalar(select(func.count(User.id))), 0)
u1 = User(name="u1")
async_session.add(u1)
result = await async_session.execute(select(User))
eq_(result.scalar(), u1)
await outer_conn.rollback()
eq_(await outer_conn.scalar(select(func.count(User.id))), 1)
@async_test
async def test_commit_as_you_go(self, async_session, async_engine):
async with async_engine.connect() as outer_conn:
User = self.classes.User
eq_(await outer_conn.scalar(select(func.count(User.id))), 0)
u1 = User(name="u1")
async_session.add(u1)
result = await async_session.execute(select(User))
eq_(result.scalar(), u1)
await async_session.commit()
await outer_conn.rollback()
eq_(await outer_conn.scalar(select(func.count(User.id))), 1)
@async_test
async def test_trans_noctx(self, async_session, async_engine):
async with async_engine.connect() as outer_conn:
User = self.classes.User
trans = await async_session.begin()
try:
eq_(await outer_conn.scalar(select(func.count(User.id))), 0)
u1 = User(name="u1")
async_session.add(u1)
result = await async_session.execute(select(User))
eq_(result.scalar(), u1)
finally:
await trans.commit()
await outer_conn.rollback()
eq_(await outer_conn.scalar(select(func.count(User.id))), 1)
@async_test
async def test_delete(self, async_session):
User = self.classes.User
async with async_session.begin():
u1 = User(name="u1")
async_session.add(u1)
await async_session.flush()
conn = await async_session.connection()
eq_(await conn.scalar(select(func.count(User.id))), 1)
await async_session.delete(u1)
await async_session.flush()
eq_(await conn.scalar(select(func.count(User.id))), 0)
@async_test
async def test_flush(self, async_session):
User = self.classes.User
async with async_session.begin():
u1 = User(name="u1")
async_session.add(u1)
conn = await async_session.connection()
eq_(await conn.scalar(select(func.count(User.id))), 0)
await async_session.flush()
eq_(await conn.scalar(select(func.count(User.id))), 1)
@async_test
async def test_refresh(self, async_session):
User = self.classes.User
async with async_session.begin():
u1 = User(name="u1")
async_session.add(u1)
await async_session.flush()
conn = await async_session.connection()
await conn.execute(
update(User)
.values(name="u2")
.execution_options(synchronize_session=None)
)
eq_(u1.name, "u1")
await async_session.refresh(u1)
eq_(u1.name, "u2")
eq_(await conn.scalar(select(func.count(User.id))), 1)
@async_test
async def test_merge(self, async_session):
User = self.classes.User
async with async_session.begin():
u1 = User(id=1, name="u1")
async_session.add(u1)
async with async_session.begin():
new_u = User(id=1, name="new u1")
new_u_merged = await async_session.merge(new_u)
is_(new_u_merged, u1)
eq_(u1.name, "new u1")
@async_test
async def test_merge_loader_options(self, async_session):
User = self.classes.User
Address = self.classes.Address
async with async_session.begin():
u1 = User(id=1, name="u1", addresses=[Address(email_address="e1")])
async_session.add(u1)
await async_session.close()
async with async_session.begin():
new_u1 = User(id=1, name="new u1")
new_u_merged = await async_session.merge(
new_u1, options=[selectinload(User.addresses)]
)
eq_(new_u_merged.name, "new u1")
eq_(len(new_u_merged.__dict__["addresses"]), 1)
@async_test
async def test_join_to_external_transaction(self, async_engine):
User = self.classes.User
async with async_engine.connect() as conn:
t1 = await conn.begin()
async_session = AsyncSession(conn)
aconn = await async_session.connection()
eq_(aconn.get_transaction(), t1)
eq_(aconn, conn)
is_(aconn.sync_connection, conn.sync_connection)
u1 = User(id=1, name="u1")
async_session.add(u1)
await async_session.commit()
assert conn.in_transaction()
await conn.rollback()
async with AsyncSession(async_engine) as async_session:
result = await async_session.execute(select(User))
eq_(result.all(), [])
@testing.requires.savepoints
@async_test
async def test_join_to_external_transaction_with_savepoints(
self, async_engine
):
"""This is the full 'join to an external transaction' recipe
implemented for async using savepoints.
It's not particularly simple to understand as we have to switch between
async / sync APIs but it works and it's a start.
"""
User = self.classes.User
async with async_engine.connect() as conn:
await conn.begin()
await conn.begin_nested()
async_session = AsyncSession(conn)
@event.listens_for(
async_session.sync_session, "after_transaction_end"
)
def end_savepoint(session, transaction):
"""here's an event. inside the event we write blocking
style code. wow will this be fun to try to explain :)
"""
if conn.closed:
return
if not conn.in_nested_transaction():
conn.sync_connection.begin_nested()
aconn = await async_session.connection()
is_(aconn.sync_connection, conn.sync_connection)
u1 = User(id=1, name="u1")
async_session.add(u1)
await async_session.commit()
result = (await async_session.execute(select(User))).all()
eq_(len(result), 1)
u2 = User(id=2, name="u2")
async_session.add(u2)
await async_session.flush()
result = (await async_session.execute(select(User))).all()
eq_(len(result), 2)
# a rollback inside the session ultimately ends the savepoint
await async_session.rollback()
# but the previous thing we "committed" is still in the DB
result = (await async_session.execute(select(User))).all()
eq_(len(result), 1)
assert conn.in_transaction()
await conn.rollback()
async with AsyncSession(async_engine) as async_session:
result = await async_session.execute(select(User))
eq_(result.all(), [])
@async_test
@testing.requires.independent_connections
async def test_invalidate(self, async_session):
await async_session.execute(select(1))
conn = async_session.sync_session.connection()
fairy = conn.connection
connection_rec = fairy._connection_record
is_false(conn.closed)
is_false(connection_rec._is_hard_or_soft_invalidated())
await async_session.invalidate()
is_true(conn.closed)
is_true(connection_rec._is_hard_or_soft_invalidated())
eq_(async_session.in_transaction(), False)
class AsyncCascadesTest(AsyncFixture):
run_inserts = None
@classmethod
def setup_mappers(cls):
User, Address = cls.classes("User", "Address")
users, addresses = cls.tables("users", "addresses")
cls.mapper(
User,
users,
properties={
"addresses": relationship(
Address, cascade="all, delete-orphan"
)
},
)
cls.mapper(
Address,
addresses,
)
@async_test
async def test_delete_w_cascade(self, async_session):
User = self.classes.User
Address = self.classes.Address
async with async_session.begin():
u1 = User(id=1, name="u1", addresses=[Address(email_address="e1")])
async_session.add(u1)
async with async_session.begin():
u1 = (await async_session.execute(select(User))).scalar_one()
await async_session.delete(u1)
eq_(
(
await async_session.execute(
select(func.count()).select_from(Address)
)
).scalar(),
0,
)
class AsyncORMBehaviorsTest(AsyncFixture):
@testing.fixture
def one_to_one_fixture(self, registry, async_engine):
async def go(legacy_inactive_history_style):
@registry.mapped
class A:
__tablename__ = "a"
id = Column(Integer, primary_key=True)
b = relationship(
"B",
uselist=False,
_legacy_inactive_history_style=(
legacy_inactive_history_style
),
)
@registry.mapped
class B:
__tablename__ = "b"
id = Column(Integer, primary_key=True)
a_id = Column(ForeignKey("a.id"))
async with async_engine.begin() as conn:
await conn.run_sync(registry.metadata.create_all)
return A, B
return go
@testing.combinations(
(
"legacy_style",
True,
),
(
"new_style",
False,
),
argnames="_legacy_inactive_history_style",
id_="ia",
)
@async_test
async def test_new_style_active_history(
self, async_session, one_to_one_fixture, _legacy_inactive_history_style
):
A, B = await one_to_one_fixture(_legacy_inactive_history_style)
a1 = A()
b1 = B()
a1.b = b1
async_session.add(a1)
await async_session.commit()
b2 = B()
if _legacy_inactive_history_style:
# aiomysql dialect having problems here, emitting weird
# pytest warnings and we might need to just skip for aiomysql
# here, which is also raising StatementError w/ MissingGreenlet
# inside of it
with testing.expect_raises(
(exc.StatementError, exc.MissingGreenlet)
):
a1.b = b2
else:
a1.b = b2
await async_session.flush()
await async_session.refresh(b1)
eq_(
(
await async_session.execute(
select(func.count())
.where(B.id == b1.id)
.where(B.a_id == None)
)
).scalar(),
1,
)
class AsyncEventTest(AsyncFixture):
"""The engine events all run in their normal synchronous context.
we do not provide an asyncio event interface at this time.
"""
__backend__ = True
@async_test
async def test_no_async_listeners(self, async_session):
with testing.expect_raises_message(
NotImplementedError,
"asynchronous events are not implemented at this time. "
"Apply synchronous listeners to the AsyncSession.sync_session.",
):
event.listen(async_session, "before_flush", mock.Mock())
@async_test
async def test_sync_before_commit(self, async_session):
canary = mock.Mock()
event.listen(async_session.sync_session, "before_commit", canary)
async with async_session.begin():
pass
eq_(
canary.mock_calls,
[mock.call(async_session.sync_session)],
)
class AsyncProxyTest(AsyncFixture):
@async_test
async def test_get_connection_engine_bound(self, async_session):
c1 = await async_session.connection()
c2 = await async_session.connection()
is_(c1, c2)
is_(c1.engine, c2.engine)
@async_test
async def test_get_connection_kws(self, async_session):
c1 = await async_session.connection(
execution_options={"isolation_level": "AUTOCOMMIT"}
)
eq_(
c1.sync_connection._execution_options,
{"isolation_level": "AUTOCOMMIT"},
)
@async_test
async def test_get_connection_connection_bound(self, async_engine):
async with async_engine.begin() as conn:
async_session = AsyncSession(conn)
c1 = await async_session.connection()
is_(c1, conn)
is_(c1.engine, conn.engine)
@async_test
async def test_get_transaction(self, async_session):
is_(async_session.get_transaction(), None)
is_(async_session.get_nested_transaction(), None)
t1 = await async_session.begin()
is_(async_session.get_transaction(), t1)
is_(async_session.get_nested_transaction(), None)
n1 = await async_session.begin_nested()
is_(async_session.get_transaction(), t1)
is_(async_session.get_nested_transaction(), n1)
await n1.commit()
is_(async_session.get_transaction(), t1)
is_(async_session.get_nested_transaction(), None)
await t1.commit()
is_(async_session.get_transaction(), None)
is_(async_session.get_nested_transaction(), None)
@async_test
async def test_async_object_session(self, async_engine):
User = self.classes.User
s1 = AsyncSession(async_engine)
s2 = AsyncSession(async_engine)
u1 = await s1.get(User, 7)
u2 = User(name="n1")
s2.add(u2)
u3 = User(name="n2")
is_(async_object_session(u1), s1)
is_(async_object_session(u2), s2)
is_(async_object_session(u3), None)
await s2.close()
is_(async_object_session(u2), None)
@async_test
async def test_async_object_session_custom(self, async_engine):
User = self.classes.User
class MyCustomAsync(AsyncSession):
pass
s1 = MyCustomAsync(async_engine)
u1 = await s1.get(User, 7)
assert isinstance(async_object_session(u1), MyCustomAsync)
@testing.requires.predictable_gc
@async_test
async def test_async_object_session_del(self, async_engine):
User = self.classes.User
s1 = AsyncSession(async_engine)
u1 = await s1.get(User, 7)
is_(async_object_session(u1), s1)
await s1.rollback()
del s1
is_(async_object_session(u1), None)
@async_test
async def test_inspect_session(self, async_engine):
User = self.classes.User
s1 = AsyncSession(async_engine)
s2 = AsyncSession(async_engine)
u1 = await s1.get(User, 7)
u2 = User(name="n1")
s2.add(u2)
u3 = User(name="n2")
is_(inspect(u1).async_session, s1)
is_(inspect(u2).async_session, s2)
is_(inspect(u3).async_session, None)
def test_inspect_session_no_asyncio_used(self):
User = self.classes.User
s1 = Session(testing.db)
u1 = s1.get(User, 7)
is_(inspect(u1).async_session, None)
def test_inspect_session_no_asyncio_imported(self):
with mock.patch("sqlalchemy.orm.state._async_provider", None):
User = self.classes.User
s1 = Session(testing.db)
u1 = s1.get(User, 7)
is_(inspect(u1).async_session, None)
@testing.requires.predictable_gc
def test_gc(self, async_engine):
ReversibleProxy._proxy_objects.clear()
eq_(len(ReversibleProxy._proxy_objects), 0)
async_session = AsyncSession(async_engine)
eq_(len(ReversibleProxy._proxy_objects), 1)
del async_session
eq_(len(ReversibleProxy._proxy_objects), 0)
class _MySession(Session):
pass
class _MyAS(AsyncSession):
sync_session_class = _MySession
class OverrideSyncSession(AsyncFixture):
def test_default(self, async_engine):
ass = AsyncSession(async_engine)
is_true(isinstance(ass.sync_session, Session))
is_(ass.sync_session.__class__, Session)
is_(ass.sync_session_class, Session)
def test_init_class(self, async_engine):
ass = AsyncSession(async_engine, sync_session_class=_MySession)
is_true(isinstance(ass.sync_session, _MySession))
is_(ass.sync_session_class, _MySession)
def test_init_sessionmaker(self, async_engine):
sm = sessionmaker(
async_engine, class_=AsyncSession, sync_session_class=_MySession
)
ass = sm()
is_true(isinstance(ass.sync_session, _MySession))
is_(ass.sync_session_class, _MySession)
def test_subclass(self, async_engine):
ass = _MyAS(async_engine)
is_true(isinstance(ass.sync_session, _MySession))
is_(ass.sync_session_class, _MySession)
def test_subclass_override(self, async_engine):
ass = _MyAS(async_engine, sync_session_class=Session)
is_true(not isinstance(ass.sync_session, _MySession))
is_(ass.sync_session_class, Session)
|