Project

General

Profile

1 53 aaronmk
#!/usr/bin/env python
2
# Maps one datasource to another, using a map spreadsheet if needed
3 986 aaronmk
# Exit status is the # of errors in the import, up to the maximum exit status
4 53 aaronmk
# For outputting an XML file to a PostgreSQL database, use the general format of
5
# http://vegbank.org/vegdocs/xml/vegbank_example_ver1.0.2.xml
6
7 1014 aaronmk
import csv
8 1714 aaronmk
import itertools
9 53 aaronmk
import os.path
10
import sys
11 299 aaronmk
import xml.dom.minidom as minidom
12 53 aaronmk
13 266 aaronmk
sys.path.append(os.path.dirname(__file__)+"/../lib")
14 53 aaronmk
15 1389 aaronmk
import csvs
16 344 aaronmk
import exc
17 1714 aaronmk
import iters
18 1705 aaronmk
import maps
19 64 aaronmk
import opts
20 1859 aaronmk
import parallel
21 281 aaronmk
import Parser
22 982 aaronmk
import profiling
23 131 aaronmk
import sql
24 1758 aaronmk
import streams
25 715 aaronmk
import strings
26 828 aaronmk
import term
27 310 aaronmk
import util
28 1014 aaronmk
import xpath
29 133 aaronmk
import xml_dom
30 86 aaronmk
import xml_func
31 1713 aaronmk
import xml_parse
32 53 aaronmk
33 1404 aaronmk
def get_with_prefix(map_, prefixes, key):
34 1484 aaronmk
    '''Gets all entries for the given key with any of the given prefixes'''
35
    values = []
36 1681 aaronmk
    for key_ in strings.with_prefixes(['']+prefixes, key): # also with no prefix
37
        try: value = map_[key_]
38 1484 aaronmk
        except KeyError, e: continue # keep going
39
        values.append(value)
40
41
    if values != []: return values
42
    else: raise e # re-raise last KeyError
43 1404 aaronmk
44 1018 aaronmk
def metadata_value(name): return None # this feature has been removed
45 84 aaronmk
46 1360 aaronmk
def cleanup(val):
47
    if val == None: return val
48 1374 aaronmk
    return util.none_if(strings.cleanup(strings.ustr(val)), u'', u'\\N')
49 1360 aaronmk
50 847 aaronmk
def main_():
51 131 aaronmk
    env_names = []
52
    def usage_err():
53 944 aaronmk
        raise SystemExit('Usage: '+opts.env_usage(env_names, True)+' '
54 1945 aaronmk
            +sys.argv[0]+' [map_path...] [<input] [>output]\n'
55 1946 aaronmk
            'Note: Row #s start with 1')
56 838 aaronmk
57 1570 aaronmk
    ## Get config from env vars
58 838 aaronmk
59 1570 aaronmk
    # Modes
60 946 aaronmk
    test = opts.env_flag('test', False, env_names)
61 947 aaronmk
    commit = opts.env_flag('commit', False, env_names) and not test
62 944 aaronmk
        # never commit in test mode
63 947 aaronmk
    redo = opts.env_flag('redo', test, env_names) and not commit
64
        # never redo in commit mode (manually run `make empty_db` instead)
65 1570 aaronmk
66
    # Ranges
67 1946 aaronmk
    start = util.cast(int, opts.get_env_var('start', 1, env_names)) # 1-based
68
    # Make start interally 0-based.
69
    # It's 1-based to the user to match up with the staging table row #s.
70
    start -= 1
71 1945 aaronmk
    if test: n_default = 1
72
    else: n_default = None
73
    n = util.cast(int, util.none_if(opts.get_env_var('n', n_default, env_names),
74
        u''))
75
    end = n
76 1570 aaronmk
    if end != None: end += start
77
78
    # Debugging
79 946 aaronmk
    debug = opts.env_flag('debug', False, env_names)
80 859 aaronmk
    sql.run_raw_query.debug = debug
81 1574 aaronmk
    verbose = debug or opts.env_flag('verbose', not test, env_names)
82 944 aaronmk
    opts.get_env_var('profile_to', None, env_names) # add to env_names
83 131 aaronmk
84 1570 aaronmk
    # DB
85
    def get_db_config(prefix):
86 1926 aaronmk
        return opts.get_env_vars(sql.db_config_names, prefix, env_names)
