Repository navigation
Expand file tree
/
Copy pathstring.py
More file actions
270 lines (239 loc) · 7.15 KB
/
Copy pathstring.py
File metadata and controls
270 lines (239 loc) · 7.15 KB
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
##
# .string
##
"""
String split and join operations for dealing with literals and identifiers.
Notably, the functions in this module are intended to be used for simple
use-cases. It attempts to stay away from "real" parsing and simply provides
functions for common needs, like the ability to identify unquoted portions of a
query string so that logic or transformations can be applied to only unquoted
portions. Scanning for statement terminators, or safely interpolating
identifiers.
All functions deal with strict quoting rules.
"""
import re
def escape_literal(text):
"""
Replace every instance of ' with ''.
"""
return text.replace("'", "''")
def quote_literal(text):
"""
Escape the literal and wrap it in [single] quotations.
"""
return "'" + text.replace("'", "''") + "'"
def escape_ident(text):
"""
Replace every instance of " with "".
"""
return text.replace('"', '""')
def needs_quoting(text):
return not (text and not text[0].isdecimal() and text.replace('_', 'a').isalnum())
def quote_ident(text):
"""
Replace every instance of '"' with '""' *and* place '"' on each end.
"""
return '"' + text.replace('"', '""') + '"'
def quote_ident_if_needed(text):
"""
If needed, replace every instance of '"' with '""' *and* place '"' on each end.
Otherwise, just return the text.
"""
return quote_ident(text) if needs_quoting(text) else text
quote_re = re.compile(r"""(?xu)
E'(?:''|\\.|[^'])*(?:'|$) (?# Backslash escapes E'str')
| '(?:''|[^'])*(?:'|$) (?# Regular literals 'str')
| "(?:""|[^"])*(?:"|$) (?# Identifiers "str")
| (\$(?:[^0-9$]\w*)?\$).*?(?:\1|$) (?# Dollar quotes $$str$$)
""")
def split(text):
"""
split the string up by into non-quoted and quoted portions. Zero and even
numbered indexes are unquoted portions, while odd indexes are quoted
portions.
Unquoted portions are regular strings, whereas quoted portions are
pair-tuples specifying the quotation mechanism and the content thereof.
>>> list(split("select $$foobar$$"))
['select ', ('$$', 'foobar'), '']
If the split ends on a quoted section, it means the string's quote was not
terminated. Subsequently, there will be an even number of objects in the
list.
Quotation errors are detected, but never raised. Rather it's up to the user
to identify the best course of action for the given split.
"""
lastend = 0
re = quote_re
scan = re.scanner(text)
match = scan.search()
while match is not None:
# text preceding the quotation
yield text[lastend:match.start()]
# the dollar quote, if any
dq = match.groups()[0]
if dq is not None:
endoff = len(dq)
quote = dq
end = quote
else:
endoff = 1
q = text[match.start()]
if q == 'E':
quote = "E'"
end = "'"
else:
end = quote = q
# If the end is not the expected quote, it consumed
# the end. Be sure to check that the match's end - end offset
# is *not* the start, ie an empty quotation at the end of the string.
if text[match.end()-endoff:match.end()] != end \
or match.end() - endoff == match.start():
yield (quote, text[match.start()+len(quote):])
break
else:
yield (quote, text[match.start()+len(quote):match.end()-endoff])
lastend = match.end()
match = scan.search()
else:
# balanced quotes, yield the rest
yield text[lastend:]
def unsplit(splitted_iter):
"""
catenate a split string. This is needed to handle the special
cases created by pg.string.split(). (Run-away quotations, primarily)
"""
s = ''
quoted = False
i = iter(splitted_iter)
endq = ''
for x in i:
s += endq + x
try:
q, qtext = next(i)
s += q + qtext
if q == "E'":
endq = "'"
else:
endq = q
except StopIteration:
break
return s
def split_using(text, quote, sep = '.', maxsplit = -1):
"""
split the string on the seperator ignoring the separator in quoted areas.
This is only useful for simple quoted strings. Dollar quotes, and backslash
escapes are not supported.
"""
escape = quote * 2
esclen = len(escape)
offset = 0
tl = len(text)
end = tl
# Fast path: No quotes? Do a simple split.
if quote not in text:
return text.split(sep, maxsplit)
l = []
while len(l) != maxsplit:
# Look for the separator first
nextsep = text.find(sep, offset)
if nextsep == -1:
# it's over. there are no more seps
break
else:
# There's a sep ahead, but is there a quoted section before it?
nextquote = text.find(quote, offset, nextsep)
while nextquote != -1:
# Yep, there's a quote before the sep;
# need to eat the escaped portion.
nextquote = text.find(quote, nextquote + 1,)
while nextquote != -1:
if text.find(escape, nextquote, nextquote+esclen) != nextquote:
# Not an escape, so it's the end.
break
# Look for another quote past the escape quote.
nextquote = text.find(quote, nextquote + 2)
else:
# the sep was located in the escape, and
# the escape consumed the rest of the string.
nextsep = -1
break
nextsep = text.find(sep, nextquote + 1)
if nextsep == -1:
# it's over. there are no more seps
# [likely they were consumed by the escape]
break
nextquote = text.find(quote, nextquote + 1, nextsep)
if nextsep == -1:
break
l.append(text[offset:nextsep])
offset = nextsep + 1
l.append(text[offset:])
return l
def split_ident(text, sep = ',', quote = '"', maxsplit = -1):
"""
Split a series of identifiers using the specified separator.
"""
nr = []
for x in split_using(text, quote, sep = sep, maxsplit = maxsplit):
x = x.strip()
if x.startswith('"'):
if not x.endswith('"'):
raise ValueError(
"unterminated identifier quotation", x
)
else:
nr.append(x[1:-1].replace('""', '"'))
elif needs_quoting(x):
raise ValueError(
"non-ident characters in unquoted identifier", x
)
else:
# postgres implies a lower, so to stay consistent
# with it on qname joins, lower the unquoted identifier now.
nr.append(x.lower())
return nr
def split_qname(text, maxsplit = -1):
"""
Call to .split_ident() with a '.' sep parameter.
"""
return split_ident(text, maxsplit = maxsplit, sep = '.')
def qname(*args):
"""
Quote the identifiers and join them using '.'.
"""
return '.'.join([quote_ident(x) for x in args])
def qname_if_needed(*args):
return '.'.join([quote_ident_if_needed(x) for x in args])
def split_sql(sql, sep = ';'):
"""
Given SQL, safely split using the given separator.
Notably, this yields fully split text. This should be used instead of
split_sql_str() when quoted sections need be still be isolated.
>>> list(split_sql('select $$1$$ AS "foo;"; select 2;'))
[['select ', ('$$', '1'), ' AS ', ('"', 'foo;'), ''], (' select 2',), ['']]
"""
i = iter(split(sql))
cur = []
for part in i:
sections = part.split(sep)
if len(sections) < 2:
cur.append(part)
else:
cur.append(sections[0])
yield cur
for x in sections[1:-1]:
yield (x,)
cur = [sections[-1]]
try:
cur.append(next(i))
except StopIteration:
break
if cur:
yield cur
def split_sql_str(sql, sep = ';'):
"""
Identical to split_sql but yields unsplit text.
>>> list(split_sql_str('select $$1$$ AS "foo;"; select 2;'))
['select $$1$$ AS "foo;"', ' select 2', '']
"""
for x in split_sql(sql, sep = sep):
yield unsplit(x)