Project

General

Profile

1 996 aaronmk
# XML "function" nodes that transform their contents
2 86 aaronmk
3 111 aaronmk
import datetime
4 968 aaronmk
import re
5 1219 aaronmk
import sre_constants
6 111 aaronmk
7 818 aaronmk
import dates
8 300 aaronmk
import exc
9 917 aaronmk
import maps
10 1234 aaronmk
import strings
11 827 aaronmk
import term
12 1468 aaronmk
import units
13 1047 aaronmk
import util
14 86 aaronmk
import xml_dom
15 1321 aaronmk
import xpath
16 86 aaronmk
17 995 aaronmk
##### Exceptions
18
19 1518 aaronmk
class SyntaxException(exc.ExceptionWithCause):
20 797 aaronmk
    def __init__(self, cause):
21 1518 aaronmk
        exc.ExceptionWithCause.__init__(self, 'Invalid XML function syntax: '
22 962 aaronmk
            +exc.str_(cause))
23 278 aaronmk
24 843 aaronmk
class FormatException(SyntaxException): pass
25
26 995 aaronmk
##### Functions
27
28
funcs = {}
29
30
def process(node, on_error=exc.raise_):
31
    for child in xml_dom.NodeElemIter(node): process(child, on_error)
32
    name = node.tagName
33
    if name.startswith('_') and name in funcs:
34 1369 aaronmk
        try:
35
            value = funcs[name](xml_dom.NodeTextEntryIter(node))
36
            xml_dom.replace_with_text(node, value)
37
        except Exception, e: # also catch XML func internal errors
38 1371 aaronmk
            # Save in case another exception raised, overwriting sys.exc_info()
39
            exc.add_traceback(e)
40 1562 aaronmk
            str_ = strings.ustr(node)
41 995 aaronmk
            exc.add_msg(e, 'function:\n'+str_)
42
            xml_dom.replace(node, node.ownerDocument.createComment(
43 1234 aaronmk
                '\n'+term.emph_multiline(str_).replace('--','-')))
44
                # comments can't contain '--'
45 995 aaronmk
            on_error(e)
46
47 86 aaronmk
def map_items(func, items):
48
    return [(name, func(value)) for name, value in items]
49
50 1234 aaronmk
def cast(type_, val):
51
    '''Throws SyntaxException if can't cast'''
52
    try: return type_(val)
53
    except ValueError, e: raise SyntaxException(e)
54
55 278 aaronmk
def conv_items(type_, items):
56 1234 aaronmk
    return map_items(lambda val: cast(type_, val),
57
        xml_dom.TextEntryOnlyIter(items))
58 278 aaronmk
59 1469 aaronmk
##### XML functions
60 995 aaronmk
61
# Function names must start with _ to avoid collisions with real tags
62
# Functions take arguments (items)
63
64 1469 aaronmk
#### General
65
66 995 aaronmk
def _ignore(items):
67 994 aaronmk
    '''Used to "comment out" an XML subtree'''
68
    return None
69 995 aaronmk
funcs['_ignore'] = _ignore
70 994 aaronmk
71 1469 aaronmk
#### Conditionals
72
73 1234 aaronmk
def _eq(items):
74
    items = dict(items)
75
    try:
76
        left = items['left']
77
        right = items['right']
78
    except KeyError: return '' # a value was None
79
    return util.bool2str(left == right)
80
funcs['_eq'] = _eq
81
82
def _if(items):
83
    items = dict(items)
84
    try:
85
        cond = items['cond']
86
        then = items['then']
87
    except KeyError, e: raise SyntaxException(e)
88
    else_ = items.get('else', None)
89 1562 aaronmk
    cond = bool(cast(strings.ustr, cond))
90 1234 aaronmk
    if cond: return then
91
    else: return else_
92
funcs['_if'] = _if
93
94 1469 aaronmk
#### Combining values
95
96 995 aaronmk
def _alt(items):
97 113 aaronmk
    items = list(items)
98
    items.sort()
99 1186 aaronmk
    try: return items[0][1] # value of lowest-numbered item