87 1570 aaronmk
    in_db_config = get_db_config('in')
88
    out_db_config = get_db_config('out')
89
    in_is_db = 'engine' in in_db_config
90
    out_is_db = 'engine' in out_db_config
91 1982 aaronmk
    in_schema = opts.get_env_var('in_schema', None, env_names)
92
    in_table = opts.get_env_var('in_table', None, env_names)
93 1570 aaronmk
94 1989 aaronmk
    # Optimization
95
    by_col = in_db_config == out_db_config and opts.env_flag('by_col', False,
96
        env_names) # by-column optimization only applies if mapping to same DB
97
    if test: cpus_default = 0
98
    else: cpus_default = None
99
    cpus = util.cast(int, util.none_if(opts.get_env_var('cpus', cpus_default,
100
        env_names), u''))
101
102 1570 aaronmk
    ##
103
104 838 aaronmk
    # Logging
105 662 aaronmk
    def log(msg, on=verbose):
106 1901 aaronmk
        if on: sys.stderr.write(msg+'\n')
107
    if debug: log_debug = lambda msg: log(msg, debug)
108
    else: log_debug = sql.log_debug_none
109 662 aaronmk
110 53 aaronmk
    # Parse args
111 510 aaronmk
    map_paths = sys.argv[1:]
112 512 aaronmk
    if map_paths == []:
113
        if in_is_db or not out_is_db: usage_err()
114
        else: map_paths = [None]
115 53 aaronmk
116 646 aaronmk
    def connect_db(db_config):
117 1901 aaronmk
        log('Connecting to '+sql.db_config_str(db_config))
118
        return sql.connect(db_config, log_debug=log_debug)
119 646 aaronmk
120 1945 aaronmk
    if end != None: end_str = str(end-1) # end is one past the last #
121 1573 aaronmk
    else: end_str = 'end'
122 1901 aaronmk
    log('Processing input rows '+str(start)+'-'+end_str)
123 1573 aaronmk
124 1014 aaronmk
    ex_tracker = exc.ExPercentTracker(iter_text='row')
125
    profiler = profiling.ItersProfiler(start_now=True, iter_text='row')
126
127 1856 aaronmk
    # Parallel processing
128 1862 aaronmk
    pool = parallel.MultiProducerPool(cpus)
129 1901 aaronmk
    log('Using '+str(pool.process_ct)+' parallel CPUs')
130 1846 aaronmk
131 1014 aaronmk
    doc = xml_dom.create_doc()
132
    root = doc.documentElement
133 751 aaronmk
    out_is_xml_ref = [False]
134 1014 aaronmk
    in_label_ref = [None]
135
    def update_in_label():
136
        if in_label_ref[0] != None:
137
            xpath.get(root, '/_ignore/inLabel="'+in_label_ref[0]+'"', True)
138
    def prep_root():
139
        root.clear()
140
        update_in_label()
141
    prep_root()
142 751 aaronmk
143 1991 aaronmk
    # Define before the out_is_db section because it's used by by_col
144
    row_ins_ct_ref = [0]
145
146 838 aaronmk
    def process_input(root, row_ready, map_path):
147 512 aaronmk
        '''Inputs datasource to XML tree, mapping if needed'''
148
        # Load map header
149
        in_is_xpaths = True
150 751 aaronmk
        out_is_xpaths = True
151 512 aaronmk
        out_label = None
152
        if map_path != None:
153
            metadata = []
154
            mappings = []
155
            stream = open(map_path, 'rb')
156
            reader = csv.reader(stream)
157
            in_label, out_label = reader.next()[:2]
158 1402 aaronmk
159 512 aaronmk
            def split_col_name(name):
160 1402 aaronmk
                label, sep, root = name.partition(':')
161
                label, sep2, prefixes_str = label.partition('[')
162
                prefixes_str = strings.remove_suffix(']', prefixes_str)
163
                prefixes = strings.split(',', prefixes_str)
164
                return label, sep != '', root, prefixes
165 1198 aaronmk
                    # extract datasrc from "datasrc[data_format]"
166 1402 aaronmk
167 1705 aaronmk
            in_label, in_root, prefixes = maps.col_info(in_label)
168
            in_is_xpaths = in_root != None
169 1014 aaronmk
            in_label_ref[0] = in_label
170
            update_in_label()
171 1705 aaronmk
            out_label, out_root = maps.col_info(out_label)[:2]
