Coverage for tests/test_field_sa_args_kwargs.py: 100%

29 statements  

« prev     ^ index     » next       coverage.py v7.17.2, created at 2026-11-16 00:02 +0000

1from typing import Any 1nopqrstuvwxyz

2 

3import pytest 1nopqrstuvwxyz

4from sqlalchemy import Engine, ForeignKey, Integer, String, inspect 1nopqrstuvwxyz

5from sqlmodel import Field, SQLModel 1nopqrstuvwxyz

6 

7 

8def test_sa_column_args(database_engine: Engine) -> None: 1nopqrstuvwxyz

9 class Team(SQLModel, table=True): 1abcdefghijklm

10 id: int | None = Field(default=None, primary_key=True) 1abcdefghijklm

11 name: str 1abcdefghijklm

12 

13 class Hero(SQLModel, table=True): 1abcdefghijklm

14 id: int | None = Field(default=None, primary_key=True) 1abcdefghijklm

15 team_id: int | None = Field( 1abcdefghijklm

16 default=None, 

17 sa_column_args=[ForeignKey("team.id")], 

18 ) 

19 

20 engine = database_engine 1abcdefghijklm

21 SQLModel.metadata.create_all(engine) 1abcdefghijklm

22 foreign_keys = inspect(engine).get_foreign_keys("hero") 1abcdefghijklm

23 assert len(foreign_keys) == 1 1abcdefghijklm

24 assert foreign_keys[0]["constrained_columns"] == ["team_id"] 1abcdefghijklm

25 assert foreign_keys[0]["referred_table"] == "team" 1abcdefghijklm

26 assert foreign_keys[0]["referred_columns"] == ["id"] 1abcdefghijklm

27 

28 

29def test_sa_column_kargs(database_engine: Engine) -> None: 1nopqrstuvwxyz

30 class Item(SQLModel, table=True): 1ABCDEFGHIJKLM

31 id: int | None = Field( 1ABCDEFGHIJKLM

32 default=None, 

33 sa_column_kwargs={"primary_key": True}, 

34 ) 

35 

36 engine = database_engine 1ABCDEFGHIJKLM

37 SQLModel.metadata.create_all(engine) 1ABCDEFGHIJKLM

38 primary_key = inspect(engine).get_pk_constraint("item") 1ABCDEFGHIJKLM

39 assert primary_key["constrained_columns"] == ["id"] 1ABCDEFGHIJKLM

40 

41 

42@pytest.mark.parametrize( 1nopqrstuvwxyz

43 "field_kwargs", 

44 [ 

45 {"sa_column_kwargs": {"type_": Integer}}, 

46 {"sa_type": String, "sa_column_kwargs": {"type_": Integer}}, 

47 ], 

48) 

49def test_sa_column_kwargs_type_raises(field_kwargs: dict[str, Any]) -> None: 1nopqrstuvwxyz

50 with pytest.raises( 1NOPQRSTUVWXYZ

51 RuntimeError, 

52 match="Passing type_ is not supported in sa_column_kwargs, use sa_type instead", 

53 ): 

54 Field(**field_kwargs) 1NOPQRSTUVWXYZ