Skip to main content

Fast read/write of AVRO files

Project description

fastavro
========

The current Python `avro` package is packed with features but dog slow.

On a test case of about 10K records, it takes about 14sec to iterate over all of
them. In comparison the JAVA `avro` SDK does it in about 1.9sec.

`fastavro` is less feature complete than `avro`, however it's much faster. It
iterates over the same 10K records in 2.9sec, and if you use it with PyPy it'll
do it in 1.5sec (to be fair, the JAVA benchmark is doing some extra JSON
encoding/decoding).

If the optional C extension (generated by [Cython][cython]) is available, then
`fastavro` will be even faster. For the same 10K records it'll run in about
1.7sec.

`fastavro` supports the following Python versions:

* Python 2.7
* Python 3.4
* Python 3.5b2
* pypy
* pypy3

[Cython]: http://cython.org/

Usage
=====

Reading
-------


```python

import fastavro as avro

with open('weather.avro', 'rb') as fo:
reader = avro.reader(fo)
schema = reader.schema

for record in reader:
process_record(record)

```

Writing
-------

```python
from fastavro import writer

schema = {
'doc': 'A weather reading.',
'name': 'Weather',
'namespace': 'test',
'type': 'record',
'fields': [
{'name': 'station', 'type': 'string'},
{'name': 'time', 'type': 'long'},
{'name': 'temp', 'type': 'int'},
],
}

records = [
{u'station': u'011990-99999', u'temp': 0, u'time': 1433269388},
{u'station': u'011990-99999', u'temp': 22, u'time': 1433270389},
{u'station': u'011990-99999', u'temp': -11, u'time': 1433273379},
{u'station': u'012650-99999', u'temp': 111, u'time': 1433275478},
]

with open('weather.avro', 'wb') as out:
writer(out, schema, records)

```

You can also use the `fastavro` script from the command line to dump `avro`
files.

fastavro weather.avro

By default fastavro prints one JSON object per line, you can use the `--pretty`
flag to change this.

You can also dump the avro schema

fastavro --schema weather.avro


Here's the full command line help

usage: fastavro [-h] [--schema] [--codecs] [--version] [-p] [file [file ...]]

iter over avro file, emit records as JSON

positional arguments:
file file(s) to parse

optional arguments:
-h, --help show this help message and exit
--schema dump schema instead of records
--codecs print supported codecs
--version show program's version number and exit
-p, --pretty pretty print json


Limitations
===========

* No reader schema

Hacking
=======

As recommended by Cython, the C files output is distributed. This has the
advantage that the end user does not need to have Cython installed. However it
means that every time you change `fastavro/pyfastavro.py` you need to run
`make`.

For `make` to succeed you need both python and Python 3 installed, Cython on both
of them. For `./test-install.sh` you'll need [virtualenv][venv].

[venv]: http://pypi.python.org/pypi/virtualenv

Builds
======

We're currently using [travis.ci](http://travis-ci.org/#!/tebeka/fastavro)

[![Build Status](https://travis-ci.org/tebeka/fastavro.svg?branch=master)](https://travis-ci.org/tebeka/fastavro)


Changes
=======

See the [ChangeLog]

[ChangeLog]: https://github.com/tebeka/fastavro/blob/master/ChangeLog

Contact
=======

[Project Home](https://github.com/tebeka/fastavro)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastavro-0.9.6.tar.gz (279.7 kB view details)

Uploaded Source

Built Distributions

fastavro-0.9.6-py3.5-linux-x86_64.egg (714.5 kB view details)

Uploaded Source

fastavro-0.9.6-py2.7-linux-x86_64.egg (233.4 kB view details)

Uploaded Source

File details

Details for the file fastavro-0.9.6.tar.gz.

File metadata

  • Download URL: fastavro-0.9.6.tar.gz
  • Upload date:
  • Size: 279.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for fastavro-0.9.6.tar.gz
Algorithm Hash digest
SHA256 3ccec559764a4fe58b9e88b449e96c482bb6e754f72a309f482558b19154437c
MD5 3f0489165f41b43f91723d2e808f2509
BLAKE2b-256 2305ea7b4b73fe5d47902699ea31ab4469d2c0dcdd4c80a9f4ea9b09f6edd0de

See more details on using hashes here.

File details

Details for the file fastavro-0.9.6-py3.5-linux-x86_64.egg.

File metadata

File hashes

Hashes for fastavro-0.9.6-py3.5-linux-x86_64.egg
Algorithm Hash digest
SHA256 b1ccf5fc5ca20fc55e07b3037f704970a133fe058f468ab01b003f3760b0b4cd
MD5 2198748eaf5f7cb6773ef3964578bf80
BLAKE2b-256 33c1ff8140659abf9576b6dbb0dbab4624be709d2a7b98abe2e121f693cce57a

See more details on using hashes here.

File details

Details for the file fastavro-0.9.6-py2.7-linux-x86_64.egg.

File metadata

File hashes

Hashes for fastavro-0.9.6-py2.7-linux-x86_64.egg
Algorithm Hash digest
SHA256 47521c9f85e743cf02776bf78b91eb4b0307d245c938d7fa1537cede137c3b38
MD5 dba8bb4064a0dd5756b4c5b4534ccaad
BLAKE2b-256 2f35dcc84b65082c0a0d6734354c37a40b3f38baeac5a22f27158d33559d4ddb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page