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
|
from __future__ import annotations
import datetime
import sys
from typing import TYPE_CHECKING, Annotated, ClassVar
from uuid import UUID, uuid4
import pytest
import sqlalchemy
from litestar import Request, get
from litestar.dto import DTOField, Mark
from litestar.dto.field import DTO_FIELD_META_KEY
from litestar.enums import MediaType
from litestar.plugins.pydantic import PydanticInitPlugin
from litestar.serialization import encode_json
from litestar.testing import RequestFactory
from litestar.typing import FieldDefinition
from sqlalchemy import ForeignKey, func
from sqlalchemy.orm import DeclarativeBase, Mapped, MappedAsDataclass, declared_attr, mapped_column, relationship
from typing_extensions import TypeVar
from advanced_alchemy.exceptions import ImproperConfigurationError
from advanced_alchemy.extensions.litestar.dto import (
SQLAlchemyDTO,
SQLAlchemyDTOConfig,
parse_type_from_element, # type: ignore
)
if TYPE_CHECKING:
from collections.abc import Callable
from types import ModuleType
from typing import Any
@pytest.fixture(name="base")
def fx_base() -> type[DeclarativeBase]:
class Base(DeclarativeBase):
id: Mapped[UUID] = mapped_column(default=uuid4, primary_key=True)
created: Mapped[datetime.datetime] = mapped_column(
default=datetime.datetime.now,
info={DTO_FIELD_META_KEY: DTOField(mark=Mark.READ_ONLY)},
)
updated: Mapped[datetime.datetime] = mapped_column(
default=datetime.datetime.now,
info={DTO_FIELD_META_KEY: DTOField(mark=Mark.READ_ONLY)},
)
# noinspection PyMethodParameters
@declared_attr.directive
def __tablename__(cls) -> str:
"""Infer table name from class name."""
return cls.__name__.lower()
return Base
@pytest.fixture(name="author_model")
def fx_author_model(base: DeclarativeBase) -> type[DeclarativeBase]:
class Author(base): # type: ignore
name: Mapped[str]
dob: Mapped[datetime.date]
return Author
@pytest.fixture(name="raw_author")
def fx_raw_author() -> bytes:
return b'{"id":"97108ac1-ffcb-411d-8b1e-d9183399f63b","name":"Agatha Christie","dob":"1890-09-15","created":"0001-01-01T00:00:00","updated":"0001-01-01T00:00:00"}'
@pytest.fixture(name="asgi_connection")
def fx_asgi_connection() -> Request[Any, Any, Any]:
@get("/", name="handler_id", media_type=MediaType.JSON, type_decoders=PydanticInitPlugin.decoders())
def _handler() -> None: ...
return RequestFactory().get(path="/", route_handler=_handler)
T = TypeVar("T")
DataT = TypeVar("DataT", bound=DeclarativeBase)
async def get_model_from_dto(
dto_type: type[SQLAlchemyDTO[DataT]],
annotation: Any,
asgi_connection: Request[Any, Any, Any],
raw: bytes,
) -> Any:
dto_type.create_for_field_definition(
handler_id=asgi_connection.route_handler.handler_id,
field_definition=FieldDefinition.from_kwarg(annotation, name="data"),
)
dto_type.create_for_field_definition(
handler_id=asgi_connection.route_handler.handler_id,
field_definition=FieldDefinition.from_kwarg(annotation, name="return"),
)
return dto_type(asgi_connection).decode_bytes(raw)
def assert_model_values(model_instance: DeclarativeBase, expected_values: dict[str, Any]) -> None:
assert {k: v for k, v in model_instance.__dict__.items() if not k.startswith("_")} == expected_values
async def test_model_write_dto(
author_model: type[DeclarativeBase],
raw_author: bytes,
asgi_connection: Request[Any, Any, Any],
) -> None:
model = await get_model_from_dto(SQLAlchemyDTO[author_model], author_model, asgi_connection, raw_author) # type: ignore
assert_model_values(
model,
{
"id": UUID("97108ac1-ffcb-411d-8b1e-d9183399f63b"),
"name": "Agatha Christie",
"dob": datetime.date(1890, 9, 15),
},
)
async def test_model_read_dto(
author_model: type[DeclarativeBase],
raw_author: bytes,
asgi_connection: Request[Any, Any, Any],
) -> None:
config = SQLAlchemyDTOConfig()
dto_type = SQLAlchemyDTO[Annotated[author_model, config]] # type: ignore
model = await get_model_from_dto(dto_type, author_model, asgi_connection, raw_author)
assert_model_values(
model,
{
"id": UUID("97108ac1-ffcb-411d-8b1e-d9183399f63b"),
"name": "Agatha Christie",
"dob": datetime.date(1890, 9, 15),
},
)
async def test_model_list_dto(author_model: type[DeclarativeBase], asgi_connection: Request[Any, Any, Any]) -> None:
dto_type = SQLAlchemyDTO[author_model] # type: ignore
raw = b'[{"id": "97108ac1-ffcb-411d-8b1e-d9183399f63b","name":"Agatha Christie","dob":"1890-09-15","created":"0001-01-01T00:00:00","updated":"0001-01-01T00:00:00"}]'
dto_data = await get_model_from_dto(dto_type, list[author_model], asgi_connection, raw) # type: ignore
assert isinstance(dto_data, list)
assert_model_values(
dto_data[0], # type: ignore
{
"id": UUID("97108ac1-ffcb-411d-8b1e-d9183399f63b"),
"name": "Agatha Christie",
"dob": datetime.date(1890, 9, 15),
},
)
async def test_dto_exclude(
author_model: type[DeclarativeBase],
raw_author: bytes,
asgi_connection: Request[Any, Any, Any],
) -> None:
config = SQLAlchemyDTOConfig(exclude={"id"})
model = await get_model_from_dto(
SQLAlchemyDTO[Annotated[author_model, config]], # type: ignore
author_model,
asgi_connection,
raw_author,
)
assert "id" not in vars(model)
async def test_write_dto_field_default(base: type[DeclarativeBase], asgi_connection: Request[Any, Any, Any]) -> None:
class Model(base): # type: ignore
field: Mapped[int] = mapped_column(default=3)
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig(exclude={"id", "created", "updated"})]]
model = await get_model_from_dto(dto_type, Model, asgi_connection, b'{"a":"b"}')
assert_model_values(model, {"field": 3})
async def test_write_dto_for_model_field_factory_default(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
val = uuid4()
class Model(base): # type: ignore
field: Mapped[UUID] = mapped_column(default=lambda: val)
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig(exclude={"id", "created", "updated"})]]
model = await get_model_from_dto(dto_type, Model, asgi_connection, b'{"a":"b"}')
assert_model_values(model, {"field": val})
async def test_dto_instrumented_attribute_key(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
val = uuid4()
class Model(base): # type: ignore
field: Mapped[UUID] = mapped_column(default=lambda: val)
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig(exclude={Model.id, Model.created, Model.updated})]] # pyright: ignore[reportAttributeAccessIssue,reportUnknownMemberType,reportUnknownArgumentType]
model = await get_model_from_dto(dto_type, Model, asgi_connection, b'{"a":"b"}')
assert_model_values(model, {"field": val})
async def test_write_dto_for_model_field_unsupported_default(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test for error condition where we don't know what to do with a default
type."""
class Model(base): # type: ignore
field: Mapped[datetime.datetime] = mapped_column(default=func.now())
with pytest.raises(ValueError):
await get_model_from_dto(SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig()]], Model, asgi_connection, b"")
async def test_dto_for_private_model_field(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
class Model(base): # type: ignore
field: Mapped[datetime.datetime] = mapped_column(
info={DTO_FIELD_META_KEY: DTOField(mark=Mark.PRIVATE)},
)
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig()]]
raw = b'{"id":"97108ac1-ffcb-411d-8b1e-d9183399f63b","created":"0001-01-01T00:00:00","updated":"0001-01-01T00:00:00","field":"0001-01-01T00:00:00"}'
assert "field" not in vars(await get_model_from_dto(dto_type, Model, asgi_connection, raw))
dto_instance = dto_type(asgi_connection)
serializable = dto_instance.data_to_encodable_type( # pyright: ignore[reportUnknownMemberType,reportUnknownVariableType]
Model(
id=UUID("0956ca9e-5671-4d7d-a862-b98e6368ed2c"),
created=datetime.datetime.min,
updated=datetime.datetime.min,
field=datetime.datetime.min,
),
)
assert b"field" not in encode_json(serializable)
async def test_dto_for_non_mapped_model_field(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
class Model(base): # type: ignore
field: ClassVar[datetime.datetime]
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig()]]
raw = b'{"id": "97108ac1-ffcb-411d-8b1e-d9183399f63b","created":"0001-01-01T00:00:00","updated":"0001-01-01T00:00:00","field":"0001-01-01T00:00:00"}'
assert "field" not in vars(await get_model_from_dto(dto_type, Model, asgi_connection, raw))
async def test_dto_mapped_as_dataclass_model_type(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test declare pydantic type on `dto.DTOField`."""
class Model(base, MappedAsDataclass): # type: ignore
clz_var: ClassVar[str]
field: Mapped[str]
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig(exclude={"id"})]]
model = await get_model_from_dto(dto_type, Model, asgi_connection, b'{"clz_var":"nope","field":"yep"}')
assert_model_values(model, {"field": "yep"})
async def test_to_mapped_model_with_collection_relationship(
base: type[DeclarativeBase],
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test building a DTO with collection relationship, and parsing data."""
module = create_module(
"""
from __future__ import annotations
from typing import Dict, List, Set, Tuple, Type, List
from sqlalchemy import ForeignKey, Integer
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
from typing_extensions import Annotated
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO, SQLAlchemyDTOConfig
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class A(Base):
__tablename__ = "a"
b_id: Mapped[int] = mapped_column(ForeignKey("b.id"))
class B(Base):
__tablename__ = "b"
a: Mapped[List[A]] = relationship("A")
dto_type = SQLAlchemyDTO[Annotated[B, SQLAlchemyDTOConfig()]]
""",
)
model = await get_model_from_dto(
module.dto_type,
module.B,
asgi_connection,
b'{"id": 1, "a": [{"id": 2, "b_id": 1}, {"id": 3, "b_id": 1}]}',
)
assert isinstance(model, module.B)
assert len(model.a) == 2
assert all(isinstance(val, module.A) for val in model.a)
async def test_to_mapped_model_with_relationship_type_hint(
base: type[DeclarativeBase],
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test building a DTO with collection relationship, and parsing data."""
module = create_module(
"""
from __future__ import annotations
from typing import Dict, List, Set, Tuple, Type, List
from sqlalchemy import ForeignKey, Integer
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship, Relationship
from typing_extensions import Annotated
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO, SQLAlchemyDTOConfig
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class A(Base):
__tablename__ = "a"
b_id: Mapped[int] = mapped_column(ForeignKey("b.id"))
class B(Base):
__tablename__ = "b"
a: Relationship[List[A]] = relationship("A")
dto_type = SQLAlchemyDTO[Annotated[B, SQLAlchemyDTOConfig()]]
""",
)
model = await get_model_from_dto(
module.dto_type,
module.B,
asgi_connection,
b'{"id": 1, "a": [{"id": 2, "b_id": 1}, {"id": 3, "b_id": 1}]}',
)
assert isinstance(model, module.B)
assert len(model.a) == 2
assert all(isinstance(val, module.A) for val in model.a)
async def test_to_mapped_model_with_scalar_relationship(
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test building DTO with Scalar relationship, and parsing data."""
module = create_module(
"""
from __future__ import annotations
from sqlalchemy import ForeignKey
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
from typing_extensions import Annotated
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO, SQLAlchemyDTOConfig
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class A(Base):
__tablename__ = "a"
class B(Base):
__tablename__ = "b"
a_id: Mapped[int] = mapped_column(ForeignKey("a.id"))
a: Mapped[A] = relationship(A)
dto_type = SQLAlchemyDTO[Annotated[B, SQLAlchemyDTOConfig()]]
""",
)
model = await get_model_from_dto(
module.dto_type,
module.B,
asgi_connection,
b'{"id": 2, "a_id": 1, "a": {"id": 1}}',
)
assert isinstance(model, module.B)
assert isinstance(model.a, module.A)
async def test_dto_mapped_union(
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test where a column type declared as e.g., `Mapped[str | None]`."""
module = create_module(
"""
from __future__ import annotations
from typing import Dict, List, Set, Tuple, Type, Union
from sqlalchemy import ForeignKey
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from typing_extensions import Annotated
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class A(Base):
__tablename__ = "a"
a: Mapped[Union[str, None]]
dto_type = SQLAlchemyDTO[A]
""",
)
model = await get_model_from_dto(module.dto_type, module.A, asgi_connection, b'{"id": 1}')
assert vars(model)["a"] is None
@pytest.mark.skipif(sys.version_info < (3, 10), reason="requires python3.10 or higher")
async def test_dto_mapped_union_type(
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test where a column type declared as e.g., `Mapped[str | None]`."""
module = create_module(
"""
from __future__ import annotations
from typing import Dict, List, Set, Tuple, Type, Union, Optional
from sqlalchemy import ForeignKey
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from typing_extensions import Annotated
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class A(Base):
__tablename__ = "a"
a: Mapped[Optional[str]]
dto_type = SQLAlchemyDTO[A]
""",
)
model = await get_model_from_dto(module.dto_type, module.A, asgi_connection, b'{"id": 1}')
assert vars(model)["a"] is None
model = await get_model_from_dto(module.dto_type, module.A, asgi_connection, b'{"id": 1, "a": "a"}')
assert vars(model)["a"] == "a"
async def test_dto_self_referencing_relationships(
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
module = create_module(
"""
from __future__ import annotations
from sqlalchemy import ForeignKey
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class A(Base):
__tablename__ = "a"
b_id: Mapped[int] = mapped_column(ForeignKey("b.id"))
b: Mapped[B] = relationship(back_populates="a")
class B(Base):
__tablename__ = "b"
a: Mapped[A] = relationship(back_populates="b")
dto_type = SQLAlchemyDTO[A]
""",
)
raw = b'{"id": 1, "b_id": 1, "b": {"id": 1, "a": {"id": 1, "b_id": 1}}}'
model = await get_model_from_dto(module.dto_type, module.A, asgi_connection, raw)
assert isinstance(model, module.A)
assert isinstance(model.b, module.B)
assert isinstance(model.b.a, module.A)
encodable_type = module.dto_type(asgi_connection).data_to_encodable_type(model)
assert encodable_type.id == 1
assert encodable_type.b_id == 1
assert encodable_type.b.id == 1
async def test_dto_optional_relationship_with_none_value(
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
module = create_module(
"""
from __future__ import annotations
from typing import Dict, List, Set, Tuple, Type, Optional
from sqlalchemy import ForeignKey
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
from typing_extensions import Annotated
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO, SQLAlchemyDTOConfig
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class A(Base):
__tablename__ = "a"
class B(Base):
__tablename__ = "b"
a_id: Mapped[Optional[int]] = mapped_column(ForeignKey("a.id"))
a: Mapped[Optional[A]] = relationship(A)
dto_type = SQLAlchemyDTO[Annotated[B, SQLAlchemyDTOConfig()]]
""",
)
model = await get_model_from_dto(module.dto_type, module.B, asgi_connection, b'{"id": 2, "a_id": null, "a": null}')
assert isinstance(model, module.B)
assert model.a is None
async def test_forward_ref_relationship_resolution(
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Testing that classes related to the mapped class for the dto are considered for forward-ref resolution.
The key part of this test is that the `B` type is only imported inside an `if TYPE_CHECKING:` block
in `a_module`, so it should not be available for forward-ref resolution when `a_module` is imported. This
works due to related mapped classes (via `mapper.registry.mappers`) being added to forward-ref resolution
namespace.
"""
base_module = create_module(
"""
from __future__ import annotations
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
""",
)
b_module = create_module(
f"""
from __future__ import annotations
from {base_module.__name__} import Base
class B(Base):
__tablename__ = "b"
""",
)
a_module = create_module(
f"""
from __future__ import annotations
from typing import Dict, List, Set, Tuple, Type, TYPE_CHECKING
from sqlalchemy import ForeignKey
from sqlalchemy.orm import Mapped, mapped_column, relationship
from typing_extensions import Annotated
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO, SQLAlchemyDTOConfig
from {base_module.__name__} import Base
if TYPE_CHECKING:
from {b_module.__name__} import B
class A(Base):
__tablename__ = "a"
b_id: Mapped[int] = mapped_column(ForeignKey("b.id"))
b: Mapped[B] = relationship()
dto_type = SQLAlchemyDTO[Annotated[A, SQLAlchemyDTOConfig()]]
""",
)
model = await get_model_from_dto(
a_module.dto_type,
a_module.A,
asgi_connection,
b'{"id": 1, "b_id": 2, "b": {"id": 2}}',
)
assert isinstance(model, a_module.A)
assert isinstance(model.b, b_module.B)
async def test_dto_mapped_builtin_collection(
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test where a column type declared as e.g., `Mapped[dict]`."""
module = create_module(
"""
from __future__ import annotations
from typing import Dict, List, Set, Tuple, Type, Union
from sqlalchemy import ForeignKey, Integer
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from sqlalchemy.types import JSON, ARRAY
from typing_extensions import Annotated
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class A(Base):
__tablename__ = "a"
a: Mapped[dict] = mapped_column(JSON)
c: Mapped[list] = mapped_column(ARRAY(Integer))
dto_type = SQLAlchemyDTO[A]
""",
)
model = await get_model_from_dto(
module.dto_type,
module.A,
asgi_connection,
b'{"id": 1, "a": {"b": 1}, "c": [1, 2, 3]}',
)
assert vars(model)["a"] == {"b": 1}
assert vars(model)["c"] == [1, 2, 3]
async def test_no_type_hint_column(base: type[DeclarativeBase], asgi_connection: Request[Any, Any, Any]) -> None:
class Model(base): # type: ignore
nullable_field = mapped_column(sqlalchemy.String)
not_nullable_field = mapped_column(sqlalchemy.String, nullable=False, default="")
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig()]]
model = await get_model_from_dto(dto_type, Model, asgi_connection, b"{}")
assert model.nullable_field is None
assert model.not_nullable_field == ""
async def test_no_type_hint_scalar_relationship_with_nullable_fk(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
class Child(base): # type: ignore
...
class Model(base): # type: ignore
child_id = mapped_column(ForeignKey("child.id"))
child = relationship(Child)
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig(exclude={"child_id"})]]
model = await get_model_from_dto(dto_type, Model, asgi_connection, b"{}")
assert model.child is None
async def test_no_type_hint_scalar_relationship_with_not_nullable_fk(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
class Child(base): # type: ignore
...
class Model(base): # type: ignore
child_id = mapped_column(ForeignKey("child.id"), nullable=False)
child = relationship(Child)
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig(exclude={"child_id"})]]
model = await get_model_from_dto(dto_type, Model, asgi_connection, b'{"child": {}}')
assert isinstance(model.child, Child)
async def test_no_type_hint_collection_relationship(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
class Child(base): # type: ignore
model_id = mapped_column(ForeignKey("model.id"))
class Model(base): # type: ignore
children = relationship(Child)
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig()]]
model = await get_model_from_dto(dto_type, Model, asgi_connection, b'{"children": []}')
assert model.children == []
async def test_no_type_hint_collection_relationship_alt_collection_class(
base: type[DeclarativeBase],
asgi_connection: Request[Any, Any, Any],
) -> None:
class Child(base): # type: ignore
model_id = mapped_column(ForeignKey("model.id"))
class Model(base): # type: ignore
children = relationship(Child, collection_class=set)
dto_type = SQLAlchemyDTO[Annotated[Model, SQLAlchemyDTOConfig()]]
model = await get_model_from_dto(dto_type, Model, asgi_connection, b'{"children": []}')
assert model.children == set()
def test_parse_type_from_element_failure() -> None:
with pytest.raises(ImproperConfigurationError) as exc:
parse_type_from_element(1, None) # type: ignore
assert str(exc.value) == "Unable to parse type from element '1'. Consider adding a type hint."
async def test_to_mapped_model_with_dynamic_mapped(
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test building DTO with DynamicMapped relationship, and parsing data."""
module = create_module(
"""
from __future__ import annotations
from sqlalchemy import ForeignKey
from sqlalchemy.orm import DeclarativeBase, DynamicMapped, Mapped, mapped_column, relationship, WriteOnlyMapped
from typing import List
from typing_extensions import Annotated
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO, SQLAlchemyDTOConfig
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class Child(Base):
__tablename__ = "child"
test_model_id: Mapped[int] = mapped_column(ForeignKey("test_model.id"))
class TestModel(Base):
__tablename__ = "test_model"
children: DynamicMapped[List[Child]] = relationship(Child, lazy="joined")
dto_type = SQLAlchemyDTO[Annotated[TestModel, SQLAlchemyDTOConfig()]]
""",
)
model = await get_model_from_dto(
module.dto_type,
module.TestModel,
asgi_connection,
b'{"id": 2, "children": [{"id": 1, "test_model_id": 2}]}',
)
assert isinstance(model, module.TestModel)
# For DynamicMapped, we should check the query result
child = model.children[0] # Access first item from the dynamic query
assert isinstance(child, module.Child)
async def test_to_mapped_model_with_writeonly_mapped(
create_module: Callable[[str], ModuleType],
asgi_connection: Request[Any, Any, Any],
) -> None:
"""Test building DTO with WriteOnlyMapped relationship, and parsing data."""
module = create_module(
"""
from __future__ import annotations
from sqlalchemy import ForeignKey
from sqlalchemy.orm import DeclarativeBase, Mapped, WriteOnlyMapped, mapped_column, relationship
from typing import List
from typing_extensions import Annotated
from litestar.dto.field import Mark, dto_field
from advanced_alchemy.extensions.litestar.dto import SQLAlchemyDTO, SQLAlchemyDTOConfig
class Base(DeclarativeBase):
id: Mapped[int] = mapped_column(primary_key=True)
class Child(Base):
__tablename__ = "child"
test_model_id: Mapped[int] = mapped_column(ForeignKey("test_model.id"))
class TestModel(Base):
__tablename__ = "test_model"
children: WriteOnlyMapped[List[Child]] = relationship(Child, info=dto_field(mark=Mark.WRITE_ONLY))
dto_type = SQLAlchemyDTO[Annotated[TestModel, SQLAlchemyDTOConfig()]]
""",
)
model = await get_model_from_dto(
module.dto_type,
module.TestModel,
asgi_connection,
b'{"id": 2, "children": [{"id": 1, "test_model_id": 2}]}',
)
assert isinstance(model, module.TestModel)
# WriteOnlyMapped relationships can only be written to, not read from
# So we can only verify the model was created successfully
|