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