-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmodel.py
680 lines (592 loc) · 25.3 KB
/
model.py
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
import logging
from .fields import Field
from .relations import (
MorphMany, MorphOne, Relation, ForeignKey,
OneToOne, OneToMany, ManyToMany
)
from .query_builder import QueryBuilder
from .exceptions import (
RelationNotFound, FieldValidationError, ModelNotFound, HermesException
)
from .config import get_config
# Load configuration
config = get_config()
debug_mode = config.get('debug', False)
console_log = config.get('console_log', False)
# Configure logging
logger = logging.getLogger(__name__)
if console_log:
logging.basicConfig(level=logging.INFO)
else:
logging.basicConfig(level=logging.WARNING)
class BaseModelMeta(type):
def __new__(cls, name, bases, dct):
fields = {}
relations = {}
for key, value in dct.items():
if isinstance(value, Field):
fields[key] = value
elif isinstance(value, Relation):
relations[key] = value
dct["_fields"] = fields
dct["_relations"] = relations
return super().__new__(cls, name, bases, dct)
class BaseModel(metaclass=BaseModelMeta):
"""
Base class for defining ORM models.
Provides functionality for field management, database operations,
and relationships between models.
"""
_table_name = None
_model_registry = {}
def __init_subclass__(cls, **kwargs):
"""
Automatically register subclasses in the model registry.
"""
super().__init_subclass__(**kwargs)
BaseModel._model_registry[cls.__name__.lower()] = cls
def __init__(self, **kwargs):
# Initialize fields
for field_name, field in self._fields.items():
value = kwargs.get(field_name, field.default)
try:
field.validate(value)
except FieldValidationError as e:
if console_log:
logger.error(f"Validation error on field '{field_name}': {e}")
if debug_mode:
raise
setattr(self, field_name, value)
# Initialize relationships
for relation_name in self._relations:
setattr(self, relation_name, None)
def get_relation(self, relation_name, db_connection):
"""
Retrieve a related model instance based on the specified relation.
:param relation_name: Name of the relation.
:param db_connection: Database connection object.
:return: Related model instance or `None`.
"""
if relation_name not in self._relations:
message = f"Relation '{relation_name}' not found in model '{self.__class__.__name__}'."
if console_log:
logger.error(message)
if debug_mode:
raise RelationNotFound(message)
return None
relation = self._relations[relation_name]
related_model = self._resolve_relation_model(relation)
if isinstance(relation, ForeignKey):
foreign_key_value = getattr(self, relation.foreign_key_field)
return related_model.find(db_connection, foreign_key_value)
elif isinstance(relation, OneToOne):
return self.get_has_one(relation_name, db_connection)
elif isinstance(relation, OneToMany):
return self.get_has_many(relation_name, db_connection)
elif isinstance(relation, ManyToMany):
return self.get_many_to_many(db_connection, relation_name)
elif isinstance(relation, MorphOne):
return self.get_morph_one(relation_name, db_connection)
elif isinstance(relation, MorphMany):
return self.get_morph_many(relation_name, db_connection)
else:
message = f"Unsupported relation type for '{relation_name}'."
if console_log:
logger.error(message)
if debug_mode:
raise RelationNotFound(message)
return None
def get_has_one(self, relation_name, db_connection):
"""
Retrieve the related model instance in a OneToOne relationship.
:param relation_name: Name of the OneToOne relation.
:param db_connection: Database connection object.
:return: Related model instance or `None`.
"""
if relation_name not in self._relations:
message = f"Relation '{relation_name}' not found in model '{self.__class__.__name__}'."
if console_log:
logger.error(message)
if debug_mode:
raise RelationNotFound(message)
return None
relation = self._relations[relation_name]
if not isinstance(relation, OneToOne):
message = f"Relation '{relation_name}' is not a OneToOne relationship."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return None
related_model = self._resolve_relation_model(relation)
foreign_key_value = self._get_primary_key()
query = f"""
SELECT * FROM {related_model.get_table_name()}
WHERE {relation.foreign_key_field} = ?
LIMIT 1
"""
try:
result = db_connection.execute_sync(query, (foreign_key_value,))
if result:
return related_model(**dict(zip(related_model._fields.keys(), result[0])))
except HermesException as e:
if console_log:
logger.error(f"Error fetching related model: {e}")
if debug_mode:
raise
return None
def get_has_many(self, relation_name, db_connection):
"""
Retrieve related model instances in a OneToMany relationship.
:param relation_name: Name of the OneToMany relation.
:param db_connection: Database connection object.
:return: List of related model instances.
"""
if relation_name not in self._relations:
message = f"Relation '{relation_name}' not found in model '{self.__class__.__name__}'."
if console_log:
logger.error(message)
if debug_mode:
raise RelationNotFound(message)
return []
relation = self._relations[relation_name]
if not isinstance(relation, OneToMany):
message = f"Relation '{relation_name}' is not a OneToMany relationship."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return []
related_model = self._resolve_relation_model(relation)
foreign_key_value = self._get_primary_key()
query = f"""
SELECT * FROM {related_model.get_table_name()}
WHERE {relation.foreign_key_field} = ?
"""
try:
results = db_connection.execute_sync(query, (foreign_key_value,))
return [related_model(**dict(zip(related_model._fields.keys(), row))) for row in results]
except HermesException as e:
if console_log:
logger.error(f"Error fetching related models: {e}")
if debug_mode:
raise
return []
@classmethod
def _resolve_relation_model(cls, relation):
"""
Resolve the related model class from the relation.
:param relation: Relation instance.
:return: Related model class.
"""
if isinstance(relation.related_model, str):
related_model = BaseModel._model_registry.get(relation.related_model.lower())
if not related_model:
message = (
f"Model '{relation.related_model}' not found in the registry. "
f"Ensure the model is imported before accessing relationships."
)
if console_log:
logger.error(message)
if debug_mode:
raise ModelNotFound(message)
return None
return related_model
return relation.related_model
@classmethod
def get_primary_key(cls):
"""
Get the primary key field name for the model.
:return: The name of the primary key field.
"""
for field_name, field in cls._fields.items():
if field.primary_key:
return field_name
message = f"No primary key defined for the model {cls.__name__}."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return None
def _get_primary_key(self):
"""
Get the primary key value for the current instance.
:return: The primary key value.
"""
primary_key_field = self.get_primary_key()
if primary_key_field is None:
return None
return getattr(self, primary_key_field)
@classmethod
def get_table_name(cls):
"""
Returns the table name for the model.
If `_table_name` is not explicitly defined, the class name in lowercase is used.
"""
return cls._table_name or cls.__name__.lower()
def __repr__(self):
"""
String representation of the model instance.
Displays all fields and their values.
"""
fields = ", ".join(f"{name}={repr(getattr(self, name))}" for name in self._fields)
return f"<{self.__class__.__name__}({fields})>"
@classmethod
def all(cls, db_connection):
"""
Retrieve all instances of the model from the database.
Uses caching to improve performance for repeated queries.
:param db_connection: Database connection object.
:return: List of model instances.
"""
query = QueryBuilder.select(cls)
try:
results = db_connection.execute_with_cache(query)
return [cls(**dict(zip(cls._fields.keys(), row))) for row in results]
except HermesException as e:
if console_log:
logger.error(f"Error retrieving all instances: {e}")
if debug_mode:
raise
return []
def save(self, db_connection):
"""
Save or update the model instance in the database.
Automatically performs an `INSERT` or `UPDATE` operation based on whether the
primary key field is already present in the database.
:param db_connection: Database connection object.
"""
table_name = self.get_table_name()
primary_key_field = self.get_primary_key()
primary_key_value = getattr(self, primary_key_field, None)
if primary_key_value is None:
message = "Primary key must be set to save the instance."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return
# Validate fields
for field_name, field in self._fields.items():
value = getattr(self, field_name)
try:
field.validate(value)
except FieldValidationError as e:
if console_log:
logger.error(f"Validation error on field '{field_name}': {e}")
if debug_mode:
raise
# Check existence
check_query = f"SELECT 1 FROM {table_name} WHERE {primary_key_field} = ?"
try:
cursor = db_connection.connect_sync().execute(check_query, (primary_key_value,))
exists = cursor.fetchone()
if exists:
# Update operation
update_query, params = QueryBuilder.update(self)
db_connection.connect_sync().execute(update_query, params)
if console_log:
logger.info(f"Updated instance in table '{table_name}' with ID {primary_key_value}.")
else:
# Insert operation
insert_query, params = QueryBuilder.insert(self)
db_connection.connect_sync().execute(insert_query, params)
if console_log:
logger.info(f"Inserted new instance into table '{table_name}' with ID {primary_key_value}.")
db_connection.connect_sync().commit()
db_connection.invalidate_cache()
except HermesException as e:
if console_log:
logger.error(f"Error saving instance: {e}")
if debug_mode:
raise
@classmethod
def find(cls, db_connection, primary_key_value):
"""
Find and return a single instance by primary key.
:param db_connection: Database connection object.
:param primary_key_value: The primary key value to search for.
:return: An instance of the model or `None` if not found.
"""
table_name = cls.get_table_name()
primary_key_field = cls.get_primary_key()
query = f"SELECT * FROM {table_name} WHERE {primary_key_field} = ?"
try:
results = db_connection.execute_sync(query, (primary_key_value,))
if results:
return cls(**dict(zip(cls._fields.keys(), results[0])))
except HermesException as e:
if console_log:
logger.error(f"Error finding instance with ID {primary_key_value}: {e}")
if debug_mode:
raise
return None
def delete(self, db_connection):
"""
Delete the model instance from the database.
:param db_connection: Database connection object.
"""
table_name = self.get_table_name()
primary_key_field = self.get_primary_key()
primary_key_value = self._get_primary_key()
if primary_key_value is None:
message = "Cannot delete instance without a primary key value."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return
query = f"DELETE FROM {table_name} WHERE {primary_key_field} = ?"
try:
db_connection.connect_sync().execute(query, (primary_key_value,))
db_connection.connect_sync().commit()
db_connection.invalidate_cache()
if console_log:
logger.info(f"Deleted instance from table '{table_name}' with ID {primary_key_value}.")
except HermesException as e:
if console_log:
logger.error(f"Error deleting instance: {e}")
if debug_mode:
raise
def sync_many_to_many(self, db_connection, relation_name, related_ids):
"""
Sync Many-to-Many relationships by replacing the current associations with new ones.
:param db_connection: Database connection object.
:param relation_name: Name of the ManyToMany relation.
:param related_ids: List of IDs to associate.
"""
if relation_name not in self._relations:
message = f"Relation '{relation_name}' does not exist on {self.__class__.__name__}."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return
relation = self._relations[relation_name]
if not isinstance(relation, ManyToMany):
message = f"Relation '{relation_name}' is not a Many-To-Many relationship."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return
pivot_table = relation.pivot_table
related_model = self._resolve_relation_model(relation)
local_column = self.get_table_name() + "_id"
related_column = related_model.get_table_name() + "_id"
try:
# Clear existing relationships
db_connection.connect_sync().execute(
f"DELETE FROM {pivot_table} WHERE {local_column} = ?", (self._get_primary_key(),)
)
# Insert new relationships
for related_id in related_ids:
db_connection.connect_sync().execute(
f"INSERT INTO {pivot_table} ({local_column}, {related_column}) VALUES (?, ?)",
(self._get_primary_key(), related_id)
)
db_connection.connect_sync().commit()
if console_log:
logger.info(f"Synced ManyToMany relation '{relation_name}' for instance ID {self._get_primary_key()}.")
except HermesException as e:
if console_log:
logger.error(f"Error syncing ManyToMany relation: {e}")
if debug_mode:
raise
def add_many_to_many(self, db_connection, relation_name, related_id):
"""
Add a single association in a ManyToMany relationship.
:param db_connection: Database connection object.
:param relation_name: Name of the ManyToMany relation.
:param related_id: ID of the related model to associate.
"""
if relation_name not in self._relations:
message = f"Relation '{relation_name}' does not exist on {self.__class__.__name__}."
if console_log:
logger.error(message)
if debug_mode:
raise RelationNotFound(message)
return
relation = self._relations[relation_name]
if not isinstance(relation, ManyToMany):
message = f"Relation '{relation_name}' is not a ManyToMany relationship."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return
related_model = self._resolve_relation_model(relation)
pivot_table = relation.pivot_table
local_column = self.get_table_name() + "_id"
related_column = related_model.get_table_name() + "_id"
try:
db_connection.connect_sync().execute(
f"INSERT OR IGNORE INTO {pivot_table} ({local_column}, {related_column}) VALUES (?, ?)",
(self._get_primary_key(), related_id)
)
db_connection.connect_sync().commit()
if console_log:
logger.info(f"Added association in ManyToMany relation '{relation_name}' for instance ID {self._get_primary_key()} with related ID {related_id}.")
except HermesException as e:
if console_log:
logger.error(f"Error adding to ManyToMany relation: {e}")
if debug_mode:
raise
def remove_many_to_many(self, db_connection, relation_name, related_id):
"""
Remove a single association in a ManyToMany relationship.
:param db_connection: Database connection object.
:param relation_name: Name of the ManyToMany relation.
:param related_id: ID of the related model to disassociate.
"""
if relation_name not in self._relations:
message = f"Relation '{relation_name}' does not exist on {self.__class__.__name__}."
if console_log:
logger.error(message)
if debug_mode:
raise RelationNotFound(message)
return
relation = self._relations[relation_name]
if not isinstance(relation, ManyToMany):
message = f"Relation '{relation_name}' is not a ManyToMany relationship."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return
related_model = self._resolve_relation_model(relation)
pivot_table = relation.pivot_table
local_column = self.get_table_name() + "_id"
related_column = related_model.get_table_name() + "_id"
try:
db_connection.connect_sync().execute(
f"DELETE FROM {pivot_table} WHERE {local_column} = ? AND {related_column} = ?",
(self._get_primary_key(), related_id)
)
db_connection.connect_sync().commit()
if console_log:
logger.info(f"Removed association in ManyToMany relation '{relation_name}' for instance ID {self._get_primary_key()} with related ID {related_id}.")
except HermesException as e:
if console_log:
logger.error(f"Error removing from ManyToMany relation: {e}")
if debug_mode:
raise
def get_many_to_many(self, db_connection, relation_name):
"""
Retrieve related model instances in a ManyToMany relationship.
:param db_connection: Database connection object.
:param relation_name: Name of the ManyToMany relation.
:return: List of related model instances.
"""
if relation_name not in self._relations:
message = f"Relation '{relation_name}' does not exist on {self.__class__.__name__}."
if console_log:
logger.error(message)
if debug_mode:
raise RelationNotFound(message)
return []
relation = self._relations[relation_name]
if not isinstance(relation, ManyToMany):
message = f"Relation '{relation_name}' is not a ManyToMany relationship."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return []
related_model = self._resolve_relation_model(relation)
pivot_table = relation.pivot_table
related_table = related_model.get_table_name()
local_column = self.get_table_name() + "_id"
related_column = related_model.get_table_name() + "_id"
query = (
f"SELECT {related_table}.* FROM {related_table} "
f"INNER JOIN {pivot_table} ON {pivot_table}.{related_column} = {related_table}.{related_model.get_primary_key()} "
f"WHERE {pivot_table}.{local_column} = ?"
)
try:
results = db_connection.execute_sync(query, (self._get_primary_key(),))
return [related_model(**dict(zip(related_model._fields.keys(), row))) for row in results]
except HermesException as e:
if console_log:
logger.error(f"Error retrieving ManyToMany relations: {e}")
if debug_mode:
raise
return []
def get_morph_one(self, relation_name, db_connection):
"""
Retrieve the related model instance in a MorphOne relationship.
:param relation_name: Name of the MorphOne relation.
:param db_connection: Database connection object.
:return: Related model instance or `None`.
"""
if relation_name not in self._relations:
message = f"Relation '{relation_name}' does not exist on {self.__class__.__name__}."
if console_log:
logger.error(message)
if debug_mode:
raise RelationNotFound(message)
return None
relation = self._relations[relation_name]
if not isinstance(relation, MorphOne):
message = f"Relation '{relation_name}' is not a MorphOne relationship."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return None
related_model = self._resolve_relation_model(relation)
morph_type = self.get_table_name()
morph_id = self._get_primary_key()
query = f"""
SELECT * FROM {related_model.get_table_name()}
WHERE {relation.morph_type_field} = ? AND {relation.morph_id_field} = ?
LIMIT 1
"""
try:
result = db_connection.execute_sync(query, (morph_type, morph_id))
if result:
return related_model(**dict(zip(related_model._fields.keys(), result[0])))
except HermesException as e:
if console_log:
logger.error(f"Error retrieving MorphOne relation: {e}")
if debug_mode:
raise
return None
def get_morph_many(self, relation_name, db_connection):
"""
Retrieve related model instances in a MorphMany relationship.
:param relation_name: Name of the MorphMany relation.
:param db_connection: Database connection object.
:return: List of related model instances.
"""
if relation_name not in self._relations:
message = f"Relation '{relation_name}' does not exist on {self.__class__.__name__}."
if console_log:
logger.error(message)
if debug_mode:
raise RelationNotFound(message)
return []
relation = self._relations[relation_name]
if not isinstance(relation, MorphMany):
message = f"Relation '{relation_name}' is not a MorphMany relationship."
if console_log:
logger.error(message)
if debug_mode:
raise ValueError(message)
return []
related_model = self._resolve_relation_model(relation)
morph_type = self.get_table_name()
morph_id = self._get_primary_key()
query = f"""
SELECT * FROM {related_model.get_table_name()}
WHERE {relation.morph_type_field} = ? AND {relation.morph_id_field} = ?
"""
try:
results = db_connection.execute_sync(query, (morph_type, morph_id))
return [related_model(**dict(zip(related_model._fields.keys(), row))) for row in results]
except HermesException as e:
if console_log:
logger.error(f"Error retrieving MorphMany relations: {e}")
if debug_mode:
raise
return []