Project

General

Profile

1 2211 aaronmk
# SQL code generation
2
3 2276 aaronmk
import operator
4
5 2360 aaronmk
import objects
6 2222 aaronmk
import strings
7 2227 aaronmk
import util
8 2211 aaronmk
9 2499 aaronmk
##### Escaping
10
11
def esc_name(name, quote='"'):
12
    return quote + name.replace(quote, quote+quote) + quote
13
        # doubling an embedded quote escapes it in both PostgreSQL and MySQL
14
15 2513 aaronmk
def clean_name(name): return name.replace('"', '').replace('`', '')
16
17 2219 aaronmk
##### SQL code objects
18
19 2349 aaronmk
class MockDb:
20 2503 aaronmk
    def esc_value(self, value): return strings.repr_no_u(value)
21 2349 aaronmk
22 2499 aaronmk
    def esc_name(self, name): return esc_name(name)
23 2349 aaronmk
mockDb = MockDb()
24
25 2514 aaronmk
class BasicObject(objects.BasicObject):
26
    def __init__(self, value): self.value = value
27
28
    def __str__(self): return clean_name(strings.repr_no_u(self))
29
30
class Code(BasicObject):
31 2211 aaronmk
    def to_str(self, db): raise NotImplemented()
32 2349 aaronmk
33 2514 aaronmk
    def __repr__(self): return self.to_str(mockDb)
34 2211 aaronmk
35 2269 aaronmk
class CustomCode(Code):
36 2256 aaronmk
    def __init__(self, str_): self.str_ = str_
37
38
    def to_str(self, db): return self.str_
39
40 2540 aaronmk
class Expr(Code):
41
    def __init__(self, expr): self.expr = expr
42
43
    def to_str(self, db): return '('+self.expr.to_str(db)+')'
44
45 2335 aaronmk
##### Literal values
46
47 2216 aaronmk
class Literal(Code):
48 2211 aaronmk
    def __init__(self, value): self.value = value
49 2213 aaronmk
50
    def to_str(self, db): return db.esc_value(self.value)
51 2211 aaronmk
52 2400 aaronmk
def as_Value(value):
53
    if isinstance(value, Code): return value
54
    else: return Literal(value)
55
56 2216 aaronmk
def is_null(value): return isinstance(value, Literal) and value.value == None
57
58 2335 aaronmk
##### Tables
59
60 2211 aaronmk
class Table(Code):
61
    def __init__(self, name, schema=None):
62
        '''
63
        @param schema str|None (for no schema)
64
        '''
65
        self.name = name
66
        self.schema = schema
67
68 2348 aaronmk
    def to_str(self, db):
69
        str_ = ''
70
        if self.schema != None: str_ += db.esc_name(self.schema)+'.'
71
        str_ += db.esc_name(self.name)
72
        return str_
73 2336 aaronmk
74
    def to_Table(self): return self
75 2211 aaronmk
76 2219 aaronmk
def as_Table(table):
77 2270 aaronmk
    if table == None or isinstance(table, Code): return table
78 2219 aaronmk
    else: return Table(table)
79
80 2336 aaronmk
class NamedTable(Table):
81
    def __init__(self, name, code, cols=None):
82
        Table.__init__(self, name)
83
84
        if not isinstance(code, Code): code = Table(code)
85
86
        self.code = code
87
        self.cols = cols
88
89
    def to_str(self, db):
90 2467 aaronmk
        str_ = self.code.to_str(db)+'\nAS '+Table.to_str(self, db)
91 2336 aaronmk
        if self.cols != None: str_ += ' ('+(', '.join(self.cols))+')'
92
        return str_
93
94
    def to_Table(self): return Table(self.name)
95
96 2335 aaronmk
##### Columns
97
98 2211 aaronmk
class Col(Code):
99
    def __init__(self, name, table=None):
100
        '''
101
        @param table Table|None (for no table)
102
        '''
103 2241 aaronmk
        if util.is_str(table): table = Table(table)
104 2211 aaronmk
        assert table == None or isinstance(table, Table)
105
106
        self.name = name
107
        self.table = table
108
109
    def to_str(self, db):
110
        str_ = ''
111
        if self.table != None: str_ += self.table.to_str(db)+'.'
112 2348 aaronmk
        str_ += db.esc_name(self.name)
113 2211 aaronmk
        return str_
114 2314 aaronmk
115
    def to_Col(self): return self
116 2211 aaronmk
117 2393 aaronmk
def is_table_col(col): return col.table != None
118
119 2563 aaronmk
def as_Col(col, table=None, name=None):
120
    '''
121
    @param name If not None, any non-Col input will be renamed using NamedCol.
122
    '''
