File: avro

package info (click to toggle)
python-avro 1.10.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,624 kB
  • sloc: python: 11,437; xml: 4,061; sh: 752; java: 386; makefile: 21
file content (300 lines) | stat: -rwxr-xr-x 8,429 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
#!/usr/bin/env python

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Command line utility for reading and writing Avro files."""

from __future__ import absolute_import, division, print_function

import csv
import itertools
import json
import os.path
import sys
from functools import partial
from optparse import OptionGroup, OptionParser

import avro
import avro.schema
from avro.datafile import DataFileReader, DataFileWriter
from avro.io import DatumReader, DatumWriter

_AVRO_DIR = os.path.abspath(os.path.dirname(avro.__file__))

ifilter = getattr(itertools, 'ifilter', filter)
imap = getattr(itertools, 'imap', map)

try:
    unicode
except NameError:
    unicode = str

try:
    long
except NameError:
    long = int


def _version():
    with open(os.path.join(_AVRO_DIR, 'VERSION.txt')) as v:
        return v.read()


_AVRO_VERSION = _version()


class AvroError(Exception):
    pass


def print_json(row):
    print(json.dumps(row))


def print_json_pretty(row):
    """Pretty print JSON"""
    # Need to work around https://bugs.python.org/issue16333
    # where json.dumps leaves trailing spaces.
    result = json.dumps(row, sort_keys=True, indent=4).replace(' \n', '\n')
    print(result)


_write_row = csv.writer(sys.stdout).writerow


def print_csv(row):
    # We sort the keys to the fields will be in the same place
    # FIXME: Do we want to do it in schema order?
    _write_row([row[key] for key in sorted(row)])


def select_printer(format):
    return {
        "json": print_json,
        "json-pretty": print_json_pretty,
        "csv": print_csv
    }[format]


def record_match(expr, record):
    return eval(expr, None, {"r": record})


def parse_fields(fields):
    fields = fields or ''
    if not fields.strip():
        return None

    return [field.strip() for field in fields.split(',') if field.strip()]


def field_selector(fields):
    fields = set(fields)

    def keys_filter(obj):
        return dict((k, obj[k]) for k in (set(obj) & fields))
    return keys_filter


def print_avro(avro, opts):
    if opts.header and (opts.format != "csv"):
        raise AvroError("--header applies only to CSV format")

    # Apply filter first
    if opts.filter:
        avro = ifilter(partial(record_match, opts.filter), avro)

    for i in range(opts.skip):
        try:
            next(avro)
        except StopIteration:
            return

    fields = parse_fields(opts.fields)
    if fields:
        avro = imap(field_selector(fields), avro)

    printer = select_printer(opts.format)
    for i, record in enumerate(avro):
        if i == 0 and opts.header:
            _write_row(sorted(record.keys()))
        if i >= opts.count:
            break
        printer(record)


def print_schema(avro):
    schema = avro.schema
    # Pretty print
    print(json.dumps(json.loads(schema), indent=4))


def cat(opts, args):
    if not args:
        raise AvroError("No files to show")
    for filename in args:
        with DataFileReader(open(filename, 'rb'), DatumReader()) as avro:
            if opts.print_schema:
                print_schema(avro)
                continue
            print_avro(avro, opts)


def _open(filename, mode):
    if filename == "-":
        return {
            "rb": sys.stdin,
            "wb": sys.stdout
        }[mode]

    return open(filename, mode)


def iter_json(info, _):
    for i in info:
        try:
            s = i.decode()
        except AttributeError:
            s = i
        yield json.loads(s)


def convert(value, field):
    type = field.type.type
    if type == "union":
        return convert_union(value, field)

    return  {
        "int": int,
        "long": long,
        "float": float,
        "double": float,
        "string": unicode,
        "bytes": bytes,
        "boolean": bool,
        "null": lambda _: None,
        "union": lambda v: convert_union(v, field),
    }[type](value)


def convert_union(value, field):
    for name in [s.name for s in field.type.schemas]:
        try:
            return convert(name)(value)
        except ValueError:
            continue


def iter_csv(info, schema):
    header = [field.name for field in schema.fields]
    for row in csv.reader((getattr(i, "decode", lambda: i)() for i in info)):
        values = [convert(v, f) for v, f in zip(row, schema.fields)]
        yield dict(zip(header, values))


def guess_input_type(files):
    if not files:
        return None

    ext = os.path.splitext(files[0])[1].lower()
    if ext in (".json", ".js"):
        return "json"
    elif ext in (".csv",):
        return "csv"

    return None


def write(opts, files):
    if not opts.schema:
        raise AvroError("No schema specified")

    input_type = opts.input_type or guess_input_type(files)
    if not input_type:
        raise AvroError("Can't guess input file type (not .json or .csv)")
    iter_records = {"json": iter_json, "csv": iter_csv}[input_type]

    try:
        with open(opts.schema) as schema_file:
            schema = avro.schema.parse(schema_file.read())
        out = _open(opts.output, "wb")
    except (IOError, OSError) as e:
        raise AvroError("Can't open file - %s" % e)

    writer = DataFileWriter(getattr(out, 'buffer', out), DatumWriter(), schema)

    for filename in (files or ["-"]):
        info = _open(filename, "rb")
        for record in iter_records(info, schema):
            writer.append(record)

    writer.close()


def main(argv=None):
    argv = argv or sys.argv

    parser = OptionParser(description="Display/write for Avro files",
                          version=_AVRO_VERSION,
                          usage="usage: %prog cat|write [options] FILE [FILE...]")
    # cat options

    cat_options = OptionGroup(parser, "cat options")
    cat_options.add_option("-n", "--count", default=float("Infinity"),
                           help="number of records to print", type=int)
    cat_options.add_option("-s", "--skip", help="number of records to skip",
                           type=int, default=0)
    cat_options.add_option("-f", "--format", help="record format",
                           default="json",
                           choices=["json", "csv", "json-pretty"])
    cat_options.add_option("--header", help="print CSV header", default=False,
                           action="store_true")
    cat_options.add_option("--filter", help="filter records (e.g. r['age']>1)",
                           default=None)
    cat_options.add_option("--print-schema", help="print schema",
                           action="store_true", default=False)
    cat_options.add_option('--fields', default=None,
                           help='fields to show, comma separated (show all by default)')
    parser.add_option_group(cat_options)

    # write options
    write_options = OptionGroup(parser, "write options")
    write_options.add_option("--schema", help="schema file (required)")
    write_options.add_option("--input-type",
                             help="input file(s) type (json or csv)",
                             choices=["json", "csv"], default=None)
    write_options.add_option("-o", "--output", help="output file", default="-")
    parser.add_option_group(write_options)

    opts, args = parser.parse_args(argv[1:])
    if len(args) < 1:
        parser.error("You much specify `cat` or `write`")  # Will exit

    command = args.pop(0)
    try:
        if command == "cat":
            cat(opts, args)
        elif command == "write":
            write(opts, args)
        else:
            raise AvroError("Unknown command - %s" % command)
    except AvroError as e:
        parser.error("%s" % e)  # Will exit


if __name__ == "__main__":
    main()