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 281 aaronmk
import Parser
21 982 aaronmk
import profiling
22 131 aaronmk
import sql
23 715 aaronmk
import strings
24 828 aaronmk
import term
25 310 aaronmk
import util
26 1014 aaronmk
import xpath
27 133 aaronmk
import xml_dom
28 86 aaronmk
import xml_func
29 1713 aaronmk
import xml_parse
30 53 aaronmk
31 1404 aaronmk
def get_with_prefix(map_, prefixes, key):
32 1484 aaronmk
    '''Gets all entries for the given key with any of the given prefixes'''
33
    values = []
34 1681 aaronmk
    for key_ in strings.with_prefixes(['']+prefixes, key): # also with no prefix
35
        try: value = map_[key_]
36 1484 aaronmk
        except KeyError, e: continue # keep going
37
        values.append(value)
38
39
    if values != []: return values
40
    else: raise e # re-raise last KeyError
41 1404 aaronmk
42 1018 aaronmk
def metadata_value(name): return None # this feature has been removed
43 84 aaronmk
44 1360 aaronmk
def cleanup(val):
45
    if val == None: return val
46 1374 aaronmk
    return util.none_if(strings.cleanup(strings.ustr(val)), u'', u'\\N')
47 1360 aaronmk
48 847 aaronmk
def main_():
49 131 aaronmk
    env_names = []
50
    def usage_err():
51 944 aaronmk
        raise SystemExit('Usage: '+opts.env_usage(env_names, True)+' '
52 847 aaronmk
            +sys.argv[0]+' [map_path...] [<input] [>output]')
53 838 aaronmk
54 1570 aaronmk
    ## Get config from env vars
55 838 aaronmk
56 1570 aaronmk
    # Modes
57 946 aaronmk
    test = opts.env_flag('test', False, env_names)
58 947 aaronmk
    commit = opts.env_flag('commit', False, env_names) and not test
59 944 aaronmk
        # never commit in test mode
60 947 aaronmk
    redo = opts.env_flag('redo', test, env_names) and not commit
61
        # never redo in commit mode (manually run `make empty_db` instead)
62 1570 aaronmk
63
    # Ranges
64
    start = util.cast(int, opts.get_env_var('start', '0', env_names))
65 1572 aaronmk
    if test: end_default = 1
66
    else: end_default = None
67
    end = util.cast(int, util.none_if(
68
        opts.get_env_var('n', end_default, env_names), u''))
69 1570 aaronmk
    if end != None: end += start
70
71
    # Debugging
72 946 aaronmk
    debug = opts.env_flag('debug', False, env_names)
73 859 aaronmk
    sql.run_raw_query.debug = debug
74 1574 aaronmk
    verbose = debug or opts.env_flag('verbose', not test, env_names)
75 944 aaronmk
    opts.get_env_var('profile_to', None, env_names) # add to env_names
76 131 aaronmk
77 1570 aaronmk
    # DB
78
    db_config_names = ['engine', 'host', 'user', 'password', 'database']
79
    def get_db_config(prefix):
80
        return opts.get_env_vars(db_config_names, prefix, env_names)
81
    in_db_config = get_db_config('in')
82
    out_db_config = get_db_config('out')
83
    in_is_db = 'engine' in in_db_config
84
    out_is_db = 'engine' in out_db_config
85
86
    ##
87
88 838 aaronmk
    # Logging
89 662 aaronmk
    def log(msg, on=verbose):
90
        if on: sys.stderr.write(msg)
91 859 aaronmk
    def log_start(action, on=verbose): log(action+'...\n', on)
92 662 aaronmk
93 53 aaronmk
    # Parse args
94 510 aaronmk
    map_paths = sys.argv[1:]
95 512 aaronmk
    if map_paths == []:
96
        if in_is_db or not out_is_db: usage_err()
97
        else: map_paths = [None]
98 53 aaronmk
99 646 aaronmk
    def connect_db(db_config):
100 662 aaronmk
        log_start('Connecting to '+sql.db_config_str(db_config))
101 1014 aaronmk
        return sql.connect(db_config)
102 646 aaronmk
103 1573 aaronmk
    if end != None: end_str = str(end-1)
104
    else: end_str = 'end'
105
    log_start('Processing input rows '+str(start)+'-'+end_str)
106
107 1014 aaronmk
    ex_tracker = exc.ExPercentTracker(iter_text='row')
108
    profiler = profiling.ItersProfiler(start_now=True, iter_text='row')
109
110
    doc = xml_dom.create_doc()
111
    root = doc.documentElement
112 751 aaronmk
    out_is_xml_ref = [False]
113 1014 aaronmk
    in_label_ref = [None]
114
    def update_in_label():
115
        if in_label_ref[0] != None:
116
            xpath.get(root, '/_ignore/inLabel="'+in_label_ref[0]+'"', True)
117
    def prep_root():
118
        root.clear()
119
        update_in_label()
120
    prep_root()
121 751 aaronmk
122 838 aaronmk
    def process_input(root, row_ready, map_path):
123 512 aaronmk
        '''Inputs datasource to XML tree, mapping if needed'''
