Project

General

Profile

1
# SQL code generation
2

    
3
import sql
4
import strings
5
import util
6

    
7
##### SQL code objects
8

    
9
class Code:
10
    def to_str(self, db): raise NotImplemented()
11
    
12
    def __str__(self): return str(self.__dict__)
13

    
14
class CustomCode:
15
    def __init__(self, str_): self.str_ = str_
16
    
17
    def to_str(self, db): return self.str_
18

    
19
class Literal(Code):
20
    def __init__(self, value): self.value = value
21
    
22
    def to_str(self, db): return db.esc_value(self.value)
23

    
24
def is_null(value): return isinstance(value, Literal) and value.value == None
25

    
26
class Table(Code):
27
    def __init__(self, name, schema=None):
28
        '''
29
        @param schema str|None (for no schema)
30
        '''
31
        self.name = name
32
        self.schema = schema
33
    
34
    def to_str(self, db): return sql.qual_name(db, self.schema, self.name)
35

    
36
def as_Table(table):
37
    if table == None or isinstance(table, Table): return table
38
    elif isinstance(table, tuple):
39
        schema, table = table
40
        return Table(table, schema)
41
    else: return Table(table)
42

    
43
class Col(Code):
44
    def __init__(self, name, table=None):
45
        '''
46
        @param table Table|None (for no table)
47
        '''
48
        if util.is_str(table): table = Table(table)
49
        assert table == None or isinstance(table, Table)
50
        
51
        self.name = name
52
        self.table = table
53
    
54
    def to_str(self, db):
55
        str_ = ''
56
        if self.table != None: str_ += self.table.to_str(db)+'.'
57
        str_ += sql.esc_name(db, self.name)
58
        return str_
59

    
60
class NamedCode(Code):
61
    def __init__(self, name, code):
62
        if not isinstance(code, Code): code = Literal(code)
63
        
64
        self.name = name
65
        self.code = code
66
    
67
    def to_str(self, db):
68
        return self.code.to_str(db)+' AS '+sql.esc_name(db, self.name)
69

    
70
##### Parameterized SQL code objects
71

    
72
class ValueCond:
73
    def __init__(self, value):
74
        if not isinstance(value, Code): value = Literal(value)
75
        
76
        self.value = value
77
    
78
    def to_str(self, db, left_value):
79
        '''
80
        @param left_value The Code object that the condition is being applied on
81
        '''
82
        raise NotImplemented()
83
    
84
    def __str__(self): return str(self.__dict__)
85

    
86
class CompareCond(ValueCond):
87
    def __init__(self, value, operator='='):
88
        '''
89
        @param operator By default, compares NULL values literally. Use '~=' or
90
            '~!=' to pass NULLs through.
91
        '''
92
        ValueCond.__init__(self, value)
93
        self.operator = operator
94
    
95
    def to_str(self, db, left_value):
96
        if not isinstance(left_value, Code): left_value = Col(left_value)
97
        
98
        right_value = self.value
99
        left = left_value.to_str(db)
100
        right = right_value.to_str(db)
101
        
102
        # Parse operator
103
        operator = self.operator
104
        passthru_null_ref = [False]
105
        operator = strings.remove_prefix('~', operator, passthru_null_ref)
106
        neg_ref = [False]
107
        operator = strings.remove_prefix('!', operator, neg_ref)
108
        equals = operator.endswith('=')
109
        if equals and is_null(self.value): operator = 'IS'
110
        
111
        # Create str
112
        str_ = left+' '+operator+' '+right
113
        if equals and not passthru_null_ref[0] and isinstance(right_value, Col):
114
            str_ += ' OR ('+left+' IS NULL AND '+right+' IS NULL)'
115
        if neg_ref[0]: str_ = 'NOT ('+str_+')'
116
        return str_
117

    
118
def as_ValueCond(value):
119
    if not isinstance(value, ValueCond): return CompareCond(value)
120
    else: return value
121

    
122
##### Old-style format support
123

    
124
def unescape_table(table):
125
    '''Currently only works with PostgreSQL.'''
126
    if table == None: return table
127
    
128
    assert table.count('.') <= 1
129
    parts = tuple((v.replace('"', '') for v in table.split('"."', 2)))
130
    if len(parts) == 1: parts, = parts
131
    return parts
132

    
133
def col2sql_gen(col, default_table=None, table_is_esc=False):
134
    '''Converts old-style (tuple-based) columns to sql_gen-compatible columns.
135
    @param table_is_esc If False, assumes any table name is not escaped or that
136
        re-escaping it will produce the same value.
137
    '''
138
    if isinstance(col, Col): return col # already in sql_gen form
139
    
140
    table = default_table
141
    if isinstance(col, tuple): table, col = col
142
    if table_is_esc: table = unescape_table(table)
143
    return Col(col, as_Table(table))
144

    
145
def value2sql_gen(value, default_table=None, table_is_esc=False,
146
    assume_col=False):
147
    '''Converts old-style (tuple-based) values to sql_gen-compatible values.
148
    @param table_is_esc If False, assumes any table name is not escaped or that
149
        re-escaping it will produce the same value.
150
    '''
151
    if isinstance(value, Code): return value # already in sql_gen form
152
    
153
    is_tuple = isinstance(value, tuple)
154
    if is_tuple and len(value) == 1: return Literal(value[0])
155
    if is_tuple or (assume_col and util.is_str(value)):
156
        return col2sql_gen(value, default_table, table_is_esc)
157
    else: return Literal(value)
158

    
159
def cond2sql_gen(value, default_table=None, table_is_esc=False,
160
    assume_col=False):
161
    '''Converts old-style (tuple-based) conditions to sql_gen-compatible values.
162
    @param table_is_esc If False, assumes any table name is not escaped or that
163
        re-escaping it will produce the same value.
164
    '''
165
    if isinstance(value, ValueCond): return value # already in sql_gen form
166
    
167
    return as_ValueCond(value2sql_gen(value, default_table, table_is_esc,
168
        assume_col))
(23-23/34)