Project

General

Profile

1 2211 aaronmk
# SQL code generation
2
3 2276 aaronmk
import operator
4 2568 aaronmk
import re
5 2653 aaronmk
import UserDict
6 2276 aaronmk
7 2667 aaronmk
import dicts
8 2360 aaronmk
import objects
9 2222 aaronmk
import strings
10 2227 aaronmk
import util
11 2211 aaronmk
12 2587 aaronmk
##### Names
13 2499 aaronmk
14 2608 aaronmk
identifier_max_len = 63 # works for both PostgreSQL and MySQL
15 2587 aaronmk
16
def add_suffix(str_, suffix):
17 2609 aaronmk
    '''Preserves version so that it won't be truncated off the string, leading
18
    to collisions.'''
19 2613 aaronmk
    # Preserve version
20
    before, sep, version = str_.rpartition('#')
21
    if sep != '': # found match
22
        str_ = before
23 2609 aaronmk
        suffix = sep+version+suffix
24 2613 aaronmk
25 2587 aaronmk
    return strings.add_suffix(str_, suffix, identifier_max_len)
26
27 2575 aaronmk
def is_safe_name(name):
28 2583 aaronmk
    '''A name is safe *and unambiguous* if it:
29
    * contains only *lowercase* word (\w) characters
30
    * doesn't start with a digit
31
    * contains "_", so that it's not a keyword
32
    '''
33
    return re.match(r'^(?=.*_)(?!\d)[^\WA-Z]+$', name)
34 2568 aaronmk
35 2499 aaronmk
def esc_name(name, quote='"'):
36
    return quote + name.replace(quote, quote+quote) + quote
37
        # doubling an embedded quote escapes it in both PostgreSQL and MySQL
38
39 2513 aaronmk
def clean_name(name): return name.replace('"', '').replace('`', '')
40
41 2659 aaronmk
##### General SQL code objects
42 2219 aaronmk
43 2349 aaronmk
class MockDb:
44 2503 aaronmk
    def esc_value(self, value): return strings.repr_no_u(value)
45 2349 aaronmk
46 2499 aaronmk
    def esc_name(self, name): return esc_name(name)
47 2349 aaronmk
mockDb = MockDb()
48
49 2514 aaronmk
class BasicObject(objects.BasicObject):
50
    def __init__(self, value): self.value = value
51
52
    def __str__(self): return clean_name(strings.repr_no_u(self))
53
54 2659 aaronmk
##### Unparameterized code objects
55
56 2514 aaronmk
class Code(BasicObject):
57 2658 aaronmk
    def to_str(self, db): raise NotImplementedError()
58 2349 aaronmk
59 2514 aaronmk
    def __repr__(self): return self.to_str(mockDb)
60 2211 aaronmk
61 2269 aaronmk
class CustomCode(Code):
62 2256 aaronmk
    def __init__(self, str_): self.str_ = str_
63
64
    def to_str(self, db): return self.str_
65
66 2659 aaronmk
def as_Code(value):
67
    if util.is_str(value): return CustomCode(value)
68
    else: return Literal(value)
69
70 2540 aaronmk
class Expr(Code):
71
    def __init__(self, expr): self.expr = expr
72
73
    def to_str(self, db): return '('+self.expr.to_str(db)+')'
74
75 2335 aaronmk
##### Literal values
76
77 2216 aaronmk
class Literal(Code):
78 2211 aaronmk
    def __init__(self, value): self.value = value
79 2213 aaronmk
80
    def to_str(self, db): return db.esc_value(self.value)
81 2211 aaronmk
82 2400 aaronmk
def as_Value(value):
83
    if isinstance(value, Code): return value
84
    else: return Literal(value)
85
86 2216 aaronmk
def is_null(value): return isinstance(value, Literal) and value.value == None
87
88 2335 aaronmk
##### Tables
89
90 2211 aaronmk
class Table(Code):
91
    def __init__(self, name, schema=None):
92
        '''
93
        @param schema str|None (for no schema)
94
        '''
95
        self.name = name
96
        self.schema = schema
97
98 2348 aaronmk
    def to_str(self, db):
99
        str_ = ''
100
        if self.schema != None: str_ += db.esc_name(self.schema)+'.'
101
        str_ += db.esc_name(self.name)
102
        return str_
103 2336 aaronmk
104
    def to_Table(self): return self
105 2211 aaronmk
106 2219 aaronmk
def as_Table(table):
107 2270 aaronmk
    if table == None or isinstance(table, Code): return table
108 2219 aaronmk
    else: return Table(table)