100 1187 aaronmk
    except IndexError: return None # input got removed by e.g. SyntaxException
101 995 aaronmk
funcs['_alt'] = _alt
102 113 aaronmk
103 995 aaronmk
def _merge(items):
104 1234 aaronmk
    items = list(conv_items(strings.ustr, items))
105 1562 aaronmk
        # get *once* from iter, check types
106 917 aaronmk
    items.sort()
107
    return maps.merge_values(*[v for k, v in items])
108 995 aaronmk
funcs['_merge'] = _merge
109 917 aaronmk
110 995 aaronmk
def _label(items):
111 1412 aaronmk
    items = dict(conv_items(strings.ustr, items))
112 1562 aaronmk
        # get *once* from iter, check types
113 917 aaronmk
    try:
114
        label = items['label']
115
        value = items['value']
116
    except KeyError, e: raise SyntaxException(e)
117
    return label+': '+value
118 995 aaronmk
funcs['_label'] = _label
119 917 aaronmk
120 1469 aaronmk
#### Transforming values
121
122 1478 aaronmk
types_by_name = {None: strings.ustr, 'str': strings.ustr, 'float': float}
123 1477 aaronmk
124 1047 aaronmk
def _nullIf(items):
125 1562 aaronmk
    items = dict(conv_items(strings.ustr, items))
126 1477 aaronmk
    try: null = items['null']
127 1047 aaronmk
    except KeyError, e: raise SyntaxException(e)
128 1477 aaronmk
    value = items.get('value', None)
129 1219 aaronmk
    type_str = items.get('type', None)
130 1477 aaronmk
131
    try: type_ = types_by_name[type_str]
132
    except KeyError, e: raise SyntaxException(e)
133
    null = type_(null)
134
135
    try: return util.none_if(value, null)
136
    except ValueError: return value # value not convertible, so can't equal null
137 1047 aaronmk
funcs['_nullIf'] = _nullIf
138
139 1219 aaronmk
def _map(items):
140 1537 aaronmk
    '''Raises error if value not in map and no special '*' entry
141
    @param items
142
        <last_entry> Value
143
        <other_entries> name=value Mappings
144
            name "*" means all other input values
145
            value "*" means keep input value the same
146
            value "" means ignore input value
147
    '''
148 1562 aaronmk
    items = conv_items(strings.ustr, items) # get *once* from iter, check types
149 1471 aaronmk
    try: value = items.pop()[1] # last entry contains value
150 1219 aaronmk
    except IndexError, e: raise SyntaxException(e)
151
    map_ = dict(items)
152 1537 aaronmk
153
    try: new_value = map_[value]
154 1304 aaronmk
    except KeyError, e:
155 1537 aaronmk
        # Save traceback right away in case another exception raised
156
        se = SyntaxException(e)
157
        try: new_value = map_['*']
158
        except KeyError: raise se
159
    if new_value == '*': new_value = value # '*' means keep input value the same
160
    return util.none_if(new_value, u'') # empty map entry means None
161 1219 aaronmk
funcs['_map'] = _map
162
163
def _replace(items):
164 1562 aaronmk
    items = conv_items(strings.ustr, items) # get *once* from iter, check types
165 1424 aaronmk
    try: value = items.pop()[1] # last entry contains value
166 1219 aaronmk
    except IndexError, e: raise SyntaxException(e)
167
    try:
168
        for repl, with_ in items:
169
            if re.match(r'^\w+$', repl):
170
                repl = r'(?<![^\W_])'+repl+r'(?![^\W_])' # match whole word
171
            value = re.sub(repl, with_, value)
172
    except sre_constants.error, e: raise SyntaxException(e)
173 1427 aaronmk
    return util.none_if(value, u'') # empty strings always mean None
174 1219 aaronmk
funcs['_replace'] = _replace
175
176 1469 aaronmk
#### Quantities
177
178 1225 aaronmk
def _units(items):
179 1562 aaronmk
    items = conv_items(strings.ustr, items) # get *once* from iter, check types
180 1471 aaronmk
    try: last = items.pop() # last entry contains value
181
    except IndexError: return None # input is empty and no actions
