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