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
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
|
#
# Copyright (c) 2006, 2007 Canonical
#
# Written by Gustavo Niemeyer <gustavo@niemeyer.net>
#
# This file is part of Storm Object Relational Mapper.
#
# Storm is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation; either version 2.1 of
# the License, or (at your option) any later version.
#
# Storm is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from decimal import Decimal
from datetime import datetime, date, time, timedelta
from weakref import WeakKeyDictionary
from copy import copy
import re
from storm.exceptions import CompileError, NoTableError, ExprError
from storm.variables import (
Variable, RawStrVariable, UnicodeVariable, LazyValue,
DateTimeVariable, DateVariable, TimeVariable, TimeDeltaVariable,
BoolVariable, IntVariable, FloatVariable, DecimalVariable)
from storm import Undef, has_cextensions
# --------------------------------------------------------------------
# Basic compiler infrastructure
def _when(self, types):
"""Check Compile.when. Defined here to ease the work of cextensions."""
def decorator(method):
for type in types:
self._local_dispatch_table[type] = method
self._update_cache()
return method
return decorator
class Compile(object):
"""Compiler based on the concept of generic functions."""
def __init__(self, parent=None):
self._local_dispatch_table = {}
self._local_precedence = {}
self._local_reserved_words = {}
self._dispatch_table = {}
self._precedence = {}
self._reserved_words = {}
self._children = WeakKeyDictionary()
self._parents = []
if parent:
self._parents.extend(parent._parents)
self._parents.append(parent)
parent._children[self] = True
self._update_cache()
def _update_cache(self):
for parent in self._parents:
self._dispatch_table.update(parent._local_dispatch_table)
self._precedence.update(parent._local_precedence)
self._reserved_words.update(parent._local_reserved_words)
self._dispatch_table.update(self._local_dispatch_table)
self._precedence.update(self._local_precedence)
self._reserved_words.update(self._local_reserved_words)
for child in self._children:
child._update_cache()
def when(self, *types):
"""Decorator to include a type handler in this compiler.
Use this as:
@compile.when(TypeA, TypeB)
def compile_type_a_or_b(compile, expr, state):
...
return "THE COMPILED SQL STATEMENT"
"""
return _when(self, types)
def add_reserved_words(self, words):
"""Include words to be considered reserved and thus escaped.
Reserved words are escaped during compilation when they're
seen in a SQLToken expression.
"""
self._local_reserved_words.update((word.lower(), True)
for word in words)
self._update_cache()
def remove_reserved_words(self, words):
self._local_reserved_words.update((word.lower(), None)
for word in words)
self._update_cache()
def is_reserved_word(self, word):
return self._reserved_words.get(word.lower()) is not None
def create_child(self):
"""Create a new instance of L{Compile} which inherits from this one.
This is most commonly used to customize a compiler for
database-specific compilation strategies.
"""
return self.__class__(self)
def get_precedence(self, type):
return self._precedence.get(type, MAX_PRECEDENCE)
def set_precedence(self, precedence, *types):
for type in types:
self._local_precedence[type] = precedence
self._update_cache()
def _compile_single(self, expr, state, outer_precedence):
# FASTPATH This method is part of the fast path. Be careful when
# changing it (try to profile any changes).
cls = expr.__class__
dispatch_table = self._dispatch_table
if cls in dispatch_table:
handler = dispatch_table[cls]
else:
for mro_cls in cls.__mro__:
# First iteration will always fail because we've already
# tested that the class itself isn't in the dispatch table.
if mro_cls in dispatch_table:
handler = dispatch_table[mro_cls]
break
else:
raise CompileError("Don't know how to compile type %r of %r"
% (expr.__class__, expr))
inner_precedence = state.precedence = \
self._precedence.get(cls, MAX_PRECEDENCE)
statement = handler(self, expr, state)
if inner_precedence < outer_precedence:
return "(%s)" % statement
return statement
def __call__(self, expr, state=None, join=u", ", raw=False, token=False):
"""Compile the given expression into a SQL statement.
@param expr: The expression to compile.
@param state: An instance of State, or None, in which case it's
created internally (and thus can't be accessed).
@param join: The string token to use to put between
subexpressions. Defaults to ", ".
@param raw: If true, any string or unicode expression or
subexpression will not be further compiled.
@param token: If true, any string or unicode expression will
be considered as a SQLToken, and quoted properly.
"""
# FASTPATH This method is part of the fast path. Be careful when
# changing it (try to profile any changes).
expr_type = type(expr)
if (expr_type is SQLRaw or
raw and (expr_type is str or expr_type is unicode)):
return expr
if token and (expr_type is str or expr_type is unicode):
expr = SQLToken(expr)
if state is None:
state = State()
outer_precedence = state.precedence
if expr_type is tuple or expr_type is list:
compiled = []
for subexpr in expr:
subexpr_type = type(subexpr)
if subexpr_type is SQLRaw or raw and (subexpr_type is str or
subexpr_type is unicode):
statement = subexpr
elif subexpr_type is tuple or subexpr_type is list:
state.precedence = outer_precedence
statement = self(subexpr, state, join, raw, token)
else:
if token and (subexpr_type is unicode or
subexpr_type is str):
subexpr = SQLToken(subexpr)
statement = self._compile_single(subexpr, state,
outer_precedence)
compiled.append(statement)
statement = join.join(compiled)
else:
statement = self._compile_single(expr, state, outer_precedence)
state.precedence = outer_precedence
return statement
if has_cextensions:
from storm.cextensions import Compile
class CompilePython(Compile):
def get_matcher(self, expr):
state = State()
source = self(expr, state)
namespace = {}
code = ("def closure(parameters, bool):\n"
" [%s] = parameters\n"
" def match(get_column):\n"
" return bool(%s)\n"
" return match" %
(",".join("_%d" % i for i in range(len(state.parameters))),
source))
exec code in namespace
return namespace['closure'](state.parameters, bool)
class State(object):
"""All the data necessary during compilation of an expression.
@ivar aliases: Dict of L{Column} instances to L{Alias} instances,
specifying how columns should be compiled as aliases in very
specific situations. This is typically used to work around
strange deficiencies in various databases.
@ivar auto_tables: The list of all implicitly-used tables. e.g.,
in store.find(Foo, Foo.attr==Bar.id), the tables of Bar and
Foo are implicitly used because columns in them are
referenced. This is used when building tables.
@ivar join_tables: If not None, when Join expressions are
compiled, tables seen will be added to this set. This acts as
a blacklist against auto_tables when compiling Joins, because
the generated statements should not refer to the table twice.
@ivar context: an instance of L{Context}, specifying the context
of the expression currently being compiled.
@ivar precedence: Current precedence, automatically set and restored
by the compiler. If an inner precedence is lower than an outer
precedence, parenthesis around the inner expression are
automatically emitted.
"""
def __init__(self):
self._stack = []
self.precedence = 0
self.parameters = []
self.auto_tables = []
self.join_tables = None
self.context = None
self.aliases = None
def push(self, attr, new_value=Undef):
"""Set an attribute in a way that can later be reverted with L{pop}.
"""
old_value = getattr(self, attr, None)
self._stack.append((attr, old_value))
if new_value is Undef:
new_value = copy(old_value)
setattr(self, attr, new_value)
return old_value
def pop(self):
"""Revert the topmost L{push}.
"""
setattr(self, *self._stack.pop(-1))
compile = Compile()
compile_python = CompilePython()
# --------------------------------------------------------------------
# Expression contexts
class Context(object):
"""
An object used to specify the nature of expected SQL expressions
being compiled in a given context.
"""
def __init__(self, name):
self._name = name
def __repr__(self):
return "%s(%r)" % (self.__class__.__name__, self._name)
TABLE = Context("TABLE")
EXPR = Context("EXPR")
COLUMN = Context("COLUMN")
COLUMN_PREFIX = Context("COLUMN_PREFIX")
COLUMN_NAME = Context("COLUMN_NAME")
SELECT = Context("SELECT")
# --------------------------------------------------------------------
# Builtin type support
@compile.when(str)
def compile_str(compile, expr, state):
state.parameters.append(RawStrVariable(expr))
return "?"
@compile.when(unicode)
def compile_unicode(compile, expr, state):
state.parameters.append(UnicodeVariable(expr))
return "?"
@compile.when(int, long)
def compile_int(compile, expr, state):
state.parameters.append(IntVariable(expr))
return "?"
@compile.when(float)
def compile_float(compile, expr, state):
state.parameters.append(FloatVariable(expr))
return "?"
@compile.when(Decimal)
def compile_decimal(compile, expr, state):
state.parameters.append(DecimalVariable(expr))
return "?"
@compile.when(bool)
def compile_bool(compile, expr, state):
state.parameters.append(BoolVariable(expr))
return "?"
@compile.when(datetime)
def compile_datetime(compile, expr, state):
state.parameters.append(DateTimeVariable(expr))
return "?"
@compile.when(date)
def compile_date(compile, expr, state):
state.parameters.append(DateVariable(expr))
return "?"
@compile.when(time)
def compile_time(compile, expr, state):
state.parameters.append(TimeVariable(expr))
return "?"
@compile.when(timedelta)
def compile_timedelta(compile, expr, state):
state.parameters.append(TimeDeltaVariable(expr))
return "?"
@compile.when(type(None))
def compile_none(compile, expr, state):
return "NULL"
@compile_python.when(str, unicode, int, long, float, type(None))
def compile_python_builtin(compile, expr, state):
return repr(expr)
@compile_python.when(bool, datetime, date, time, timedelta)
def compile_python_bool_and_dates(compile, expr, state):
index = len(state.parameters)
state.parameters.append(expr)
return "_%d" % index
@compile.when(Variable)
def compile_variable(compile, variable, state):
state.parameters.append(variable)
return "?"
@compile_python.when(Variable)
def compile_python_variable(compile, variable, state):
index = len(state.parameters)
state.parameters.append(variable.get())
return "_%d" % index
# --------------------------------------------------------------------
# Base classes for expressions
MAX_PRECEDENCE = 1000
class Expr(LazyValue):
__slots__ = ()
@compile_python.when(Expr)
def compile_python_unsupported(compile, expr, state):
raise CompileError("Can't compile python expressions with %r" % type(expr))
# A translation table that can escape a unicode string for use in a
# Like() expression that uses "!" as the escape character.
like_escape = {
ord(u"!"): u"!!",
ord(u"_"): u"!_",
ord(u"%"): u"!%"
}
class Comparable(object):
__slots__ = ()
def __eq__(self, other):
if other is not None and not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Eq(self, other)
def __ne__(self, other):
if other is not None and not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Ne(self, other)
def __gt__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Gt(self, other)
def __ge__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Ge(self, other)
def __lt__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Lt(self, other)
def __le__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Le(self, other)
def __rshift__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return RShift(self, other)
def __lshift__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return LShift(self, other)
def __and__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return And(self, other)
def __or__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Or(self, other)
def __add__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Add(self, other)
def __sub__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Sub(self, other)
def __mul__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Mul(self, other)
def __div__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Div(self, other)
def __mod__(self, other):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Mod(self, other)
def __neg__(self):
return Neg(self)
def is_in(self, others):
if not isinstance(others, Expr):
others = list(others)
if not others:
return False
variable_factory = getattr(self, "variable_factory", Variable)
for i, other in enumerate(others):
if not isinstance(other, (Expr, Variable)):
others[i] = variable_factory(value=other)
return In(self, others)
def like(self, other, escape=Undef, case_sensitive=None):
if not isinstance(other, (Expr, Variable)):
other = getattr(self, "variable_factory", Variable)(value=other)
return Like(self, other, escape, case_sensitive)
def lower(self):
return Lower(self)
def upper(self):
return Upper(self)
def startswith(self, prefix):
if not isinstance(prefix, unicode):
raise ExprError("Expected unicode argument, got %r" % type(prefix))
pattern = prefix.translate(like_escape) + u"%"
return Like(self, pattern, u"!")
def endswith(self, suffix):
if not isinstance(suffix, unicode):
raise ExprError("Expected unicode argument, got %r" % type(suffix))
pattern = u"%" + suffix.translate(like_escape)
return Like(self, pattern, u"!")
def contains_string(self, substring):
if not isinstance(substring, unicode):
raise ExprError("Expected unicode argument, got %r" % type(substring))
pattern = u"%" + substring.translate(like_escape) + u"%"
return Like(self, pattern, u"!")
class ComparableExpr(Expr, Comparable):
__slots__ = ()
class BinaryExpr(ComparableExpr):
__slots__ = ("expr1", "expr2")
def __init__(self, expr1, expr2):
self.expr1 = expr1
self.expr2 = expr2
class CompoundExpr(ComparableExpr):
__slots__ = ("exprs",)
def __init__(self, *exprs):
self.exprs = exprs
# --------------------------------------------------------------------
# Statement expressions
def has_tables(state, expr):
return (expr.tables is not Undef or
expr.default_tables is not Undef or
state.auto_tables)
def build_tables(compile, tables, default_tables, state):
"""Compile provided tables.
Tables will be built from either C{tables}, C{state.auto_tables}, or
C{default_tables}. If C{tables} is not C{Undef}, it will be used. If
C{tables} is C{Undef} and C{state.auto_tables} is available, that's used
instead. If neither C{tables} nor C{state.auto_tables} are available,
C{default_tables} is tried as a last resort. If none of them are available,
C{NoTableError} is raised.
"""
if tables is Undef:
if state.auto_tables:
tables = state.auto_tables
elif default_tables is not Undef:
tables = default_tables
else:
tables = None
# If we have no elements, it's an error.
if not tables:
raise NoTableError("Couldn't find any tables")
# If it's a single element, it's trivial.
if type(tables) not in (list, tuple) or len(tables) == 1:
return compile(tables, state, token=True)
# If we have no joins, it's trivial as well.
for elem in tables:
if isinstance(elem, JoinExpr):
break
else:
if tables is state.auto_tables:
tables = set(compile(table, state, token=True) for table in tables)
return ", ".join(sorted(tables))
else:
return compile(tables, state, token=True)
# Ok, now we have to be careful.
# If we're dealing with auto_tables, we have to take care of
# duplicated tables, join ordering, and so on.
if tables is state.auto_tables:
table_stmts = set()
join_stmts = set()
half_join_stmts = set()
# push a join_tables onto the state: compile calls below will
# populate this set so that we know what tables not to include.
state.push("join_tables", set())
for elem in tables:
statement = compile(elem, state, token=True)
if isinstance(elem, JoinExpr):
if elem.left is Undef:
half_join_stmts.add(statement)
else:
join_stmts.add(statement)
else:
table_stmts.add(statement)
# Remove tables that were seen in join statements.
table_stmts -= state.join_tables
state.pop()
result = ", ".join(sorted(table_stmts)+sorted(join_stmts))
if half_join_stmts:
result += " " + " ".join(sorted(half_join_stmts))
return "".join(result)
# Otherwise, it's just a matter of putting it together.
result = []
for elem in tables:
if result:
if isinstance(elem, JoinExpr) and elem.left is Undef: #half-join
result.append(" ")
else:
result.append(", ")
result.append(compile(elem, state, token=True))
return "".join(result)
class Select(Expr):
__slots__ = ("columns", "where", "tables", "default_tables", "order_by",
"group_by", "limit", "offset", "distinct", "having")
def __init__(self, columns, where=Undef,
tables=Undef, default_tables=Undef,
order_by=Undef, group_by=Undef,
limit=Undef, offset=Undef, distinct=False, having=Undef):
self.columns = columns
self.where = where
self.tables = tables
self.default_tables = default_tables
self.order_by = order_by
self.group_by = group_by
self.limit = limit
self.offset = offset
self.distinct = distinct
self.having = having
@compile.when(Select)
def compile_select(compile, select, state):
tokens = ["SELECT "]
if select.distinct:
tokens.append("DISTINCT ")
state.push("auto_tables", [])
state.push("context", COLUMN)
tokens.append(compile(select.columns, state))
tables_pos = len(tokens)
parameters_pos = len(state.parameters)
state.context = EXPR
if select.where is not Undef:
tokens.append(" WHERE ")
tokens.append(compile(select.where, state, raw=True))
if select.group_by is not Undef:
tokens.append(" GROUP BY ")
tokens.append(compile(select.group_by, state, raw=True))
if select.having is not Undef:
tokens.append(" HAVING ")
tokens.append(compile(select.having, state, raw=True))
if select.order_by is not Undef:
tokens.append(" ORDER BY ")
tokens.append(compile(select.order_by, state, raw=True))
if select.limit is not Undef:
tokens.append(" LIMIT %d" % select.limit)
if select.offset is not Undef:
tokens.append(" OFFSET %d" % select.offset)
if has_tables(state, select):
state.context = TABLE
state.push("parameters", [])
tokens.insert(tables_pos, " FROM ")
tokens.insert(tables_pos+1, build_tables(compile, select.tables,
select.default_tables, state))
parameters = state.parameters
state.pop()
state.parameters[parameters_pos:parameters_pos] = parameters
state.pop()
state.pop()
return "".join(tokens)
class Insert(Expr):
"""Expression representing an insert statement.
@ivar map: Dictionary mapping columns to values.
@ivar table: Table where the row should be inserted.
@ivar default_table: Table to use if no table is explicitly provided, and
no tables may be inferred from provided columns.
@ivar primary_columns: Tuple of columns forming the primary key of the
table where the row will be inserted. This is a hint used by backends
to process the insertion of rows.
@ivar primary_variables: Tuple of variables with values for the primary
key of the table where the row will be inserted. This is a hint used
by backends to process the insertion of rows.
"""
__slots__ = ("map", "table", "default_table", "primary_columns",
"primary_variables")
def __init__(self, map, table=Undef, default_table=Undef,
primary_columns=Undef, primary_variables=Undef):
self.map = map
self.table = table
self.default_table = default_table
self.primary_columns = primary_columns
self.primary_variables = primary_variables
@compile.when(Insert)
def compile_insert(compile, insert, state):
state.push("context", COLUMN_NAME)
columns = compile(tuple(insert.map), state, token=True)
state.context = TABLE
table = build_tables(compile, insert.table, insert.default_table, state)
state.context = EXPR
values = compile(tuple(insert.map.itervalues()), state)
state.pop()
return "".join(["INSERT INTO ", table, " (", columns,
") VALUES (", values, ")"])
class Update(Expr):
__slots__ = ("map", "where", "table", "default_table")
def __init__(self, map, where=Undef, table=Undef, default_table=Undef):
self.map = map
self.where = where
self.table = table
self.default_table = default_table
@compile.when(Update)
def compile_update(compile, update, state):
map = update.map
state.push("context", COLUMN_NAME)
sets = ["%s=%s" % (compile(col, state, token=True),
compile(map[col], state))
for col in map]
state.context = TABLE
tokens = ["UPDATE ", build_tables(compile, update.table,
update.default_table, state),
" SET ", ", ".join(sets)]
if update.where is not Undef:
state.context = EXPR
tokens.append(" WHERE ")
tokens.append(compile(update.where, state, raw=True))
state.pop()
return "".join(tokens)
class Delete(Expr):
__slots__ = ("where", "table", "default_table")
def __init__(self, where=Undef, table=Undef, default_table=Undef):
self.where = where
self.table = table
self.default_table = default_table
@compile.when(Delete)
def compile_delete(compile, delete, state):
tokens = ["DELETE FROM ", None]
state.push("context", EXPR)
if delete.where is not Undef:
tokens.append(" WHERE ")
tokens.append(compile(delete.where, state, raw=True))
# Compile later for auto_tables support.
state.context = TABLE
tokens[1] = build_tables(compile, delete.table,
delete.default_table, state)
state.pop()
return "".join(tokens)
# --------------------------------------------------------------------
# Columns
class Column(ComparableExpr):
"""Representation of a column in some table.
@ivar name: Column name.
@ivar table: Column table (maybe another expression).
@ivar primary: Integer representing the primary key position of
this column, or 0 if it's not a primary key. May be provided as
a bool.
@ivar variable_factory: Factory producing C{Variable} instances typed
according to this column.
"""
__slots__ = ("name", "table", "primary", "variable_factory")
def __init__(self, name=Undef, table=Undef, primary=False,
variable_factory=None):
self.name = name
self.table = table
self.primary = int(primary)
self.variable_factory = variable_factory or Variable
@compile.when(Column)
def compile_column(compile, column, state):
if column.table is not Undef:
state.auto_tables.append(column.table)
if column.table is Undef or state.context is COLUMN_NAME:
if state.aliases is not None:
# See compile_set_expr().
alias = state.aliases.get(column)
if alias is not None:
return compile(alias.name, state, token=True)
return compile(column.name, state, token=True)
state.push("context", COLUMN_PREFIX)
table = compile(column.table, state, token=True)
state.pop()
return "%s.%s" % (table, compile(column.name, state, token=True))
@compile_python.when(Column)
def compile_python_column(compile, column, state):
index = len(state.parameters)
state.parameters.append(column)
return "get_column(_%d)" % index
# --------------------------------------------------------------------
# Alias expressions
class Alias(ComparableExpr):
"""A representation of "AS" alias clauses. e.g., SELECT foo AS bar.
"""
__slots__ = ("expr", "name")
auto_counter = 0
def __init__(self, expr, name=Undef):
"""Create alias of C{expr} AS C{name}.
If C{name} is not given, then a name will automatically be
generated.
"""
self.expr = expr
if name is Undef:
Alias.auto_counter += 1
name = "_%x" % Alias.auto_counter
self.name = name
@compile.when(Alias)
def compile_alias(compile, alias, state):
name = compile(alias.name, state, token=True)
if state.context is COLUMN or state.context is TABLE:
return "%s AS %s" % (compile(alias.expr, state), name)
return name
# --------------------------------------------------------------------
# From expressions
class FromExpr(Expr):
__slots__ = ()
class Table(FromExpr):
__slots__ = ("name",)
def __init__(self, name):
self.name = name
@compile.when(Table)
def compile_table(compile, table, state):
return compile(table.name, state, token=True)
class JoinExpr(FromExpr):
__slots__ = ("left", "right", "on")
oper = "(unknown)"
def __init__(self, arg1, arg2=Undef, on=Undef):
# http://www.postgresql.org/docs/8.1/interactive/explicit-joins.html
if arg2 is Undef:
self.left = Undef
self.right = arg1
self.on = on
elif not isinstance(arg2, Expr) or isinstance(arg2, (FromExpr, Alias)):
self.left = arg1
self.right = arg2
self.on = on
else:
self.left = Undef
self.right = arg1
self.on = arg2
if on is not Undef:
raise ExprError("Improper join arguments: (%r, %r, %r)" %
(arg1, arg2, on))
@compile.when(JoinExpr)
def compile_join(compile, join, state):
result = []
if join.left is not Undef:
statement = compile(join.left, state, token=True)
result.append(statement)
if state.join_tables is not None:
state.join_tables.add(statement)
result.append(join.oper)
# Joins are left associative, so ensure joins in the right hand
# argument get parentheses.
state.precedence += 0.5
statement = compile(join.right, state, token=True)
result.append(statement)
if state.join_tables is not None:
state.join_tables.add(statement)
if join.on is not Undef:
state.push("context", EXPR)
result.append("ON")
result.append(compile(join.on, state, raw=True))
state.pop()
return " ".join(result)
class Join(JoinExpr):
__slots__ = ()
oper = "JOIN"
class LeftJoin(JoinExpr):
__slots__ = ()
oper = "LEFT JOIN"
class RightJoin(JoinExpr):
__slots__ = ()
oper = "RIGHT JOIN"
class NaturalJoin(JoinExpr):
__slots__ = ()
oper = "NATURAL JOIN"
class NaturalLeftJoin(JoinExpr):
__slots__ = ()
oper = "NATURAL LEFT JOIN"
class NaturalRightJoin(JoinExpr):
__slots__ = ()
oper = "NATURAL RIGHT JOIN"
# --------------------------------------------------------------------
# Operators
class BinaryOper(BinaryExpr):
__slots__ = ()
oper = " (unknown) "
@compile.when(BinaryOper)
@compile_python.when(BinaryOper)
def compile_binary_oper(compile, expr, state):
return "%s%s%s" % (compile(expr.expr1, state), expr.oper,
compile(expr.expr2, state))
class NonAssocBinaryOper(BinaryOper):
__slots__ = ()
oper = " (unknown) "
@compile.when(NonAssocBinaryOper)
@compile_python.when(NonAssocBinaryOper)
def compile_non_assoc_binary_oper(compile, expr, state):
expr1 = compile(expr.expr1, state)
state.precedence += 0.5 # Enforce parentheses.
expr2 = compile(expr.expr2, state)
return "%s%s%s" % (expr1, expr.oper, expr2)
class CompoundOper(CompoundExpr):
__slots__ = ()
oper = " (unknown) "
@compile.when(CompoundOper)
def compile_compound_oper(compile, expr, state):
return compile(expr.exprs, state, join=expr.oper)
@compile_python.when(CompoundOper)
def compile_compound_oper(compile, expr, state):
return compile(expr.exprs, state, join=expr.oper.lower())
class Eq(BinaryOper):
__slots__ = ()
oper = " = "
@compile.when(Eq)
def compile_eq(compile, eq, state):
if eq.expr2 is None:
return "%s IS NULL" % compile(eq.expr1, state)
return "%s = %s" % (compile(eq.expr1, state), compile(eq.expr2, state))
@compile_python.when(Eq)
def compile_eq(compile, eq, state):
return "%s == %s" % (compile(eq.expr1, state), compile(eq.expr2, state))
class Ne(BinaryOper):
__slots__ = ()
oper = " != "
@compile.when(Ne)
def compile_ne(compile, ne, state):
if ne.expr2 is None:
return "%s IS NOT NULL" % compile(ne.expr1, state)
return "%s != %s" % (compile(ne.expr1, state), compile(ne.expr2, state))
class Gt(BinaryOper):
__slots__ = ()
oper = " > "
class Ge(BinaryOper):
__slots__ = ()
oper = " >= "
class Lt(BinaryOper):
__slots__ = ()
oper = " < "
class Le(BinaryOper):
__slots__ = ()
oper = " <= "
class RShift(BinaryOper):
__slots__ = ()
oper = ">>"
class LShift(BinaryOper):
__slots__ = ()
oper = "<<"
class Like(BinaryOper):
__slots__ = ("escape", "case_sensitive")
oper = " LIKE "
def __init__(self, expr1, expr2, escape=Undef, case_sensitive=None):
self.expr1 = expr1
self.expr2 = expr2
self.escape = escape
self.case_sensitive = case_sensitive
@compile.when(Like)
def compile_like(compile, like, state, oper=None):
statement = "%s%s%s" % (compile(like.expr1, state), oper or like.oper,
compile(like.expr2, state))
if like.escape is not Undef:
statement = "%s ESCAPE %s" % (statement, compile(like.escape, state))
return statement
# It's easy to support it. Later.
compile_python.when(Like)(compile_python_unsupported)
class In(BinaryOper):
__slots__ = ()
oper = " IN "
@compile.when(In)
def compile_in(compile, expr, state):
expr1 = compile(expr.expr1, state)
state.precedence = 0 # We're forcing parenthesis here.
return "%s IN (%s)" % (expr1, compile(expr.expr2, state))
@compile_python.when(In)
def compile_in(compile, expr, state):
expr1 = compile(expr.expr1, state)
state.precedence = 0 # We're forcing parenthesis here.
return "%s in (%s,)" % (expr1, compile(expr.expr2, state))
class Add(CompoundOper):
__slots__ = ()
oper = "+"
class Sub(NonAssocBinaryOper):
__slots__ = ()
oper = "-"
class Mul(CompoundOper):
__slots__ = ()
oper = "*"
class Div(NonAssocBinaryOper):
__slots__ = ()
oper = "/"
class Mod(NonAssocBinaryOper):
__slots__ = ()
oper = "%"
class And(CompoundOper):
__slots__ = ()
oper = " AND "
class Or(CompoundOper):
__slots__ = ()
oper = " OR "
@compile.when(And, Or)
def compile_compound_oper(compile, expr, state):
return compile(expr.exprs, state, join=expr.oper, raw=True)
# --------------------------------------------------------------------
# Set expressions.
class SetExpr(Expr):
__slots__ = ("exprs", "all", "order_by", "limit", "offset")
oper = " (unknown) "
def __init__(self, *exprs, **kwargs):
self.exprs = exprs
self.all = kwargs.get("all", False)
self.order_by = kwargs.get("order_by", Undef)
self.limit = kwargs.get("limit", Undef)
self.offset = kwargs.get("offset", Undef)
# If the first expression is of a compatible type, directly
# include its sub expressions.
if len(self.exprs) > 0:
first = self.exprs[0]
if (isinstance(first, self.__class__) and
first.all == self.all and
first.limit is Undef and
first.offset is Undef):
self.exprs = first.exprs + self.exprs[1:]
@compile.when(SetExpr)
def compile_set_expr(compile, expr, state):
if expr.order_by is not Undef:
# When ORDER BY is present, databases usually have trouble using
# fully qualified column names. Because of that, we transform
# pure column names into aliases, and use them in the ORDER BY.
aliases = {}
for subexpr in expr.exprs:
if isinstance(subexpr, Select):
columns = subexpr.columns
if not isinstance(columns, (tuple, list)):
columns = [columns]
else:
columns = list(columns)
for i, column in enumerate(columns):
if column not in aliases:
if isinstance(column, Column):
aliases[column] = columns[i] = Alias(column)
elif isinstance(column, Alias):
aliases[column.expr] = column
subexpr.columns = columns
state.push("context", SELECT)
# In the statement:
# SELECT foo UNION SELECT bar LIMIT 1
# The LIMIT 1 applies to the union results, not the SELECT bar
# This ensures that parentheses will be placed around the
# sub-selects in the expression.
state.precedence += 0.5
oper = expr.oper
if expr.all:
oper += "ALL "
statement = compile(expr.exprs, state, join=oper)
state.precedence -= 0.5
if expr.order_by is not Undef:
state.context = COLUMN_NAME
if state.aliases is None:
state.push("aliases", aliases)
else:
# Previously defined aliases have precedence.
aliases.update(state.aliases)
state.aliases = aliases
aliases = None
statement += " ORDER BY " + compile(expr.order_by, state)
if aliases is not None:
state.pop()
if expr.limit is not Undef:
statement += " LIMIT %d" % expr.limit
if expr.offset is not Undef:
statement += " OFFSET %d" % expr.offset
state.pop()
return statement
class Union(SetExpr):
__slots__ = ()
oper = " UNION "
class Except(SetExpr):
__slots__ = ()
oper = " EXCEPT "
class Intersect(SetExpr):
__slots__ = ()
oper = " INTERSECT "
# --------------------------------------------------------------------
# Functions
class FuncExpr(ComparableExpr):
__slots__ = ()
name = "(unknown)"
class Count(FuncExpr):
__slots__ = ("column", "distinct")
name = "COUNT"
def __init__(self, column=Undef, distinct=False):
if distinct and column is Undef:
raise ValueError("Must specify column when using distinct count")
self.column = column
self.distinct = distinct
@compile.when(Count)
def compile_count(compile, count, state):
if count.column is not Undef:
state.push("context", EXPR)
column = compile(count.column, state)
state.pop()
if count.distinct:
return "COUNT(DISTINCT %s)" % column
return "COUNT(%s)" % column
return "COUNT(*)"
class Func(FuncExpr):
__slots__ = ("name", "args")
def __init__(self, name, *args):
self.name = name
self.args = args
class NamedFunc(FuncExpr):
__slots__ = ("args",)
def __init__(self, *args):
self.args = args
@compile.when(Func, NamedFunc)
def compile_func(compile, func, state):
state.push("context", EXPR)
args = compile(func.args, state)
state.pop()
return "%s(%s)" % (func.name, args)
class Max(NamedFunc):
__slots__ = ()
name = "MAX"
class Min(NamedFunc):
__slots__ = ()
name = "MIN"
class Avg(NamedFunc):
__slots__ = ()
name = "AVG"
class Sum(NamedFunc):
__slots__ = ()
name = "SUM"
class Lower(NamedFunc):
__slots__ = ()
name = "LOWER"
class Upper(NamedFunc):
__slots__ = ()
name = "UPPER"
class Coalesce(NamedFunc):
__slots__ = ()
name = "COALESCE"
# --------------------------------------------------------------------
# Prefix and suffix expressions
class PrefixExpr(Expr):
__slots__ = ("expr",)
prefix = "(unknown)"
def __init__(self, expr):
self.expr = expr
@compile.when(PrefixExpr)
def compile_prefix_expr(compile, expr, state):
return "%s %s" % (expr.prefix, compile(expr.expr, state))
class SuffixExpr(Expr):
__slots__ = ("expr",)
suffix = "(unknown)"
def __init__(self, expr):
self.expr = expr
@compile.when(SuffixExpr)
def compile_suffix_expr(compile, expr, state):
return "%s %s" % (compile(expr.expr, state, raw=True), expr.suffix)
class Not(PrefixExpr):
__slots__ = ()
prefix = "NOT"
class Exists(PrefixExpr):
__slots__ = ()
prefix = "EXISTS"
class Neg(PrefixExpr):
__slots__ = ()
prefix = "-"
@compile_python.when(Neg)
def compile_neg_expr(compile, expr, state):
return "-%s" % compile(expr.expr, state, raw=True)
class Asc(SuffixExpr):
__slots__ = ()
suffix = "ASC"
class Desc(SuffixExpr):
__slots__ = ()
suffix = "DESC"
# --------------------------------------------------------------------
# Plain SQL expressions.
class SQLRaw(str):
"""Subtype to mark a string as something that shouldn't be compiled.
This is handled internally by the compiler.
"""
__slots__ = ()
class SQLToken(str):
"""Marker for strings that should be considered as a single SQL token.
These strings will be quoted, when needed.
"""
__slots__ = ()
is_safe_token = re.compile("^[a-zA-Z][a-zA-Z0-9_]*$").match
@compile.when(SQLToken)
def compile_sql_token(compile, expr, state):
if is_safe_token(expr) and not compile.is_reserved_word(expr):
return expr
return '"%s"' % expr.replace('"', '""')
@compile_python.when(SQLToken)
def compile_python_sql_token(compile, expr, state):
return expr
class SQL(ComparableExpr):
__slots__ = ("expr", "params", "tables")
def __init__(self, expr, params=Undef, tables=Undef):
self.expr = expr
self.params = params
self.tables = tables
@compile.when(SQL)
def compile_sql(compile, expr, state):
if expr.params is not Undef:
if type(expr.params) not in (tuple, list):
raise CompileError("Parameters should be a list or a tuple, "
"not %r" % type(expr.params))
for param in expr.params:
state.parameters.append(param)
if expr.tables is not Undef:
state.auto_tables.append(expr.tables)
return expr.expr
# --------------------------------------------------------------------
# Sequences.
class Sequence(Expr):
"""Expression representing auto-incrementing support from the database.
This should be translated into the *next* value of the named
auto-incrementing sequence. There's no standard way to compile a
sequence, since it's very database-dependent.
This may be used as follows::
class Class(object):
(...)
id = Int(default=Sequence("my_sequence_name"))
"""
__slots__ = ("name",)
def __init__(self, name):
self.name = name
# --------------------------------------------------------------------
# Utility functions.
def compare_columns(columns, values):
if not columns:
return Undef
equals = []
if len(columns) == 1:
value = values[0]
if not isinstance(value, (Expr, Variable)) and value is not None:
value = columns[0].variable_factory(value=value)
return Eq(columns[0], value)
else:
for column, value in zip(columns, values):
if not isinstance(value, (Expr, Variable)) and value is not None:
value = column.variable_factory(value=value)
equals.append(Eq(column, value))
return And(*equals)
# --------------------------------------------------------------------
# Auto table
class AutoTables(Expr):
"""This class will inject one or more entries in state.auto_tables.
If the constructor is passed replace=True, it will also discard any
auto_table entries injected by compiling the given expression.
"""
__slots__ = ("expr", "tables", "replace")
def __init__(self, expr, tables, replace=False):
assert type(tables) in (list, tuple)
self.expr = expr
self.tables = tables
self.replace = replace
@compile.when(AutoTables)
def compile_auto_tables(compile, expr, state):
if expr.replace:
state.push("auto_tables", [])
statement = compile(expr.expr, state)
if expr.replace:
state.pop()
state.auto_tables.extend(expr.tables)
return statement
# --------------------------------------------------------------------
# Set operator precedences.
compile.set_precedence(10, Select, Insert, Update, Delete)
compile.set_precedence(10, Join, LeftJoin, RightJoin)
compile.set_precedence(10, NaturalJoin, NaturalLeftJoin, NaturalRightJoin)
compile.set_precedence(10, Union, Except, Intersect)
compile.set_precedence(20, SQL)
compile.set_precedence(30, Or)
compile.set_precedence(40, And)
compile.set_precedence(50, Eq, Ne, Gt, Ge, Lt, Le, Like, In)
compile.set_precedence(60, LShift, RShift)
compile.set_precedence(70, Add, Sub)
compile.set_precedence(80, Mul, Div, Mod)
compile_python.set_precedence(10, Or)
compile_python.set_precedence(20, And)
compile_python.set_precedence(30, Eq, Ne, Gt, Ge, Lt, Le, Like, In)
compile_python.set_precedence(40, LShift, RShift)
compile_python.set_precedence(50, Add, Sub)
compile_python.set_precedence(60, Mul, Div, Mod)
# --------------------------------------------------------------------
# Reserved words, from SQL1992
compile.add_reserved_words(
"""
absolute action add all allocate alter and any are as asc assertion at
authorization avg begin between bit bit_length both by cascade cascaded
case cast catalog char character char_ length character_length check close
coalesce collate collation column commit connect connection constraint
constraints continue convert corresponding count create cross current
current_date current_time current_timestamp current_ user cursor date day
deallocate dec decimal declare default deferrable deferred delete desc
describe descriptor diagnostics disconnect distinct domain double drop
else end end-exec escape except exception exec execute exists external
extract false fetch first float for foreign found from full get global go
goto grant group having hour identity immediate in indicator initially
inner input insensitive insert int integer intersect interval into is
isolation join key language last leading left level like local lower
match max min minute module month names national natural nchar next no
not null nullif numeric octet_length of on only open option or order
outer output overlaps pad partial position precision prepare preserve
primary prior privileges procedure public read real references relative
restrict revoke right rollback rows schema scroll second section select
session session_ user set size smallint some space sql sqlcode sqlerror
sqlstate substring sum system_user table temporary then time timestamp
timezone_ hour timezone_minute to trailing transaction translate
translation trim true union unique unknown update upper usage user using
value values varchar varying view when whenever where with work write
year zone
""".split())
|