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