109
110 2336 aaronmk
class NamedTable(Table):
111
    def __init__(self, name, code, cols=None):
112
        Table.__init__(self, name)
113
114
        if not isinstance(code, Code): code = Table(code)
115
116
        self.code = code
117
        self.cols = cols
118
119
    def to_str(self, db):
120 2467 aaronmk
        str_ = self.code.to_str(db)+'\nAS '+Table.to_str(self, db)
121 2336 aaronmk
        if self.cols != None: str_ += ' ('+(', '.join(self.cols))+')'
122
        return str_
123
124
    def to_Table(self): return Table(self.name)
125
126 2335 aaronmk
##### Columns
127
128 2211 aaronmk
class Col(Code):
129
    def __init__(self, name, table=None):
130
        '''
131
        @param table Table|None (for no table)
132
        '''
133 2241 aaronmk
        if util.is_str(table): table = Table(table)
134 2211 aaronmk
        assert table == None or isinstance(table, Table)
135
136
        self.name = name
137
        self.table = table
138
139
    def to_str(self, db):
140
        str_ = ''
141
        if self.table != None: str_ += self.table.to_str(db)+'.'
142 2348 aaronmk
        str_ += db.esc_name(self.name)
143 2211 aaronmk
        return str_
144 2314 aaronmk
145
    def to_Col(self): return self
146 2211 aaronmk
147 2393 aaronmk
def is_table_col(col): return col.table != None
148
149 2563 aaronmk
def as_Col(col, table=None, name=None):
150
    '''
151
    @param name If not None, any non-Col input will be renamed using NamedCol.
152
    '''
153
    if name != None:
154
        col = as_Value(col)
155
        if not isinstance(col, Col): col = NamedCol(name, col)
156 2333 aaronmk
157
    if isinstance(col, Code): return col
158 2260 aaronmk
    else: return Col(col, table)
159
160 2401 aaronmk
def to_name_only_col(col, check_table=None):
161
    col = as_Col(col)
162 2579 aaronmk
    if not isinstance(col, Col): return col
163 2401 aaronmk
164
    if check_table != None:
165
        table = col.table
166
        assert table == None or table == check_table
167
    return Col(col.name)
168
169 2323 aaronmk
class NamedCol(Col):
170 2229 aaronmk
    def __init__(self, name, code):
171 2310 aaronmk
        Col.__init__(self, name)
172
173 2229 aaronmk
        if not isinstance(code, Code): code = Literal(code)
174
175
        self.code = code
176
177
    def to_str(self, db):
178 2310 aaronmk
        return self.code.to_str(db)+' AS '+Col.to_str(self, db)
179 2314 aaronmk
180
    def to_Col(self): return Col(self.name)
181 2229 aaronmk
182 2462 aaronmk
def remove_col_rename(col):
183
    if isinstance(col, NamedCol): col = col.code
184
    return col
185
186 2667 aaronmk
class ColDict(dicts.DictProxy):
187 2564 aaronmk
    '''A dict that automatically makes inserted entries Col objects'''
188
189 2645 aaronmk
    def __init__(self, db, keys_table, dict_={}):
190 2667 aaronmk
        dicts.DictProxy.__init__(self, {})
191
192 2645 aaronmk
        keys_table = as_Table(keys_table)
193
194 2642 aaronmk
        self.db = db
195 2641 aaronmk
        self.table = keys_table
196 2653 aaronmk
        self.update(dict_) # after setting vars because __setitem__() needs them
197 2641 aaronmk
198 2667 aaronmk
    def copy(self): return ColDict(self.db, self.table, self.inner.copy())
199 2655 aaronmk
200 2667 aaronmk
    def __getitem__(self, key):
201
        return dicts.DictProxy.__getitem__(self, self._key(key))
202 2653 aaronmk
203 2564 aaronmk
    def __setitem__(self, key, value):
204 2642 aaronmk
        key = self._key(key)
205 2661 aaronmk
        if value == None: value = self.db.col_default(key)
206 2667 aaronmk
        dicts.DictProxy.__setitem__(self, key, as_Col(value, name=key.name))
207 2564 aaronmk
208 2641 aaronmk
    def _key(self, key): return as_Col(key, self.table)
209 2564 aaronmk
210 2524 aaronmk
##### Functions
211
212
class Function(Table): pass
213
214 2691 aaronmk
class InternalFunction(CustomCode): pass
215
216 2524 aaronmk
class FunctionCall(Code):
217
    def __init__(self, function, *args):
218
        '''
219 2690 aaronmk
        @param args [Code|literal-value...] The function's arguments
220 2524 aaronmk
        '''
