-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_model.py
More file actions
347 lines (251 loc) · 11 KB
/
Copy pathtest_model.py
File metadata and controls
347 lines (251 loc) · 11 KB
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
from datetime import datetime
import pytest
from ellar_sql import model
from ellar_sql.model.mixins import get_registered_models
from ellar_sql.schemas import ModelBaseConfig
from .model_samples import Base
def test_model_creation():
class T1(Base):
id = model.Column(model.Integer, primary_key=True)
name = model.Column(model.String(128))
class T2(Base):
id = model.Column(model.Integer, primary_key=True)
name = model.Column(model.String(128))
assert T1.metadata == T2.metadata
assert T1.metadata.info["database_bind_key"] == "default"
assert T1.__tablename__ == "t1"
assert T2.__tablename__ == "t2"
registered_models = get_registered_models()
assert registered_models[str(T1)] == T1
assert registered_models[str(T2)] == T2
def test_create_model_with_another_base():
class AnotherBaseWithSameMetadata(model.Model):
__base_config__ = ModelBaseConfig(as_base=True)
name = model.Column(model.String(128))
class T3(AnotherBaseWithSameMetadata):
id = model.Column(model.Integer, primary_key=True)
class T4(AnotherBaseWithSameMetadata):
id = model.Column(model.Integer, primary_key=True)
assert (
T3.metadata
== T4.metadata
== Base.metadata
== AnotherBaseWithSameMetadata.metadata
)
assert T3.name
assert T4.name
assert T4.metadata.info["database_bind_key"] == "default"
assert T4.__tablename__ == "t4"
assert T3.__tablename__ == "t3"
assert not hasattr(Base, "__tablename__")
def test_metadata():
class Base2(model.Model):
__base_config__ = ModelBaseConfig(as_base=True)
metadata = model.MetaData()
__database__ = "db2"
name = model.Column(model.String(128))
assert Base2.metadata != Base.metadata
class Base3(model.Model):
__base_config__ = ModelBaseConfig(
use_bases=[model.DeclarativeBase], as_base=True
)
__database__ = "db2"
name = model.Column(model.String(128))
assert Base3.metadata == Base2.metadata
def test_create_model_with_different_metadata():
class T3(Base):
__database__ = "db2"
id = model.Column(model.Integer, primary_key=True)
class T4(Base):
__database__ = "db2"
id = model.Column(model.Integer, primary_key=True)
assert T3.metadata == T4.metadata != Base.metadata
assert T4.metadata.info["database_bind_key"] == "db2"
assert T4.__tablename__ == "t4"
assert T3.__tablename__ == "t3"
def test_skips_name_generation_case_1():
# when there is already a __tablename__ defined
class WithoutNameDefined(Base):
id = model.Column(model.Integer, primary_key=True)
name = model.Column(model.String(128))
class WithNameDefined(Base):
__tablename__ = "NameDefined"
id = model.Column(model.Integer, primary_key=True)
name = model.Column(model.String(128))
assert WithoutNameDefined.__tablename__ == "without_name_defined"
assert WithNameDefined.__tablename__ == "NameDefined"
def test_skips_name_generation_case_2():
# when there is already a __tablename__ defined as a declarative_attr
class WithNameDefined(Base):
@model.declared_attr
def __tablename__(self):
return "NameDefinedCase2"
id = model.Column(model.Integer, primary_key=True)
name = model.Column(model.String(128))
assert WithNameDefined.__tablename__ == "NameDefinedCase2"
def test_skips_name_generation_case_3():
# when there is __abstract__ code defined.
class WithNameDefined(Base):
__abstract__ = True
id = model.Column(model.Integer, primary_key=True)
name = model.Column(model.String(128))
assert hasattr(WithNameDefined, "__tablename__") is False
def test_getting_db_session_fails_outside_app_context():
class Ellar(Base):
id = model.Column(model.Integer, primary_key=True)
name = model.Column(model.String(128))
with pytest.raises(RuntimeError) as ex:
Ellar.get_db_session()
assert str(ex.value) == "ApplicationContext is not available at this scope."
def test_abstractmodel_case_1(db_service, base_super_class_as_dataclass):
bases, _ = base_super_class_as_dataclass
class Base(model.Model):
__base_config__ = ModelBaseConfig(use_bases=bases, as_base=True)
class TimestampModel(Base):
__abstract__ = True
created: model.Mapped[datetime] = model.mapped_column(
model.DateTime, nullable=False, insert_default=datetime.utcnow, init=False
)
updated: model.Mapped[datetime] = model.mapped_column(
model.DateTime,
insert_default=datetime.utcnow,
onupdate=datetime.utcnow,
init=False,
)
class Post(TimestampModel):
id: model.Mapped[int] = model.mapped_column(
model.Integer, primary_key=True, init=False
)
title: model.Mapped[str] = model.mapped_column(model.String, nullable=False)
db_service.create_all()
session = db_service.session_factory()
session.add(Post(title="Admin Post"))
session.commit()
post = session.execute(model.select(Post)).scalar()
assert post is not None
assert post.created is not None
assert post.updated is not None
assert post.dict(exclude={"created", "updated"}) == {"id": 1, "title": "Admin Post"}
def test_abstractmodel_case_2(db_service, base_super_class):
bases, meta = base_super_class
# @model.as_base()
class Base(model.Model):
__base_config__ = ModelBaseConfig(use_bases=bases, as_base=True)
class TimestampModel(Base): # type: ignore[no-redef]
__abstract__ = True
created = model.Column(model.DateTime, nullable=False, default=datetime.utcnow)
updated = model.Column(
model.DateTime, onupdate=datetime.utcnow, default=datetime.utcnow
)
class Post(TimestampModel): # type: ignore[no-redef]
id = model.Column(model.Integer, primary_key=True)
title = model.Column(model.String, nullable=False)
db_service.create_all()
session = db_service.session_factory()
session.add(Post(title="Admin Post"))
session.commit()
post: Post = session.execute(model.select(Post)).scalar()
assert post is not None
assert post.created is not None
assert post.updated is not None
assert post.dict(exclude={"created", "updated"}) == {"id": 1, "title": "Admin Post"}
def test_mixin_model(db_service, ignore_base):
class TimestampMixin: # type: ignore[no-redef]
created: model.Mapped[datetime] = model.mapped_column(
model.DateTime, nullable=False, default=datetime.utcnow
)
updated: model.Mapped[datetime] = model.mapped_column(
model.DateTime, default=datetime.utcnow, onupdate=datetime.utcnow
)
class Post(TimestampMixin, model.Model): # type: ignore[no-redef]
id: model.Mapped[int] = model.mapped_column(model.Integer, primary_key=True)
title: model.Mapped[str] = model.mapped_column(model.String, nullable=False)
db_service.create_all()
session = db_service.session_factory()
session.add(Post(title="Admin Post"))
session.commit()
post = session.execute(model.select(Post)).scalar()
assert post is not None
assert post.created is not None
assert post.updated is not None
def test_mixin_model_with_model_base(db_service, ignore_base):
class TimestampMixin: # type: ignore[no-redef]
created: model.Mapped[datetime] = model.mapped_column(
model.DateTime, nullable=False, default=datetime.utcnow
)
updated: model.Mapped[datetime] = model.mapped_column(
model.DateTime, default=datetime.utcnow, onupdate=datetime.utcnow
)
class Base(TimestampMixin, model.Model):
__base_config__ = ModelBaseConfig(as_base=True)
class Post(Base): # type: ignore[no-redef]
id: model.Mapped[int] = model.mapped_column(model.Integer, primary_key=True)
title: model.Mapped[str] = model.mapped_column(model.String, nullable=False)
db_service.create_all()
session = db_service.session_factory()
session.add(Post(title="Admin Post"))
session.commit()
post = session.execute(model.select(Post)).scalar()
assert post is not None
assert post.created is not None
assert post.updated is not None
def test_mixin_model_case_2(db_service, base_super_class_as_dataclass) -> None:
bases, meta = base_super_class_as_dataclass
class Base(model.Model):
__base_config__ = ModelBaseConfig(use_bases=bases, as_base=True)
class TimestampMixin(model.MappedAsDataclass):
created: model.Mapped[datetime] = model.mapped_column(
model.DateTime, nullable=False, insert_default=datetime.utcnow, init=False
)
updated: model.Mapped[datetime] = model.mapped_column(
model.DateTime,
insert_default=datetime.utcnow,
onupdate=datetime.utcnow,
init=False,
)
class Post(TimestampMixin, Base):
id: model.Mapped[int] = model.mapped_column(
model.Integer, primary_key=True, init=False
)
title: model.Mapped[str] = model.mapped_column(model.String, nullable=False)
db_service.create_all()
session = db_service.session_factory()
session.add(Post(title="Admin Post"))
session.commit()
post = session.execute(model.select(Post)).scalar()
# post.dict()
assert post is not None
assert post.created is not None
assert post.updated is not None
def test_model_repr(db_service, ignore_base) -> None:
class User(model.Model):
id = model.Column(model.Integer, primary_key=True)
db_service.create_all()
session = db_service.session_factory()
user = User()
assert repr(user) == f"<User (transient {id(user)})>"
session.add(user)
assert repr(user) == f"<User (pending {id(user)})>"
session.flush()
assert repr(user) == f"<User {user.id}>"
def test_model_repr_for_mapped_as_dataclass(db_service, ignore_base) -> None:
class User(model.Model):
__base_config__ = ModelBaseConfig(use_bases=[model.MappedAsDataclass])
id = model.Column(model.Integer, primary_key=True)
user = User()
assert repr(user) == "test_model_repr_for_mapped_as_dataclass.<locals>.User()"
def test_cant_inherit_any_declarative_base(ignore_base):
with pytest.raises(TypeError, match="metaclass conflict:"):
class _Base(model.Model, model.DeclarativeBase): # type: ignore[misc]
pass
with pytest.raises(TypeError, match="metaclass conflict:"):
class _Base(model.Model, model.MappedAsDataclass): # type: ignore[misc]
pass
def test_too_many_bases(ignore_base):
with pytest.raises(
ValueError, match="Only one declarative base can be passed to SQLAlchemy."
):
class _Base(model.Model): # type: ignore[misc]
__base_config__ = ModelBaseConfig(
use_bases=[model.DeclarativeBase, model.DeclarativeBaseNoMeta]
)