182
    if last[0] != 'value': return None # input is empty
183
    str_ = last[1]
184
185
    quantity = units.str2quantity(str_)
186
    try:
187
        for action, units_ in items:
188
            units_ = util.none_if(units_, u'')
189
            if action == 'default': units.set_default_units(quantity, units_)
190 1567 aaronmk
            elif action == 'to':
191
                try: quantity = units.convert(quantity, units_)
192
                except ValueError, e: raise SyntaxException(e)
193 1471 aaronmk
            else: raise SyntaxException(ValueError('Invalid action: '+action))
194 1468 aaronmk
    except units.MissingUnitsException, e: raise SyntaxException(e)
195 1471 aaronmk
    return units.quantity2str(quantity)
196 1225 aaronmk
funcs['_units'] = _units
197
198 1399 aaronmk
def parse_range(str_, range_sep='-'):
199
    default = (str_, None)
200
    start, sep, end = str_.partition(range_sep)
201
    if sep == '': return default # not a range
202 1427 aaronmk
    if start == '' and range_sep == '-': return default # negative number
203 1399 aaronmk
    return tuple(d.strip() for d in (start, end))
204
205
def _rangeStart(items):
206 1562 aaronmk
    items = dict(conv_items(strings.ustr, items))
207 1399 aaronmk
    try: value = items['value']
208 1406 aaronmk
    except KeyError: return None # input is empty
209 1399 aaronmk
    return parse_range(value)[0]
210
funcs['_rangeStart'] = _rangeStart
211
212
def _rangeEnd(items):
213 1562 aaronmk
    items = dict(conv_items(strings.ustr, items))
214 1399 aaronmk
    try: value = items['value']
215 1406 aaronmk
    except KeyError: return None # input is empty
216 1399 aaronmk
    return parse_range(value)[1]
217
funcs['_rangeEnd'] = _rangeEnd
218
219 1472 aaronmk
def _range(items):
220
    items = dict(conv_items(float, items))
221
    from_ = items.get('from', None)
222
    to = items.get('to', None)
223
    if from_ == None or to == None: return None
224
    return str(to - from_)
225
funcs['_range'] = _range
226
227 995 aaronmk
def _avg(items):
228 86 aaronmk
    count = 0
229
    sum_ = 0.
230 278 aaronmk
    for name, value in conv_items(float, items):
231 86 aaronmk
        count += 1
232
        sum_ += value
233 1472 aaronmk
    if count == 0: return None # input is empty
234
    else: return str(sum_/count)
235 995 aaronmk
funcs['_avg'] = _avg
236 86 aaronmk
237 968 aaronmk
class CvException(Exception):
238
    def __init__(self):
239
        Exception.__init__(self, 'CV (coefficient of variation) values are only'
240
            ' allowed for ratio scale data '
241
            '(see <http://en.wikipedia.org/wiki/Coefficient_of_variation>)')
242
243 995 aaronmk
def _noCV(items):
244 968 aaronmk
    try: name, value = items.next()
245
    except StopIteration: return None
246
    if re.match('^(?i)CV *\d+$', value): raise SyntaxException(CvException())
247
    return value
248 995 aaronmk
funcs['_noCV'] = _noCV
249 968 aaronmk
250 1469 aaronmk
#### Dates
251
252 995 aaronmk
def _date(items):
253 1562 aaronmk
    items = dict(conv_items(strings.ustr, items))
254
        # get *once* from iter, check types
255 1514 aaronmk
    try: str_ = items['date']
256 786 aaronmk
    except KeyError:
257 1515 aaronmk
        # Year is required
258
        try: items['year']
259 1309 aaronmk
        except KeyError, e:
260
            if items == {}: return None # entire date is empty
261
            else: raise SyntaxException(e)
262 1515 aaronmk
263
        # Convert month name to number
264
        try: month = items['month']
265
        except KeyError: pass
266
        else:
267
            if not month.isdigit(): # month is name
268
                items['month'] = str(dates.strtotime(month).month)
269
270
        items = dict(conv_items(int, items.iteritems()))
271 786 aaronmk
        items.setdefault('month', 1)