124
        # Load map header
125
        in_is_xpaths = True
126 751 aaronmk
        out_is_xpaths = True
127 512 aaronmk
        out_label = None
128
        if map_path != None:
129
            metadata = []
130
            mappings = []
131
            stream = open(map_path, 'rb')
132
            reader = csv.reader(stream)
133
            in_label, out_label = reader.next()[:2]
134 1402 aaronmk
135 512 aaronmk
            def split_col_name(name):
136 1402 aaronmk
                label, sep, root = name.partition(':')
137
                label, sep2, prefixes_str = label.partition('[')
138
                prefixes_str = strings.remove_suffix(']', prefixes_str)
139
                prefixes = strings.split(',', prefixes_str)
140
                return label, sep != '', root, prefixes
141 1198 aaronmk
                    # extract datasrc from "datasrc[data_format]"
142 1402 aaronmk
143 1705 aaronmk
            in_label, in_root, prefixes = maps.col_info(in_label)
144
            in_is_xpaths = in_root != None
145 1014 aaronmk
            in_label_ref[0] = in_label
146
            update_in_label()
147 1705 aaronmk
            out_label, out_root = maps.col_info(out_label)[:2]
148
            out_is_xpaths = out_root != None
149
            if out_is_xpaths: has_types = out_root.startswith('/*s/')
150
                # outer elements are types
151 1402 aaronmk
152 512 aaronmk
            for row in reader:
153
                in_, out = row[:2]
154
                if out != '':
155
                    if out_is_xpaths: out = xpath.parse(out_root+out)
156
                    mappings.append((in_, out))
157 1402 aaronmk
158 512 aaronmk
            stream.close()
159
160
            root.ownerDocument.documentElement.tagName = out_label
161
        in_is_xml = in_is_xpaths and not in_is_db
162 751 aaronmk
        out_is_xml_ref[0] = out_is_xpaths and not out_is_db
163 56 aaronmk
164 1148 aaronmk
        def process_rows(process_row, rows):
165 838 aaronmk
            '''Processes input rows
166
            @param process_row(in_row, i)
167 297 aaronmk
            '''
168 838 aaronmk
            i = -1 # in case for loop does not execute
169 314 aaronmk
            for i, row in enumerate(rows):
170 838 aaronmk
                if i < start: continue
171
                if end != None and i >= end: break
172
                process_row(row, i)
173
                row_ready(i, row)
174 978 aaronmk
            row_ct = i-start+1
175 982 aaronmk
            return row_ct
176 838 aaronmk
177
        def map_rows(get_value, rows):
178
            '''Maps input rows
179
            @param get_value(in_, row):str
180
            '''
181
            def process_row(row, i):
182 316 aaronmk
                row_id = str(i)
183
                for in_, out in mappings:
184
                    value = metadata_value(in_)
185 662 aaronmk
                    if value == None:
186 857 aaronmk
                        log_start('Getting '+str(in_), debug)
187 1360 aaronmk
                        value = cleanup(get_value(in_, row))
188 1348 aaronmk
                    if value != None:
189
                        log_start('Putting '+str(out), debug)
190 1360 aaronmk
                        xpath.put_obj(root, out, row_id, has_types, value)
191 982 aaronmk
            return process_rows(process_row, rows)
192 297 aaronmk
193 1403 aaronmk
        def map_table(col_names, rows):
194 1416 aaronmk
            col_names_ct = len(col_names)
195 1403 aaronmk
            col_idxs = util.list_flip(col_names)
196
197
            i = 0
198
            while i < len(mappings): # mappings len changes in loop
199
                in_, out = mappings[i]
200
                if metadata_value(in_) == None:
201 1404 aaronmk
                    try: mappings[i] = (
202
                        get_with_prefix(col_idxs, prefixes, in_), out)
203
                    except KeyError:
204
                        del mappings[i]
205
                        continue # keep i the same
206 1403 aaronmk
                i += 1
207
208
            def get_value(in_, row):
209 1484 aaronmk
                return util.coalesce(*util.list_subset(row.list, in_))
210 1416 aaronmk
            def wrap_row(row):
211
                return util.ListDict(util.list_as_length(row, col_names_ct),
212
                    col_names, col_idxs) # handle CSV rows of different lengths
213 1403 aaronmk
214
            return map_rows(get_value, util.WrapIter(wrap_row, rows))
215
216 1700 aaronmk
        if in_is_db:
217 130 aaronmk
            assert in_is_xpaths
218 126 aaronmk
219 1136 aaronmk
            in_db = connect_db(in_db_config)
220
            in_pkeys = {}
221
            cur = sql.select(in_db, table=in_root, fields=None, conds=None,
222
                limit=end, start=0)
223 1403 aaronmk
            row_ct = map_table(list(sql.col_names(cur)), sql.rows(cur))
224 1136 aaronmk
225 117 aaronmk
            in_db.close()
226 161 aaronmk
        elif in_is_xml:
227 1714 aaronmk
            if map_path == None:
228
                for in_xml_root in xml_parse.docs_iter(sys.stdin):
229 1701 aaronmk
                    iter_ = xml_dom.NodeElemIter(in_xml_root)