123
    if name != None:
124
        col = as_Value(col)
125
        if not isinstance(col, Col): col = NamedCol(name, col)
126 2333 aaronmk
127
    if isinstance(col, Code): return col
128 2260 aaronmk
    else: return Col(col, table)
129
130 2401 aaronmk
def to_name_only_col(col, check_table=None):
131
    col = as_Col(col)
132
133
    if check_table != None:
134
        table = col.table
135
        assert table == None or table == check_table
136
    return Col(col.name)
137
138 2323 aaronmk
class NamedCol(Col):
139 2229 aaronmk
    def __init__(self, name, code):
140 2310 aaronmk
        Col.__init__(self, name)
141
142 2229 aaronmk
        if not isinstance(code, Code): code = Literal(code)
143
144
        self.code = code
145
146
    def to_str(self, db):
147 2310 aaronmk
        return self.code.to_str(db)+' AS '+Col.to_str(self, db)
148 2314 aaronmk
149
    def to_Col(self): return Col(self.name)
150 2229 aaronmk
151 2462 aaronmk
def remove_col_rename(col):
152
    if isinstance(col, NamedCol): col = col.code
153
    return col
154
155 2524 aaronmk
##### Functions
156
157
class Function(Table): pass
158
159
class FunctionCall(Code):
160
    def __init__(self, function, *args):
161
        '''
162
        @param args [Code...] The function's arguments
163
        '''
164
        if not isinstance(function, Code): function = Function(function)
165 2532 aaronmk
        args = map(remove_col_rename, args)
166 2524 aaronmk
167
        self.function = function
168
        self.args = args
169
170
    def to_str(self, db):
171
        args_str = ', '.join((v.to_str(db) for v in self.args))
172
        return self.function.to_str(db)+'('+args_str+')'
173
174 2533 aaronmk
def wrap_in_func(function, value):
175
    '''Wraps a value inside a function call.
176
    Propagates any column renaming to the returned value.
177
    '''
178
    name = None
179
    if isinstance(value, NamedCol): name = value.name
180
    value = FunctionCall(function, value)
181
    if name != None: value = NamedCol(name, value)
182
    return value
183
184 2561 aaronmk
def unwrap_func_call(func_call, check_name=None):
185
    '''Unwraps any function call to its first argument.
186
    Also removes any column renaming.
187
    '''
188
    func_call = remove_col_rename(func_call)
189
    if not isinstance(func_call, FunctionCall): return func_call
190
191
    if check_name != None:
192
        name = func_call.function.name
193
        assert name == None or name == check_name
194
    return func_call.args[0]
195
196 2335 aaronmk
##### Conditions
197 2259 aaronmk
198 2398 aaronmk
class ColValueCond(Code):
199
    def __init__(self, col, value):
200
        value = as_ValueCond(value)
201
202
        self.col = col
203
        self.value = value
204
205
    def to_str(self, db): return self.value.to_str(db, self.col)
206
207
##### Condition column comparisons
208
209 2514 aaronmk
class ValueCond(BasicObject):
210 2213 aaronmk
    def __init__(self, value):
211 2225 aaronmk
        if not isinstance(value, Code): value = Literal(value)
212 2462 aaronmk
        value = remove_col_rename(value)
213 2213 aaronmk
214
        self.value = value
215 2214 aaronmk
216 2216 aaronmk
    def to_str(self, db, left_value):
217 2214 aaronmk
        '''
218 2216 aaronmk
        @param left_value The Code object that the condition is being applied on
219 2214 aaronmk
        '''
220
        raise NotImplemented()
221 2228 aaronmk
222 2514 aaronmk
    def __repr__(self): return self.to_str(mockDb, '<left_value>')
223 2211 aaronmk
224
class CompareCond(ValueCond):
225
    def __init__(self, value, operator='='):
226 2222 aaronmk
        '''
227
        @param operator By default, compares NULL values literally. Use '~=' or
228
            '~!=' to pass NULLs through.
229
        '''
230 2211 aaronmk
        ValueCond.__init__(self, value)
231
        self.operator = operator
232
233 2216 aaronmk
    def to_str(self, db, left_value):
234
        if not isinstance(left_value, Code): left_value = Col(left_value)
235 2462 aaronmk
        left_value = remove_col_rename(left_value)
236 2216 aaronmk
237 2222 aaronmk
        right_value = self.value
238
        left = left_value.to_str(db)
239
        right = right_value.to_str(db)
240
241
        # Parse operator
242 2216 aaronmk
        operator = self.operator
243 2222 aaronmk
        passthru_null_ref = [False]
244
        operator = strings.remove_prefix('~', operator, passthru_null_ref)