172
            out_is_xpaths = out_root != None
173 1841 aaronmk
            if out_is_xpaths: has_types = out_root.find('/*s/') >= 0
174 1705 aaronmk
                # outer elements are types
175 1402 aaronmk
176 512 aaronmk
            for row in reader:
177
                in_, out = row[:2]
178 2029 aaronmk
                if out != '': mappings.append([in_, out_root+out])
179 1402 aaronmk
180 512 aaronmk
            stream.close()
181
182
            root.ownerDocument.documentElement.tagName = out_label
183
        in_is_xml = in_is_xpaths and not in_is_db
184 751 aaronmk
        out_is_xml_ref[0] = out_is_xpaths and not out_is_db
185 56 aaronmk
186 2029 aaronmk
        # Prevent collisions if multiple inputs mapping to same output
187
        outputs_idxs = dict()
188
        for i, mapping in enumerate(mappings):
189
            in_, out = mapping
190
            default = util.NamedTuple(count=1, first=i)
191
            idxs = outputs_idxs.setdefault(out, default)
192
            if idxs is not default: # key existed, so there was a collision
193
                if idxs.count == 1: # first key does not yet have /_alt/#
194
                    mappings[idxs.first][1] += '/_alt/0'
195
                mappings[i][1] += '/_alt/'+str(idxs.count)
196
                idxs.count += 1
197
198 1897 aaronmk
        def process_rows(process_row, rows, rows_start=0):
199
            '''Processes input rows
200 838 aaronmk
            @param process_row(in_row, i)
201 1945 aaronmk
            @rows_start The (0-based) row # of the first row in rows. Set this
202
                only if the pre-start rows have already been skipped.
203 297 aaronmk
            '''
204 1897 aaronmk
            rows = iter(rows)
205
206
            if end != None: row_nums = xrange(rows_start, end)
207
            else: row_nums = itertools.count(rows_start)
208
            for i in row_nums:
209 1718 aaronmk
                try: row = rows.next()
210
                except StopIteration: break # no more rows
211
                if i < start: continue # not at start row yet
212
213 838 aaronmk
                process_row(row, i)
214
                row_ready(i, row)
215 1718 aaronmk
            row_ct = i-start
216 982 aaronmk
            return row_ct
217 838 aaronmk
218 1898 aaronmk
        def map_rows(get_value, rows, **kw_args):
219 838 aaronmk
            '''Maps input rows
220
            @param get_value(in_, row):str
221
            '''
222 2026 aaronmk
            id_node = None
223
            if out_is_db:
224
                for i, mapping in enumerate(mappings):
225
                    in_, out = mapping
226
                    # All put_obj()s should return the same id_node
227
                    nodes, id_node = xpath.put_obj(root, out, '-1', has_types,
228
                        '$'+str(in_)) # value is placeholder that documents name
229
                #assert id_node != None
230
231
                if debug: # only str() if debug
232
                    log_debug('Put template:\n'+str(root))
233
                prep_root()
234
235 838 aaronmk
            def process_row(row, i):
236 316 aaronmk
                row_id = str(i)
237
                for in_, out in mappings:
238 2027 aaronmk
                    log_debug('Getting '+str(in_))
239 316 aaronmk
                    value = metadata_value(in_)
240 2027 aaronmk
                    if value == None: value = cleanup(get_value(in_, row))
241
                    log_debug('Putting '+repr(value)+' to '+str(out))
242 2015 aaronmk
                    if out_is_db or value != None:
243 1360 aaronmk
                        xpath.put_obj(root, out, row_id, has_types, value)
244 2027 aaronmk
                if debug: log_debug('Putting:\n'+str(root))# only str() if debug
245 1898 aaronmk
            return process_rows(process_row, rows, **kw_args)
246 297 aaronmk
247 1898 aaronmk
        def map_table(col_names, rows, **kw_args):
248 1416 aaronmk
            col_names_ct = len(col_names)
249 1403 aaronmk
            col_idxs = util.list_flip(col_names)
250
251 2029 aaronmk
            # Resolve prefixes
252 2025 aaronmk
            mappings_orig = mappings[:] # save a copy
253
            mappings[:] = [] # empty existing elements
254
            for in_, out in mappings_orig:
255 1403 aaronmk
                if metadata_value(in_) == None:
256 2025 aaronmk
                    try: names = get_with_prefix(col_idxs, prefixes, in_)
