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
|
from __future__ import annotations
import pytest
from _pytest.fixtures import FixtureRequest
from sqlalchemy.dialects.postgresql import UUID
from sqlalchemy.engine import Engine
from sqlalchemy.schema import Column, ForeignKeyConstraint, MetaData, Table
from sqlalchemy.sql.expression import text
from sqlalchemy.types import INTEGER, VARCHAR
from sqlacodegen.generators import CodeGenerator, DataclassGenerator
from .conftest import validate_code
@pytest.fixture
def generator(
request: FixtureRequest, metadata: MetaData, engine: Engine
) -> CodeGenerator:
options = getattr(request, "param", [])
return DataclassGenerator(metadata, engine, options)
def test_basic_class(generator: CodeGenerator) -> None:
Table(
"simple",
generator.metadata,
Column("id", INTEGER, primary_key=True),
Column("name", VARCHAR(20)),
)
validate_code(
generator.generate(),
"""\
from sqlalchemy import Integer, String
from sqlalchemy.orm import DeclarativeBase, Mapped, MappedAsDataclass, \
mapped_column
from typing import Optional
class Base(MappedAsDataclass, DeclarativeBase):
pass
class Simple(Base):
__tablename__ = 'simple'
id: Mapped[int] = mapped_column(Integer, primary_key=True)
name: Mapped[Optional[str]] = mapped_column(String(20))
""",
)
def test_mandatory_field_last(generator: CodeGenerator) -> None:
Table(
"simple",
generator.metadata,
Column("id", INTEGER, primary_key=True),
Column("name", VARCHAR(20), server_default=text("foo")),
Column("age", INTEGER, nullable=False),
)
validate_code(
generator.generate(),
"""\
from sqlalchemy import Integer, String, text
from sqlalchemy.orm import DeclarativeBase, Mapped, MappedAsDataclass, \
mapped_column
from typing import Optional
class Base(MappedAsDataclass, DeclarativeBase):
pass
class Simple(Base):
__tablename__ = 'simple'
id: Mapped[int] = mapped_column(Integer, primary_key=True)
age: Mapped[int] = mapped_column(Integer)
name: Mapped[Optional[str]] = mapped_column(String(20), \
server_default=text('foo'))
""",
)
def test_onetomany_optional(generator: CodeGenerator) -> None:
Table(
"simple_items",
generator.metadata,
Column("id", INTEGER, primary_key=True),
Column("container_id", INTEGER),
ForeignKeyConstraint(["container_id"], ["simple_containers.id"]),
)
Table(
"simple_containers",
generator.metadata,
Column("id", INTEGER, primary_key=True),
)
validate_code(
generator.generate(),
"""\
from sqlalchemy import ForeignKey, Integer
from sqlalchemy.orm import DeclarativeBase, Mapped, MappedAsDataclass, \
mapped_column, relationship
from typing import List, Optional
class Base(MappedAsDataclass, DeclarativeBase):
pass
class SimpleContainers(Base):
__tablename__ = 'simple_containers'
id: Mapped[int] = mapped_column(Integer, primary_key=True)
simple_items: Mapped[List['SimpleItems']] = relationship('SimpleItems', \
back_populates='container')
class SimpleItems(Base):
__tablename__ = 'simple_items'
id: Mapped[int] = mapped_column(Integer, primary_key=True)
container_id: Mapped[Optional[int]] = \
mapped_column(ForeignKey('simple_containers.id'))
container: Mapped['SimpleContainers'] = relationship('SimpleContainers', \
back_populates='simple_items')
""",
)
def test_manytomany(generator: CodeGenerator) -> None:
Table("simple_items", generator.metadata, Column("id", INTEGER, primary_key=True))
Table(
"simple_containers",
generator.metadata,
Column("id", INTEGER, primary_key=True),
)
Table(
"container_items",
generator.metadata,
Column("item_id", INTEGER),
Column("container_id", INTEGER),
ForeignKeyConstraint(["item_id"], ["simple_items.id"]),
ForeignKeyConstraint(["container_id"], ["simple_containers.id"]),
)
validate_code(
generator.generate(),
"""\
from sqlalchemy import Column, ForeignKey, Integer, Table
from sqlalchemy.orm import DeclarativeBase, Mapped, MappedAsDataclass, \
mapped_column, relationship
from typing import List
class Base(MappedAsDataclass, DeclarativeBase):
pass
class SimpleContainers(Base):
__tablename__ = 'simple_containers'
id: Mapped[int] = mapped_column(Integer, primary_key=True)
item: Mapped[List['SimpleItems']] = relationship('SimpleItems', \
secondary='container_items', back_populates='container')
class SimpleItems(Base):
__tablename__ = 'simple_items'
id: Mapped[int] = mapped_column(Integer, primary_key=True)
container: Mapped[List['SimpleContainers']] = \
relationship('SimpleContainers', secondary='container_items', back_populates='item')
t_container_items = Table(
'container_items', Base.metadata,
Column('item_id', ForeignKey('simple_items.id')),
Column('container_id', ForeignKey('simple_containers.id'))
)
""",
)
def test_named_foreign_key_constraints(generator: CodeGenerator) -> None:
Table(
"simple_items",
generator.metadata,
Column("id", INTEGER, primary_key=True),
Column("container_id", INTEGER),
ForeignKeyConstraint(
["container_id"], ["simple_containers.id"], name="foreignkeytest"
),
)
Table(
"simple_containers",
generator.metadata,
Column("id", INTEGER, primary_key=True),
)
validate_code(
generator.generate(),
"""\
from sqlalchemy import ForeignKeyConstraint, Integer
from sqlalchemy.orm import DeclarativeBase, Mapped, MappedAsDataclass, \
mapped_column, relationship
from typing import List, Optional
class Base(MappedAsDataclass, DeclarativeBase):
pass
class SimpleContainers(Base):
__tablename__ = 'simple_containers'
id: Mapped[int] = mapped_column(Integer, primary_key=True)
simple_items: Mapped[List['SimpleItems']] = relationship('SimpleItems', \
back_populates='container')
class SimpleItems(Base):
__tablename__ = 'simple_items'
__table_args__ = (
ForeignKeyConstraint(['container_id'], ['simple_containers.id'], \
name='foreignkeytest'),
)
id: Mapped[int] = mapped_column(Integer, primary_key=True)
container_id: Mapped[Optional[int]] = mapped_column(Integer)
container: Mapped['SimpleContainers'] = relationship('SimpleContainers', \
back_populates='simple_items')
""",
)
def test_uuid_type_annotation(generator: CodeGenerator) -> None:
Table(
"simple",
generator.metadata,
Column("id", UUID, primary_key=True),
)
validate_code(
generator.generate(),
"""\
from sqlalchemy import UUID
from sqlalchemy.orm import DeclarativeBase, Mapped, MappedAsDataclass, \
mapped_column
import uuid
class Base(MappedAsDataclass, DeclarativeBase):
pass
class Simple(Base):
__tablename__ = 'simple'
id: Mapped[uuid.UUID] = mapped_column(UUID, primary_key=True)
""",
)
|
