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