257
                    except KeyError: pass
258 2029 aaronmk
                    else: mappings.append([names, out])
259 1403 aaronmk
260
            def get_value(in_, row):
261 1484 aaronmk
                return util.coalesce(*util.list_subset(row.list, in_))
262 1416 aaronmk
            def wrap_row(row):
263
                return util.ListDict(util.list_as_length(row, col_names_ct),
264
                    col_names, col_idxs) # handle CSV rows of different lengths
265 1403 aaronmk
266 1898 aaronmk
            return map_rows(get_value, util.WrapIter(wrap_row, rows), **kw_args)
267 1403 aaronmk
268 1758 aaronmk
        stdin = streams.LineCountStream(sys.stdin)
269
        def on_error(e):
270
            exc.add_msg(e, term.emph('input line #:')+' '+str(stdin.line_num))
271
            ex_tracker.track(e)
272
273 1700 aaronmk
        if in_is_db:
274 1982 aaronmk
            in_db = connect_db(in_db_config)
275 126 aaronmk
276 1982 aaronmk
            # Get table and schema name
277
            schema = in_schema # modified, so can't have same name as outer var
278
            table = in_table # modified, so can't have same name as outer var
279
            if table == None:
280
                assert in_is_xpaths
281
                schema, sep, table = in_root.partition('.')
282
                if sep == '': # only the table name was specified
283
                    table = schema
284
                    schema = None
285
            table_is_esc = False
286
            if schema != None:
287
                table = sql.qual_name(in_db, schema, table)
288
                table_is_esc = True
289
290 1991 aaronmk
            # Fetch rows
291
            if by_col: limit = 0 # only fetch column names
292
            else: limit = n
293
            cur = sql.select(in_db, table, limit=limit, start=start,
294
                table_is_esc=table_is_esc)
295
            col_names = list(sql.col_names(cur))
296
297 1989 aaronmk
            if by_col:
298 1991 aaronmk
                row_ready = lambda row_num, input_row: None# disable row_ready()
299 1994 aaronmk
                row = ['$'+v for v in col_names] # values are the column names
300
                map_table(col_names, [row]) # map just the sample row
301 1993 aaronmk
                xml_func.strip(root)
302 1998 aaronmk
                db_xml.put_table(in_db, root.firstChild, table, commit,
303
                    row_ins_ct_ref, table_is_esc)
304 1984 aaronmk
            else:
305
                # Use normal by-row method
306 1991 aaronmk
                row_ct = map_table(col_names, sql.rows(cur), rows_start=start)
307
                    # rows_start: pre-start rows have been skipped
308 1136 aaronmk
309 1849 aaronmk
            in_db.db.close()
310 161 aaronmk
        elif in_is_xml:
311 1715 aaronmk
            def get_rows(doc2rows):
312 1758 aaronmk
                return iters.flatten(itertools.imap(doc2rows,
313
                    xml_parse.docs_iter(stdin, on_error)))
314 1715 aaronmk
315 1714 aaronmk
            if map_path == None:
316 1715 aaronmk
                def doc2rows(in_xml_root):
317 1701 aaronmk
                    iter_ = xml_dom.NodeElemIter(in_xml_root)
318
                    util.skip(iter_, xml_dom.is_text) # skip metadata
319 1715 aaronmk
                    return iter_
320
321
                row_ct = process_rows(lambda row, i: root.appendChild(row),
322
                    get_rows(doc2rows))
323 1714 aaronmk
            else:
324 1715 aaronmk
                def doc2rows(in_xml_root):
325 1701 aaronmk
                    rows = xpath.get(in_xml_root, in_root, limit=end)
326 1714 aaronmk
                    if rows == []: raise SystemExit('Map error: Root "'
327
                        +in_root+'" not found in input')
328
                    return rows
329
330
                def get_value(in_, row):
331
                    in_ = './{'+(','.join(strings.with_prefixes(
332
                        ['']+prefixes, in_)))+'}' # also with no prefix
333
                    nodes = xpath.get(row, in_, allow_rooted=False)
334
                    if nodes != []: return xml_dom.value(nodes[0])
335
                    else: return None
336
337 1715 aaronmk
                row_ct = map_rows(get_value, get_rows(doc2rows))
338 56 aaronmk
        else: # input is CSV
339 133 aaronmk
            map_ = dict(mappings)