272
        items.setdefault('day', 1)
273 1535 aaronmk
274
        for try_num in xrange(2):
275
            try:
276
                date = datetime.date(**items)
277
                break
278
            except ValueError, e:
279 1536 aaronmk
                if try_num > 0: raise SyntaxException(e)
280
                    # exception still raised after retry
281 1562 aaronmk
                msg = strings.ustr(e)
282 1535 aaronmk
                if msg == 'month must be in 1..12': # try swapping month and day
283
                    items['month'], items['day'] = items['day'], items['month']
284
                else: raise SyntaxException(e)
285 786 aaronmk
    else:
286 324 aaronmk
        try: year = float(str_)
287
        except ValueError:
288 1264 aaronmk
            try: date = dates.strtotime(str_)
289 324 aaronmk
            except ImportError: return str_
290
            except ValueError, e: raise SyntaxException(e)
291
        else: date = (datetime.date(int(year), 1, 1) +
292
            datetime.timedelta(round((year % 1.)*365)))
293 818 aaronmk
    try: return dates.strftime('%Y-%m-%d', date)
294 843 aaronmk
    except ValueError, e: raise FormatException(e)
295 995 aaronmk
funcs['_date'] = _date
296 86 aaronmk
297 1366 aaronmk
def _dateRangeStart(items):
298 1562 aaronmk
    items = dict(conv_items(strings.ustr, items))
299 1366 aaronmk
    try: value = items['value']
300 1406 aaronmk
    except KeyError: return None # input is empty
301 1366 aaronmk
    return dates.parse_date_range(value)[0]
302
funcs['_dateRangeStart'] = _dateRangeStart
303 1311 aaronmk
304 1366 aaronmk
def _dateRangeEnd(items):
305 1562 aaronmk
    items = dict(conv_items(strings.ustr, items))
306 1366 aaronmk
    try: value = items['value']
307 1406 aaronmk
    except KeyError: return None # input is empty
308 1366 aaronmk
    return dates.parse_date_range(value)[1]
309
funcs['_dateRangeEnd'] = _dateRangeEnd
310 1311 aaronmk
311 1469 aaronmk
#### Names
312
313 328 aaronmk
_name_parts_slices_items = [
314
    ('first', slice(None, 1)),
315
    ('middle', slice(1, -1)),
316
    ('last', slice(-1, None)),
317
]
318
name_parts_slices = dict(_name_parts_slices_items)
319
name_parts = [name for name, slice_ in _name_parts_slices_items]
320
321 995 aaronmk
def _name(items):
322 89 aaronmk
    items = dict(items)
323 102 aaronmk
    parts = []
324 328 aaronmk
    for part in name_parts:
325
        if part in items: parts.append(items[part])
326 102 aaronmk
    return ' '.join(parts)
327 995 aaronmk
funcs['_name'] = _name
328 102 aaronmk
329 995 aaronmk
def _namePart(items):
330 328 aaronmk
    out_items = []
331
    for part, value in items:
332
        try: slice_ = name_parts_slices[part]
333
        except KeyError, e: raise SyntaxException(e)
334 1219 aaronmk
        out_items.append((part, ' '.join(value.split(' ')[slice_])))
335 995 aaronmk
    return _name(out_items)
336
funcs['_namePart'] = _namePart
337 1321 aaronmk
338 1469 aaronmk
#### Paths
339
340 1321 aaronmk
def _simplifyPath(items):
341
    items = dict(items)
342
    try:
343 1562 aaronmk
        next = cast(strings.ustr, items['next'])
344
        require = cast(strings.ustr, items['require'])
345 1321 aaronmk
        root = items['path']
346
    except KeyError, e: raise SyntaxException(e)
347
348
    node = root
349
    while node != None:
350
        new_node = xpath.get_1(node, next, allow_rooted=False)
351
        if xpath.get_1(node, require, allow_rooted=False) == None: # empty elem
352
            xml_dom.replace(node, new_node) # remove current elem
353
            if node is root: root = new_node # also update root
354
        node = new_node
355
    return root
356
funcs['_simplifyPath'] = _simplifyPath