245
        neg_ref = [False]
246
        operator = strings.remove_prefix('!', operator, neg_ref)
247
        equals = operator.endswith('=')
248
        if equals and is_null(self.value): operator = 'IS'
249
250
        # Create str
251
        str_ = left+' '+operator+' '+right
252
        if equals and not passthru_null_ref[0] and isinstance(right_value, Col):
253
            str_ += ' OR ('+left+' IS NULL AND '+right+' IS NULL)'
254
        if neg_ref[0]: str_ = 'NOT ('+str_+')'
255
        return str_
256 2216 aaronmk
257 2260 aaronmk
# Tells as_ValueCond() to assume a non-ValueCond is a literal value
258
assume_literal = object()
259
260
def as_ValueCond(value, default_table=assume_literal):
261
    if not isinstance(value, ValueCond):
262
        if default_table is not assume_literal:
263
            value = as_Col(value, default_table)
264
        return CompareCond(value)
265 2216 aaronmk
    else: return value
266 2219 aaronmk
267 2335 aaronmk
##### Joins
268
269 2352 aaronmk
join_same = object() # tells Join the left and right columns have the same name
270 2260 aaronmk
271 2353 aaronmk
# Tells Join the left and right columns have the same name and are never NULL
272
join_same_not_null = object()
273
274 2260 aaronmk
filter_out = object() # tells Join to filter out rows that match the join
275
276 2514 aaronmk
class Join(BasicObject):
277 2260 aaronmk
    def __init__(self, table, mapping, type_=None):
278
        '''
279
        @param mapping dict(right_table_col=left_table_col, ...)
280 2352 aaronmk
            * if left_table_col is join_same: left_table_col = right_table_col
281 2353 aaronmk
              * Note that right_table_col must be a string
282
            * if left_table_col is join_same_not_null:
283
              left_table_col = right_table_col and both have NOT NULL constraint
284
              * Note that right_table_col must be a string
285 2260 aaronmk
        @param type_ None (for plain join)|str (e.g. 'LEFT')|filter_out
286
            * filter_out: equivalent to 'LEFT' with the query filtered by
287
              `table_pkey IS NULL` (indicating no match)
288
        '''
289
        if util.is_str(table): table = Table(table)
290
        assert type_ == None or util.is_str(type_) or type_ is filter_out
291
292
        self.table = table
293
        self.mapping = mapping
294
        self.type_ = type_
295
296
    def to_str(self, db, left_table):
297 2353 aaronmk
        # Switch order (left_table is on the right in the comparison)
298
        right_table = left_table
299
        left_table = self.table # note left_table is reassigned
300
301 2260 aaronmk
        def join(entry):
302
            '''Parses non-USING joins'''
303
            right_table_col, left_table_col = entry
304
305 2353 aaronmk
            # Switch order (right_table_col is on the left in the comparison)
306
            left = right_table_col
307
            right = left_table_col
308
309 2260 aaronmk
            # Parse special values
310 2353 aaronmk
            if right is join_same: right = left
311
            elif right is join_same_not_null:
312
                right = CompareCond(as_Col(left, right_table), '~=')
313 2260 aaronmk
314 2353 aaronmk
            right = as_ValueCond(right, right_table)
315 2410 aaronmk
            return '('+right.to_str(db, as_Col(left, left_table))+')'
316 2260 aaronmk
317 2265 aaronmk
        # Create join condition
318
        type_ = self.type_
319 2276 aaronmk
        joins = self.mapping
320 2265 aaronmk
        if type_ is not filter_out and reduce(operator.and_,
321 2460 aaronmk
            (v is join_same_not_null for v in joins.itervalues())):
322 2260 aaronmk
            # all cols w/ USING, so can use simpler USING syntax
323 2298 aaronmk
            cols = (as_Col(v).to_str(db) for v in joins.iterkeys())
324
            join_cond = 'USING ('+(', '.join(cols))+')'
325 2467 aaronmk
        else: join_cond = 'ON\n'+('\nAND\n'.join(map(join, joins.iteritems())))
326 2260 aaronmk
327
        # Create join
328
        if type_ is filter_out: type_ = 'LEFT'
329 2266 aaronmk
        str_ = ''
330
        if type_ != None: str_ += type_+' '
331 2353 aaronmk
        str_ += 'JOIN '+left_table.to_str(db)+' '+join_cond
332 2266 aaronmk
        return str_
333 2349 aaronmk
334 2514 aaronmk
    def __repr__(self): return self.to_str(mockDb, '<left_table>')
335 2424 aaronmk
336
##### Value exprs
337
338
row_count = CustomCode('count(*)')