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