blob: 02afc7c80122b462d2e528fc0049fcdc45c93ef3 (
plain)
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
|
"""Here we illustrate 'traditional' relationship that looks as much like
1.x SQLAlchemy as possible. We want to illustrate that users can apply
Mapped[...] on the left hand side and that this will work in all cases.
This requires that the return type of relationship is based on Any,
if no uselists are present.
"""
import typing
from typing import List
from typing import Set
from sqlalchemy import ForeignKey
from sqlalchemy import Integer
from sqlalchemy import String
from sqlalchemy.orm import DeclarativeBase
from sqlalchemy.orm import Mapped
from sqlalchemy.orm import mapped_column
from sqlalchemy.orm import relationship
class Base(DeclarativeBase):
pass
class User(Base):
__tablename__ = "user"
id = mapped_column(Integer, primary_key=True)
name = mapped_column(String, nullable=False)
addresses_style_one: Mapped[List["Address"]] = relationship("Address")
addresses_style_two: Mapped[Set["Address"]] = relationship(
"Address", collection_class=set
)
class Address(Base):
__tablename__ = "address"
id = mapped_column(Integer, primary_key=True)
user_id = mapped_column(ForeignKey("user.id"))
email = mapped_column(String, nullable=False)
user_style_one = relationship(User)
user_style_one_typed: Mapped[User] = relationship(User)
user_style_two = relationship("User")
user_style_two_typed: Mapped["User"] = relationship("User")
# this is obviously not correct relationally but want to see the typing
# work out
user_style_three: Mapped[List[User]] = relationship(User)
user_style_four: Mapped[List[User]] = relationship("User")
user_style_five = relationship(User, collection_class=set)
user_fk_style_one: Mapped[List[User]] = relationship(
foreign_keys="Address.user_id"
)
user_fk_style_two: Mapped[List[User]] = relationship(
foreign_keys=lambda: Address.user_id
)
user_fk_style_three: Mapped[List[User]] = relationship(
foreign_keys=[user_id]
)
user_pj_style_one: Mapped[List[User]] = relationship(
primaryjoin=user_id == User.id
)
user_pj_style_two: Mapped[List[User]] = relationship(
primaryjoin=lambda: Address.user_id == User.id
)
user_pj_style_three: Mapped[List[User]] = relationship(
primaryjoin="Address.user_id == User.id"
)
if typing.TYPE_CHECKING:
# EXPECTED_RE_TYPE: sqlalchemy.*.InstrumentedAttribute\[builtins.list\*?\[traditional_relationship.Address\]\]
reveal_type(User.addresses_style_one)
# EXPECTED_RE_TYPE: sqlalchemy.*.InstrumentedAttribute\[builtins.set\*?\[traditional_relationship.Address\]\]
reveal_type(User.addresses_style_two)
# EXPECTED_RE_TYPE: sqlalchemy.*.InstrumentedAttribute\[Any\]
reveal_type(Address.user_style_one)
# EXPECTED_RE_TYPE: sqlalchemy.*.InstrumentedAttribute\[traditional_relationship.User\*?\]
reveal_type(Address.user_style_one_typed)
# EXPECTED_RE_TYPE: sqlalchemy.*.InstrumentedAttribute\[Any\]
reveal_type(Address.user_style_two)
# EXPECTED_RE_TYPE: sqlalchemy.*.InstrumentedAttribute\[traditional_relationship.User\*?\]
reveal_type(Address.user_style_two_typed)
# EXPECTED_RE_TYPE: sqlalchemy.*.InstrumentedAttribute\[builtins.list\*?\[traditional_relationship.User\]\]
reveal_type(Address.user_style_three)
# EXPECTED_RE_TYPE: sqlalchemy.*.InstrumentedAttribute\[builtins.list\*?\[traditional_relationship.User\]\]
reveal_type(Address.user_style_four)
# EXPECTED_RE_TYPE: sqlalchemy.*.InstrumentedAttribute\[Any\]
reveal_type(Address.user_style_five)
|
