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