221
        if not isinstance(function, Code): function = Function(function)
222 2690 aaronmk
        args = map(remove_col_rename, map(as_Value, args))
223 2524 aaronmk
224
        self.function = function
225
        self.args = args
226
227
    def to_str(self, db):
228
        args_str = ', '.join((v.to_str(db) for v in self.args))
229
        return self.function.to_str(db)+'('+args_str+')'
230
231 2533 aaronmk
def wrap_in_func(function, value):
232
    '''Wraps a value inside a function call.
233
    Propagates any column renaming to the returned value.
234
    '''
235
    name = None
236
    if isinstance(value, NamedCol): name = value.name
237
    value = FunctionCall(function, value)
238
    if name != None: value = NamedCol(name, value)
239
    return value
240
241 2561 aaronmk
def unwrap_func_call(func_call, check_name=None):
242
    '''Unwraps any function call to its first argument.
243
    Also removes any column renaming.
244
    '''
245
    func_call = remove_col_rename(func_call)
246
    if not isinstance(func_call, FunctionCall): return func_call
247
248
    if check_name != None:
249
        name = func_call.function.name
250
        assert name == None or name == check_name
251
    return func_call.args[0]
252
253 2335 aaronmk
##### Conditions
254 2259 aaronmk
255 2398 aaronmk
class ColValueCond(Code):
256
    def __init__(self, col, value):
257
        value = as_ValueCond(value)
258
259
        self.col = col
260
        self.value = value
261
262
    def to_str(self, db): return self.value.to_str(db, self.col)
263
264 2577 aaronmk
def combine_conds(conds, keyword=None):
265
    '''
266
    @param keyword The keyword to add before the conditions, if any
267
    '''
268
    str_ = ''
269
    if keyword != None:
270
        if conds == []: whitespace = ''
271
        elif len(conds) == 1: whitespace = ' '
272
        else: whitespace = '\n'
273
        str_ += keyword+whitespace
274
275
    str_ += '\nAND '.join(conds)
276
    return str_
277
278 2398 aaronmk
##### Condition column comparisons
279
280 2514 aaronmk
class ValueCond(BasicObject):
281 2213 aaronmk
    def __init__(self, value):
282 2225 aaronmk
        if not isinstance(value, Code): value = Literal(value)
283 2462 aaronmk
        value = remove_col_rename(value)
284 2213 aaronmk
285
        self.value = value
286 2214 aaronmk
287 2216 aaronmk
    def to_str(self, db, left_value):
288 2214 aaronmk
        '''
289 2216 aaronmk
        @param left_value The Code object that the condition is being applied on
290 2214 aaronmk
        '''
291
        raise NotImplemented()
292 2228 aaronmk
293 2514 aaronmk
    def __repr__(self): return self.to_str(mockDb, '<left_value>')
294 2211 aaronmk
295
class CompareCond(ValueCond):
296
    def __init__(self, value, operator='='):
297 2222 aaronmk
        '''
298
        @param operator By default, compares NULL values literally. Use '~=' or
299
            '~!=' to pass NULLs through.
300
        '''
301 2211 aaronmk
        ValueCond.__init__(self, value)
302
        self.operator = operator
303
304 2216 aaronmk
    def to_str(self, db, left_value):
305
        if not isinstance(left_value, Code): left_value = Col(left_value)
306 2462 aaronmk
        left_value = remove_col_rename(left_value)
307 2216 aaronmk
308 2222 aaronmk
        right_value = self.value
309
        left = left_value.to_str(db)
310
        right = right_value.to_str(db)
311
312
        # Parse operator
313 2216 aaronmk
        operator = self.operator
314 2222 aaronmk
        passthru_null_ref = [False]
315
        operator = strings.remove_prefix('~', operator, passthru_null_ref)
316
        neg_ref = [False]
317
        operator = strings.remove_prefix('!', operator, neg_ref)
318
        equals = operator.endswith('=')
319
        if equals and is_null(self.value): operator = 'IS'
320
321
        # Create str
322
        str_ = left+' '+operator+' '+right
323
        if equals and not passthru_null_ref[0] and isinstance(right_value, Col):
324 2578 aaronmk
            str_ = '('+str_+' OR ('+left+' IS NULL AND '+right+' IS NULL))'
325
        if neg_ref[0]: str_ = 'NOT '+str_
326 2222 aaronmk
        return str_
