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