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
|
from __future__ import annotations
from typing import TYPE_CHECKING
from uuid import UUID
import pytest
from sqlalchemy import Engine, ForeignKey, String
from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, async_sessionmaker
from sqlalchemy.orm import Mapped, Session, mapped_column, noload, relationship, selectinload, sessionmaker
from advanced_alchemy.repository import SQLAlchemyAsyncRepository, SQLAlchemySyncRepository
if TYPE_CHECKING:
from pytest import MonkeyPatch
pytestmark = [
pytest.mark.integration,
pytest.mark.xdist_group("loader_execution"),
]
@pytest.mark.xdist_group("loader")
def test_loader(monkeypatch: MonkeyPatch, engine: Engine) -> None:
# Skip mock engines as they don't support multi-row inserts with RETURNING
if getattr(engine.dialect, "name", "") == "mock":
pytest.skip("Mock engines don't support multi-row inserts with RETURNING")
# Skip CockroachDB as it has issues with loader options and BigInt primary keys
if "cockroach" in getattr(engine.dialect, "name", ""):
pytest.skip("CockroachDB has issues with loader options and BigInt primary keys")
from sqlalchemy.orm import DeclarativeBase
from advanced_alchemy import base, mixins
# Create a completely isolated registry for this test
orm_registry = base.create_registry()
# Use engine driver name in table names to avoid conflicts between engines sharing the same database
# (e.g., asyncpg and psycopg both report dialect.name as "postgresql")
engine_name = getattr(engine.dialect, "driver", getattr(engine.dialect, "name", "unknown")).replace("+", "_")
class NewUUIDBase(mixins.UUIDPrimaryKey, base.CommonTableAttributes, DeclarativeBase):
__abstract__ = True
registry = orm_registry
class NewBigIntBase(mixins.BigIntPrimaryKey, base.CommonTableAttributes, DeclarativeBase):
__abstract__ = True
registry = orm_registry
monkeypatch.setattr(base, "UUIDBase", NewUUIDBase)
monkeypatch.setattr(base, "BigIntBase", NewBigIntBase)
class UUIDCountry(NewUUIDBase):
__tablename__ = f"uuid_country_loader_{engine_name}"
name: Mapped[str] = mapped_column(String(length=50)) # pyright: ignore
states: Mapped[list[UUIDState]] = relationship(back_populates="country", uselist=True, lazy="noload")
class UUIDState(NewUUIDBase):
__tablename__ = f"uuid_state_loader_{engine_name}"
name: Mapped[str] = mapped_column(String(length=50)) # pyright: ignore
country_id: Mapped[UUID] = mapped_column(ForeignKey(f"uuid_country_loader_{engine_name}.id"))
country: Mapped[UUIDCountry] = relationship(uselist=False, back_populates="states", lazy="raise")
class USStateRepository(SQLAlchemySyncRepository[UUIDState]):
model_type = UUIDState
class CountryRepository(SQLAlchemySyncRepository[UUIDCountry]):
model_type = UUIDCountry
session_factory: sessionmaker[Session] = sessionmaker(engine, expire_on_commit=False)
with engine.begin() as conn:
# Create tables using the registry metadata
orm_registry.metadata.create_all(conn)
with session_factory() as db_session:
usa = UUIDCountry(name="United States of America")
france = UUIDCountry(name="France")
db_session.add(usa)
db_session.add(france)
db_session.flush() # Ensure countries are in session before creating states
california = UUIDState(name="California", country_id=usa.id)
oregon = UUIDState(name="Oregon", country_id=usa.id)
ile_de_france = UUIDState(name="Île-de-France", country_id=france.id)
repo = USStateRepository(session=db_session)
repo.add(california)
repo.add(oregon)
repo.add(ile_de_france)
db_session.commit()
db_session.expire_all()
si1_country_repo = CountryRepository(session=db_session, load=[noload(UUIDCountry.states)])
usa_country_1 = si1_country_repo.get_one(
name="United States of America",
)
assert len(usa_country_1.states) == 0
si0_country_repo = CountryRepository(session=db_session)
db_session.expire_all()
usa_country_0 = si0_country_repo.get_one(
name="United States of America",
load=UUIDCountry.states,
execution_options={"populate_existing": True},
)
assert len(usa_country_0.states) == 2
db_session.expire_all()
si2_country_repo = CountryRepository(session=db_session, load=[selectinload(UUIDCountry.states)])
usa_country_2 = si2_country_repo.get_one(name="United States of America")
assert len(usa_country_2.states) == 2
db_session.expire_all()
ia_repo = USStateRepository(session=db_session, load=UUIDState.country)
string_california = ia_repo.get_one(name="California")
assert string_california.name == "California"
db_session.expire_all()
star_repo = USStateRepository(session=db_session, load="*")
star_california = star_repo.get_one(name="California")
assert star_california.country.name == "United States of America"
db_session.expire_all()
star_country_repo = CountryRepository(session=db_session, load="*")
usa_country_3 = star_country_repo.get_one(name="United States of America")
assert len(usa_country_3.states) == 2
db_session.expunge_all()
db_session.expire_all()
si1_country_repo = CountryRepository(session=db_session)
usa_country_1 = si1_country_repo.get_one(
name="United States of America",
load=[noload(UUIDCountry.states)],
)
assert len(usa_country_1.states) == 0
si0_country_repo = CountryRepository(session=db_session)
db_session.expire_all()
@pytest.mark.xdist_group("loader")
async def test_async_loader(monkeypatch: MonkeyPatch, async_engine: AsyncEngine) -> None:
# Skip mock engines as they don't support multi-row inserts with RETURNING
if getattr(async_engine.dialect, "name", "") == "mock":
pytest.skip("Mock engines don't support multi-row inserts with RETURNING")
# Skip CockroachDB as it has issues with loader options and BigInt primary keys
if "cockroach" in getattr(async_engine.dialect, "name", ""):
pytest.skip("CockroachDB has issues with loader options and BigInt primary keys")
from sqlalchemy.orm import DeclarativeBase
from advanced_alchemy import base, mixins
# Create a completely isolated registry for this test
orm_registry = base.create_registry()
# Use engine driver name in table names to avoid conflicts between engines sharing the same database
# (e.g., asyncpg and psycopg both report dialect.name as "postgresql")
engine_name = getattr(async_engine.dialect, "driver", getattr(async_engine.dialect, "name", "unknown")).replace(
"+", "_"
)
class NewUUIDBase(mixins.UUIDPrimaryKey, base.CommonTableAttributes, DeclarativeBase):
__abstract__ = True
registry = orm_registry
class NewBigIntBase(mixins.BigIntPrimaryKey, base.CommonTableAttributes, DeclarativeBase):
__abstract__ = True
registry = orm_registry
monkeypatch.setattr(base, "UUIDBase", NewUUIDBase)
monkeypatch.setattr(base, "BigIntBase", NewBigIntBase)
class BigIntCountry(NewBigIntBase):
__tablename__ = f"bigint_country_async_{engine_name}"
name: Mapped[str] = mapped_column(String(length=50)) # pyright: ignore
states: Mapped[list[BigIntState]] = relationship(back_populates="country", uselist=True)
class BigIntState(NewBigIntBase):
__tablename__ = f"bigint_state_async_{engine_name}"
name: Mapped[str] = mapped_column(String(length=50)) # pyright: ignore
country_id: Mapped[int] = mapped_column(ForeignKey(f"bigint_country_async_{engine_name}.id"))
country: Mapped[BigIntCountry] = relationship(uselist=False, back_populates="states", lazy="raise")
class USStateRepository(SQLAlchemyAsyncRepository[BigIntState]):
model_type = BigIntState
class CountryRepository(SQLAlchemyAsyncRepository[BigIntCountry]):
model_type = BigIntCountry
session_factory: async_sessionmaker[AsyncSession] = async_sessionmaker(async_engine, expire_on_commit=False)
async with async_engine.begin() as conn:
# Create tables using the registry metadata
await conn.run_sync(orm_registry.metadata.create_all)
async with session_factory() as db_session:
usa = BigIntCountry(name="United States of America")
france = BigIntCountry(name="France")
db_session.add(usa)
db_session.add(france)
await db_session.flush() # Ensure countries are in session before creating states
california = BigIntState(name="California", country_id=usa.id)
oregon = BigIntState(name="Oregon", country_id=usa.id)
ile_de_france = BigIntState(name="Île-de-France", country_id=france.id)
repo = USStateRepository(session=db_session)
await repo.add(california)
await repo.add(oregon)
await repo.add(ile_de_france)
await db_session.commit()
db_session.expire_all()
si1_country_repo = CountryRepository(session=db_session, load=[noload(BigIntCountry.states)])
usa_country_21 = await si1_country_repo.get_one(
name="United States of America",
)
assert len(usa_country_21.states) == 0
db_session.expire_all()
si0_country_repo = CountryRepository(session=db_session)
usa_country_0 = await si0_country_repo.get_one(
name="United States of America",
load=BigIntCountry.states,
execution_options={"populate_existing": True},
)
assert len(usa_country_0.states) == 2
db_session.expire_all()
country_repo = CountryRepository(session=db_session)
usa_country_1 = await country_repo.get_one(
name="United States of America",
load=[selectinload(BigIntCountry.states)],
)
assert len(usa_country_1.states) == 2
db_session.expire_all()
si_country_repo = CountryRepository(session=db_session, load=[selectinload(BigIntCountry.states)])
usa_country_02 = await si_country_repo.get_one(name="United States of America")
assert len(usa_country_02.states) == 2
db_session.expire_all()
ia_repo = USStateRepository(session=db_session, load=BigIntState.country)
string_california = await ia_repo.get_one(name="California")
assert string_california.name == "California"
db_session.expire_all()
star_repo = USStateRepository(session=db_session, load="*")
star_california = await star_repo.get_one(name="California")
assert star_california.country.name == "United States of America"
db_session.expire_all()
star_country_repo = CountryRepository(session=db_session, load="*")
usa_country_3 = await star_country_repo.get_one(name="United States of America")
assert len(usa_country_3.states) == 2
db_session.expire_all()
@pytest.mark.xdist_group("loader")
def test_default_overrides_loader(monkeypatch: MonkeyPatch, engine: Engine) -> None:
# Skip mock engines as they don't support multi-row inserts with RETURNING
if getattr(engine.dialect, "name", "") == "mock":
pytest.skip("Mock engines don't support multi-row inserts with RETURNING")
# Skip CockroachDB as it has issues with loader options and BigInt primary keys
if "cockroach" in getattr(engine.dialect, "name", ""):
pytest.skip("CockroachDB has issues with loader options and BigInt primary keys")
from sqlalchemy.orm import DeclarativeBase
from advanced_alchemy import base, mixins
# Create a completely isolated registry for this test
orm_registry = base.create_registry()
# Use engine driver name in table names to avoid conflicts between engines sharing the same database
# (e.g., asyncpg and psycopg both report dialect.name as "postgresql")
engine_name = getattr(engine.dialect, "driver", getattr(engine.dialect, "name", "unknown")).replace("+", "_")
class NewUUIDBase(mixins.UUIDPrimaryKey, base.CommonTableAttributes, DeclarativeBase):
__abstract__ = True
registry = orm_registry
class NewBigIntBase(mixins.BigIntPrimaryKey, base.CommonTableAttributes, DeclarativeBase):
__abstract__ = True
registry = orm_registry
monkeypatch.setattr(base, "UUIDBase", NewUUIDBase)
monkeypatch.setattr(base, "BigIntBase", NewBigIntBase)
class UUIDCountryTest(NewUUIDBase):
__tablename__ = f"uuid_country_override_{engine_name}"
name: Mapped[str] = mapped_column(String(length=50)) # pyright: ignore
states: Mapped[list[UUIDStateTest]] = relationship(back_populates="country", uselist=True, lazy="selectin")
class UUIDStateTest(NewUUIDBase):
__tablename__ = f"uuid_state_override_{engine_name}"
name: Mapped[str] = mapped_column(String(length=50)) # pyright: ignore
country_id: Mapped[UUID] = mapped_column(ForeignKey(f"uuid_country_override_{engine_name}.id"))
country: Mapped[UUIDCountryTest] = relationship(uselist=False, back_populates="states", lazy="noload")
class USStateRepository(SQLAlchemySyncRepository[UUIDStateTest]):
model_type = UUIDStateTest
merge_loader_options = False
loader_options = [noload(UUIDStateTest.country)]
class CountryRepository(SQLAlchemySyncRepository[UUIDCountryTest]):
inherit_lazy_relationships = False
model_type = UUIDCountryTest
session_factory: sessionmaker[Session] = sessionmaker(engine, expire_on_commit=False)
with engine.begin() as conn:
# Create tables using the registry metadata
orm_registry.metadata.create_all(conn)
with session_factory() as db_session:
usa = UUIDCountryTest(name="United States of America")
france = UUIDCountryTest(name="France")
db_session.add(usa)
db_session.add(france)
db_session.flush() # Ensure countries are in session before creating states
california = UUIDStateTest(name="California", country_id=usa.id)
oregon = UUIDStateTest(name="Oregon", country_id=usa.id)
ile_de_france = UUIDStateTest(name="Île-de-France", country_id=france.id)
repo = USStateRepository(session=db_session)
repo.add(california)
repo.add(oregon)
repo.add(ile_de_france)
db_session.commit()
db_session.expire_all()
si1_country_repo = CountryRepository(session=db_session)
usa_country_1 = si1_country_repo.get_one(
name="United States of America",
)
assert len(usa_country_1.states) == 2
usa_country_2 = si1_country_repo.get_one(
name="United States of America",
load="*",
execution_options={"populate_existing": True},
)
assert len(usa_country_2.states) == 2
@pytest.mark.xdist_group("loader")
async def test_default_overrides_async_loader(monkeypatch: MonkeyPatch, async_engine: AsyncEngine) -> None:
# Skip mock engines as they don't support multi-row inserts with RETURNING
if getattr(async_engine.dialect, "name", "") == "mock":
pytest.skip("Mock engines don't support multi-row inserts with RETURNING")
# Skip CockroachDB as it has issues with loader options and BigInt primary keys
if "cockroach" in getattr(async_engine.dialect, "name", ""):
pytest.skip("CockroachDB has issues with loader options and BigInt primary keys")
from sqlalchemy.orm import DeclarativeBase
from advanced_alchemy import base, mixins
# Create a completely isolated registry for this test
orm_registry = base.create_registry()
# Use engine driver name in table names to avoid conflicts between engines sharing the same database
# (e.g., asyncpg and psycopg both report dialect.name as "postgresql")
engine_name = getattr(async_engine.dialect, "driver", getattr(async_engine.dialect, "name", "unknown")).replace(
"+", "_"
)
class NewUUIDBase(mixins.UUIDPrimaryKey, base.CommonTableAttributes, DeclarativeBase):
__abstract__ = True
registry = orm_registry
class NewBigIntBase(mixins.BigIntPrimaryKey, base.CommonTableAttributes, DeclarativeBase):
__abstract__ = True
registry = orm_registry
monkeypatch.setattr(base, "UUIDBase", NewUUIDBase)
monkeypatch.setattr(base, "BigIntBase", NewBigIntBase)
class BigIntCountryTest(NewBigIntBase):
__tablename__ = f"bigint_country_override_{engine_name}"
name: Mapped[str] = mapped_column(String(length=50)) # pyright: ignore
states: Mapped[list[BigIntStateTest]] = relationship(back_populates="country", uselist=True, lazy="selectin")
notes: Mapped[list[BigIntCountryNote]] = relationship(back_populates="country", uselist=True, lazy="selectin")
class BigIntCountryNote(NewBigIntBase):
__tablename__ = f"bigint_note_override_{engine_name}"
name: Mapped[str] = mapped_column(String(length=50)) # pyright: ignore
country_id: Mapped[int] = mapped_column(ForeignKey(f"bigint_country_override_{engine_name}.id"))
country: Mapped[BigIntCountryTest] = relationship(uselist=False, back_populates="notes", lazy="raise")
class BigIntStateTest(NewBigIntBase):
__tablename__ = f"bigint_state_override_{engine_name}"
name: Mapped[str] = mapped_column(String(length=50)) # pyright: ignore
country_id: Mapped[int] = mapped_column(ForeignKey(f"bigint_country_override_{engine_name}.id"))
country: Mapped[BigIntCountryTest] = relationship(uselist=False, back_populates="states", lazy="raise")
class USStateRepository(SQLAlchemyAsyncRepository[BigIntStateTest]):
model_type = BigIntStateTest
class CountryRepository(SQLAlchemyAsyncRepository[BigIntCountryTest]):
model_type = BigIntCountryTest
merge_loader_options = False
loader_options = [noload(BigIntCountryTest.states), noload(BigIntCountryTest.notes)]
session_factory: async_sessionmaker[AsyncSession] = async_sessionmaker(async_engine, expire_on_commit=False)
async with async_engine.begin() as conn:
# Create tables using the registry metadata
await conn.run_sync(orm_registry.metadata.create_all)
async with session_factory() as db_session:
usa = BigIntCountryTest(name="United States of America")
usa.notes.append(BigIntCountryNote(name="Note 1"))
france = BigIntCountryTest(name="France")
db_session.add(usa)
db_session.add(france)
await db_session.flush() # Ensure countries are in session before creating states
california = BigIntStateTest(name="California", country_id=usa.id)
oregon = BigIntStateTest(name="Oregon", country_id=usa.id)
ile_de_france = BigIntStateTest(name="Île-de-France", country_id=france.id)
repo = USStateRepository(session=db_session)
await repo.add(california)
await repo.add(oregon)
await repo.add(ile_de_france)
await db_session.commit()
db_session.expire_all()
si1_country_repo = CountryRepository(session=db_session, load=[noload(BigIntCountryTest.states)])
usa_country_21 = await si1_country_repo.get_one(
name="United States of America",
)
assert len(usa_country_21.states) == 0
db_session.expire_all()
si0_country_repo = CountryRepository(session=db_session)
usa_country_0 = await si0_country_repo.get_one(
name="United States of America",
load=BigIntCountryTest.states,
execution_options={"populate_existing": True},
)
assert len(usa_country_0.states) == 2
db_session.expire_all()
country_repo = CountryRepository(session=db_session)
usa_country_1 = await country_repo.get_one(
name="United States of America",
load=[selectinload(BigIntCountryTest.states)],
)
assert len(usa_country_1.states) == 2
db_session.expire_all()
si_country_repo = CountryRepository(session=db_session, load=[noload(BigIntCountryTest.notes)])
usa_country_02 = await si_country_repo.get_one(
name="United States of America", load=[selectinload(BigIntCountryTest.states)]
)
assert len(usa_country_02.notes) == 1
db_session.expire_all()
|