230
                    util.skip(iter_, xml_dom.is_text) # skip metadata
231
                    row_ct = process_rows(lambda row, i: root.appendChild(row),
232
                        iter_)
233 1714 aaronmk
            else:
234
                def doc_rows(in_xml_root):
235 1701 aaronmk
                    rows = xpath.get(in_xml_root, in_root, limit=end)
236 1714 aaronmk
                    if rows == []: raise SystemExit('Map error: Root "'
237
                        +in_root+'" not found in input')
238
                    return rows
239
240
                def get_value(in_, row):
241
                    in_ = './{'+(','.join(strings.with_prefixes(
242
                        ['']+prefixes, in_)))+'}' # also with no prefix
243
                    nodes = xpath.get(row, in_, allow_rooted=False)
244
                    if nodes != []: return xml_dom.value(nodes[0])
245
                    else: return None
246
247
                row_ct = map_rows(get_value, iters.flatten(itertools.imap(
248
                    doc_rows, xml_parse.docs_iter(sys.stdin))))
249 56 aaronmk
        else: # input is CSV
250 133 aaronmk
            map_ = dict(mappings)
251 1389 aaronmk
            reader, col_names = csvs.reader_and_header(sys.stdin)
252 1403 aaronmk
            row_ct = map_table(col_names, reader)
253 982 aaronmk
254
        return row_ct
255 53 aaronmk
256 838 aaronmk
    def process_inputs(root, row_ready):
257 982 aaronmk
        row_ct = 0
258
        for map_path in map_paths:
259
            row_ct += process_input(root, row_ready, map_path)
260
        return row_ct
261 512 aaronmk
262 130 aaronmk
    if out_is_db:
263 53 aaronmk
        import db_xml
264
265 646 aaronmk
        out_db = connect_db(out_db_config)
266 310 aaronmk
        out_pkeys = {}
267 53 aaronmk
        try:
268 947 aaronmk
            if redo: sql.empty_db(out_db)
269 982 aaronmk
            row_ins_ct_ref = [0]
270 449 aaronmk
271 838 aaronmk
            def row_ready(row_num, input_row):
272 452 aaronmk
                def on_error(e):
273 835 aaronmk
                    exc.add_msg(e, term.emph('row #:')+' '+str(row_num))
274 828 aaronmk
                    exc.add_msg(e, term.emph('input row:')+'\n'+str(input_row))
275
                    exc.add_msg(e, term.emph('output row:')+'\n'+str(root))
276 1617 aaronmk
                    ex_tracker.track(e, row_num)
277 452 aaronmk
278 449 aaronmk
                xml_func.process(root, on_error)
279 442 aaronmk
                if not xml_dom.is_empty(root):
280
                    assert xml_dom.has_one_child(root)
281
                    try:
282 982 aaronmk
                        sql.with_savepoint(out_db,
283
                            lambda: db_xml.put(out_db, root.firstChild,
284
                                out_pkeys, row_ins_ct_ref, on_error))
285 442 aaronmk
                        if commit: out_db.commit()
286 449 aaronmk
                    except sql.DatabaseErrors, e: on_error(e)
287 1010 aaronmk
                prep_root()
288 449 aaronmk
289 982 aaronmk
            row_ct = process_inputs(root, row_ready)
290
            sys.stdout.write('Inserted '+str(row_ins_ct_ref[0])+
291 460 aaronmk
                ' new rows into database\n')
292 53 aaronmk
        finally:
293 133 aaronmk
            out_db.rollback()
294
            out_db.close()
295 751 aaronmk
    else:
296 759 aaronmk
        def on_error(e): ex_tracker.track(e)
297 838 aaronmk
        def row_ready(row_num, input_row): pass
298 982 aaronmk
        row_ct = process_inputs(root, row_ready)
299 759 aaronmk
        xml_func.process(root, on_error)
300 751 aaronmk
        if out_is_xml_ref[0]:
301
            doc.writexml(sys.stdout, **xml_dom.prettyxml_config)
302
        else: # output is CSV
303
            raise NotImplementedError('CSV output not supported yet')
304 985 aaronmk
305 982 aaronmk
    profiler.stop(row_ct)
306
    ex_tracker.add_iters(row_ct)
307 990 aaronmk
    if verbose:
308
        sys.stderr.write('Processed '+str(row_ct)+' input rows\n')
309
        sys.stderr.write(profiler.msg()+'\n')
310
        sys.stderr.write(ex_tracker.msg()+'\n')
311 985 aaronmk
    ex_tracker.exit()
312 53 aaronmk
313 847 aaronmk
def main():
314
    try: main_()
315
    except Parser.SyntaxException, e: raise SystemExit(str(e))
316
317 846 aaronmk
if __name__ == '__main__':
318 847 aaronmk
    profile_to = opts.get_env_var('profile_to', None)
319
    if profile_to != None:
320
        import cProfile
321 1584 aaronmk
        sys.stderr.write('Profiling to '+profile_to+'\n')
322 847 aaronmk
        cProfile.run(main.func_code, profile_to)
323
    else: main()