Project

General

Profile

1
#!/usr/bin/env python
2
# Maps one datasource to another, using a map spreadsheet if needed
3
# Exit status is the # of errors in the import, up to the maximum exit status
4
# 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
import csv
8
import itertools
9
import os.path
10
import sys
11
import xml.dom.minidom as minidom
12

    
13
sys.path.append(os.path.dirname(__file__)+"/../lib")
14

    
15
import csvs
16
import db_xml
17
import exc
18
import iters
19
import maps
20
import opts
21
import parallelproc
22
import Parser
23
import profiling
24
import sql
25
import sql_gen
26
import streams
27
import strings
28
import term
29
import util
30
import xpath
31
import xml_dom
32
import xml_func
33
import xml_parse
34

    
35
def get_with_prefix(map_, prefixes, key):
36
    '''Gets all entries for the given key with any of the given prefixes
37
    @return tuple(found_key, found_value)
38
    '''
39
    values = []
40
    for key_ in strings.with_prefixes(['']+prefixes, key): # also with no prefix
41
        try: value = map_[key_]
42
        except KeyError, e: continue # keep going
43
        values.append((key_, value))
44
    
45
    if values != []: return values
46
    else: raise e # re-raise last KeyError
47

    
48
def metadata_value(name): return None # this feature has been removed
49

    
50
def cleanup(val):
51
    if val == None: return val
52
    return util.none_if(strings.cleanup(strings.ustr(val)), u'', u'\\N')
53

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

    
431
def main():
432
    try: main_()
433
    except Parser.SyntaxError, e: raise SystemExit(str(e))
434

    
435
if __name__ == '__main__':
436
    profile_to = opts.get_env_var('profile_to', None)
437
    if profile_to != None:
438
        import cProfile
439
        sys.stderr.write('Profiling to '+profile_to+'\n')
440
        cProfile.run(main.func_code, profile_to)
441
    else: main()
(25-25/48)