327 2216 aaronmk
328 2260 aaronmk
# Tells as_ValueCond() to assume a non-ValueCond is a literal value
329
assume_literal = object()
330
331
def as_ValueCond(value, default_table=assume_literal):
332
    if not isinstance(value, ValueCond):
333
        if default_table is not assume_literal:
334
            value = as_Col(value, default_table)
335
        return CompareCond(value)
336 2216 aaronmk
    else: return value
337 2219 aaronmk
338 2335 aaronmk
##### Joins
339
340 2352 aaronmk
join_same = object() # tells Join the left and right columns have the same name
341 2260 aaronmk
342 2353 aaronmk
# Tells Join the left and right columns have the same name and are never NULL
343
join_same_not_null = object()
344
345 2260 aaronmk
filter_out = object() # tells Join to filter out rows that match the join
346
347 2514 aaronmk
class Join(BasicObject):
348 2260 aaronmk
    def __init__(self, table, mapping, type_=None):
349
        '''
350
        @param mapping dict(right_table_col=left_table_col, ...)
351 2352 aaronmk
            * if left_table_col is join_same: left_table_col = right_table_col
352 2353 aaronmk
              * Note that right_table_col must be a string
353
            * if left_table_col is join_same_not_null:
354
              left_table_col = right_table_col and both have NOT NULL constraint
355
              * Note that right_table_col must be a string
356 2260 aaronmk
        @param type_ None (for plain join)|str (e.g. 'LEFT')|filter_out
357
            * filter_out: equivalent to 'LEFT' with the query filtered by
358
              `table_pkey IS NULL` (indicating no match)
359
        '''
360
        if util.is_str(table): table = Table(table)
361
        assert type_ == None or util.is_str(type_) or type_ is filter_out
362
363
        self.table = table
364
        self.mapping = mapping
365
        self.type_ = type_
366
367
    def to_str(self, db, left_table):
368 2353 aaronmk
        # Switch order (left_table is on the right in the comparison)
369
        right_table = left_table
370
        left_table = self.table # note left_table is reassigned
371
372 2260 aaronmk
        def join(entry):
373
            '''Parses non-USING joins'''
374
            right_table_col, left_table_col = entry
375
376 2353 aaronmk
            # Switch order (right_table_col is on the left in the comparison)
377
            left = right_table_col
378
            right = left_table_col
379
380 2260 aaronmk
            # Parse special values
381 2353 aaronmk
            if right is join_same: right = left
382
            elif right is join_same_not_null:
383
                right = CompareCond(as_Col(left, right_table), '~=')
384 2260 aaronmk
385 2353 aaronmk
            right = as_ValueCond(right, right_table)
386 2578 aaronmk
            return right.to_str(db, as_Col(left, left_table))
387 2260 aaronmk
388 2265 aaronmk
        # Create join condition
389
        type_ = self.type_
390 2276 aaronmk
        joins = self.mapping
391 2265 aaronmk
        if type_ is not filter_out and reduce(operator.and_,
392 2460 aaronmk
            (v is join_same_not_null for v in joins.itervalues())):
393 2260 aaronmk
            # all cols w/ USING, so can use simpler USING syntax
394 2298 aaronmk
            cols = (as_Col(v).to_str(db) for v in joins.iterkeys())
395
            join_cond = 'USING ('+(', '.join(cols))+')'
396 2576 aaronmk
        else:
397
            if len(joins) == 1: whitespace = ' '
398
            else: whitespace = '\n'
399 2577 aaronmk
            join_cond = combine_conds(map(join, joins.iteritems()), 'ON')
400 2260 aaronmk
401
        # Create join
402
        if type_ is filter_out: type_ = 'LEFT'
403 2266 aaronmk
        str_ = ''
404
        if type_ != None: str_ += type_+' '
405 2353 aaronmk
        str_ += 'JOIN '+left_table.to_str(db)+' '+join_cond
406 2266 aaronmk
        return str_
407 2349 aaronmk
408 2514 aaronmk
    def __repr__(self): return self.to_str(mockDb, '<left_table>')
409 2424 aaronmk
410
##### Value exprs
411
412
row_count = CustomCode('count(*)')
413 2674 aaronmk
414 2692 aaronmk
def EnsureNotNull(value, null=r'\N'):
415
    return FunctionCall(InternalFunction('coalesce'), value, null)
416
417 2674 aaronmk
##### Database structure
418
419
class TypedCol(Col):
420
    def __init__(self, name, type_):
421
        Col.__init__(self, name)
422
423
        self.type = type_
424
425
    def to_str(self, db): return Col.to_str(self, db)+' '+self.type
426
427
    def to_Col(self): return Col(self.name)