340 1389 aaronmk
            reader, col_names = csvs.reader_and_header(sys.stdin)
341 1403 aaronmk
            row_ct = map_table(col_names, reader)
342 982 aaronmk
343
        return row_ct
344 53 aaronmk
345 838 aaronmk
    def process_inputs(root, row_ready):
346 982 aaronmk
        row_ct = 0
347
        for map_path in map_paths:
348
            row_ct += process_input(root, row_ready, map_path)
349
        return row_ct
350 512 aaronmk
351 1886 aaronmk
    pool.share_vars(locals())
352 130 aaronmk
    if out_is_db:
353 53 aaronmk
        import db_xml
354
355 646 aaronmk
        out_db = connect_db(out_db_config)
356 53 aaronmk
        try:
357 947 aaronmk
            if redo: sql.empty_db(out_db)
358 1886 aaronmk
            pool.share_vars(locals())
359 449 aaronmk
360 838 aaronmk
            def row_ready(row_num, input_row):
361 452 aaronmk
                def on_error(e):
362 1946 aaronmk
                    exc.add_msg(e, term.emph('row #:')+' '+str(row_num+1))
363
                        # row # is interally 0-based, but 1-based to the user
364 828 aaronmk
                    exc.add_msg(e, term.emph('input row:')+'\n'+str(input_row))
365
                    exc.add_msg(e, term.emph('output row:')+'\n'+str(root))
366 1617 aaronmk
                    ex_tracker.track(e, row_num)
367 1886 aaronmk
                pool.share_vars(locals())
368 452 aaronmk
369 449 aaronmk
                xml_func.process(root, on_error)
370 442 aaronmk
                if not xml_dom.is_empty(root):
371
                    assert xml_dom.has_one_child(root)
372
                    try:
373 982 aaronmk
                        sql.with_savepoint(out_db,
374
                            lambda: db_xml.put(out_db, root.firstChild,
375 1850 aaronmk
                                row_ins_ct_ref, on_error))
376 1849 aaronmk
                        if commit: out_db.db.commit()
377 449 aaronmk
                    except sql.DatabaseErrors, e: on_error(e)
378 1010 aaronmk
                prep_root()
379 449 aaronmk
380 982 aaronmk
            row_ct = process_inputs(root, row_ready)
381
            sys.stdout.write('Inserted '+str(row_ins_ct_ref[0])+
382 460 aaronmk
                ' new rows into database\n')
383 1868 aaronmk
384
            # Consume asynchronous tasks
385
            pool.main_loop()
386 53 aaronmk
        finally:
387 1849 aaronmk
            out_db.db.rollback()
388
            out_db.db.close()
389 751 aaronmk
    else:
390 759 aaronmk
        def on_error(e): ex_tracker.track(e)
391 838 aaronmk
        def row_ready(row_num, input_row): pass
392 982 aaronmk
        row_ct = process_inputs(root, row_ready)
393 759 aaronmk
        xml_func.process(root, on_error)
394 751 aaronmk
        if out_is_xml_ref[0]:
395
            doc.writexml(sys.stdout, **xml_dom.prettyxml_config)
396
        else: # output is CSV
397
            raise NotImplementedError('CSV output not supported yet')
398 985 aaronmk
399 1868 aaronmk
    # Consume any asynchronous tasks not already consumed above
400 1862 aaronmk
    pool.main_loop()
401
402 982 aaronmk
    profiler.stop(row_ct)
403
    ex_tracker.add_iters(row_ct)
404 990 aaronmk
    if verbose:
405
        sys.stderr.write('Processed '+str(row_ct)+' input rows\n')
406
        sys.stderr.write(profiler.msg()+'\n')
407
        sys.stderr.write(ex_tracker.msg()+'\n')
408 985 aaronmk
    ex_tracker.exit()
409 53 aaronmk
410 847 aaronmk
def main():
411
    try: main_()
412 1719 aaronmk
    except Parser.SyntaxError, e: raise SystemExit(str(e))
413 847 aaronmk
414 846 aaronmk
if __name__ == '__main__':
415 847 aaronmk
    profile_to = opts.get_env_var('profile_to', None)
416
    if profile_to != None:
417
        import cProfile
418 1584 aaronmk
        sys.stderr.write('Profiling to '+profile_to+'\n')
419 847 aaronmk
        cProfile.run(main.func_code, profile_to)
420
    else: main()