Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Fast read/write of AVRO files

Project description

# fastavro [![Build Status](https://travis-ci.org/fastavro/fastavro.svg?branch=master)](https://travis-ci.org/fastavro/fastavro) [![Documentation Status](https://readthedocs.org/projects/fastavro/badge/?version=latest)](http://fastavro.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/gh/fastavro/fastavro/branch/master/graph/badge.svg)](https://codecov.io/gh/fastavro/fastavro)

Because the Apache Python avro package is written in pure Python, it is relatively slow. In one test case, it takes about 14 seconds to iterate through a file of 10,000 records. By comparison, the JAVA avro SDK reads the same file in 1.9 seconds.

The fastavro library was written to offer performance comparable to the Java library. With regular CPython, fastavro uses C extensions which allow it to iterate the same 10,000 record file in 1.7 seconds. With PyPy, this drops to 1.5 seconds (to be fair, the JAVA benchmark is doing some extra JSON encoding/decoding).

fastavro supports the following Python versions:

  • Python 2.7
  • Python 3.4
  • Python 3.5
  • Python 3.6
  • Python 3.7
  • PyPy
  • PyPy3

## Supported Features

  • File Writer
  • File Reader (iterating via records or blocks)
  • Schemaless Writer
  • Schemaless Reader
  • Snappy and Deflate codecs
  • Schema resolution
  • Aliases
  • Logical Types

## Missing Features

  • Anything involving Avro’s RPC features
  • Parsing schemas into the canonical form
  • Schema fingerprinting

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

# Documentation

Documentation is available at http://fastavro.readthedocs.io/en/latest/

# Installing fastavro is available both on [PyPi](http://pypi.python.org/pypi)

pip install fastavro

and on [conda-forge](https://conda-forge.github.io) conda channel.

conda install -c conda-forge fastavro

# Contributing

  • Bugs and new feature requests typically start as github issues where they can be discussed. I try to resolve these as time affords, but PRs are welcome from all.
  • Get approval from discussing on the github issue before opening the pull request
  • Tests must be passing for pull request to be considered

Developer requirements can be installed with pip install -r developer_requirements.txt. If those are installed, you can run the tests with ./run-tests.sh. If you have trouble installing those dependencies, you can run docker build . to run the tests inside a docker container. This won’t test on all versions of python or on pypy, so it’s possible to still get CI failures after making a pull request, but we can work through those errors if/when they happen.

### Releasing

We release both to [pypi][pypi] and to [conda-forge][conda-forge].

We assume you have [twine][twine] installed and that you’ve created your own fork of [fastavro-feedstock][feedstock].

  • Make sure the tests pass
  • Run make tag
  • Copy the windows build artifacts for the new version from https://ci.appveyor.com/project/scottbelden/fastavro to the dist folder
  • Copy the linux build artifacts for the new version from https://github.com/fastavro/fastavro/releases/tag/ to the dist folder
  • Run make publish
  • Note the sha signature emitted at the above
  • Switch to feedstock directory and edit recipe/meta.yaml
    • Update version and sha256 variables at the top of the file
    • Run python recipe/test_recipe.py
    • Submit a [PR][pr]

[conda-forge]: https://conda-forge.org/ [feedstock]: https://github.com/conda-forge/fastavro-feedstock [pr]: https://conda-forge.org/#update_recipe [pypi]: https://pypi.python.org/pypi [twine]: https://pypi.python.org/pypi/twine

# Changes

See the [ChangeLog]

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

# Contact

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

Release history Release notifications

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
fastavro-0.21.9-cp27-cp27m-macosx_10_13_x86_64.whl (355.9 kB) Copy SHA256 hash SHA256 Wheel cp27 Oct 9, 2018
fastavro-0.21.9-cp27-cp27m-manylinux1_x86_64.whl (1.1 MB) Copy SHA256 hash SHA256 Wheel cp27 Oct 9, 2018
fastavro-0.21.9-cp27-cp27m-win_amd64.whl (287.7 kB) Copy SHA256 hash SHA256 Wheel cp27 Oct 9, 2018
fastavro-0.21.9-cp34-cp34m-macosx_10_13_x86_64.whl (350.4 kB) Copy SHA256 hash SHA256 Wheel cp34 Oct 9, 2018
fastavro-0.21.9-cp34-cp34m-manylinux1_x86_64.whl (1.2 MB) Copy SHA256 hash SHA256 Wheel cp34 Oct 9, 2018
fastavro-0.21.9-cp34-cp34m-win_amd64.whl (279.7 kB) Copy SHA256 hash SHA256 Wheel cp34 Oct 9, 2018
fastavro-0.21.9-cp35-cp35m-macosx_10_13_x86_64.whl (342.8 kB) Copy SHA256 hash SHA256 Wheel cp35 Oct 9, 2018
fastavro-0.21.9-cp35-cp35m-manylinux1_x86_64.whl (1.2 MB) Copy SHA256 hash SHA256 Wheel cp35 Oct 9, 2018
fastavro-0.21.9-cp35-cp35m-win_amd64.whl (285.6 kB) Copy SHA256 hash SHA256 Wheel cp35 Oct 9, 2018
fastavro-0.21.9-cp36-cp36m-macosx_10_13_x86_64.whl (358.2 kB) Copy SHA256 hash SHA256 Wheel cp36 Oct 9, 2018
fastavro-0.21.9-cp36-cp36m-manylinux1_x86_64.whl (1.3 MB) Copy SHA256 hash SHA256 Wheel cp36 Oct 9, 2018
fastavro-0.21.9-cp36-cp36m-win_amd64.whl (293.1 kB) Copy SHA256 hash SHA256 Wheel cp36 Oct 9, 2018
fastavro-0.21.9-cp37-cp37m-macosx_10_13_x86_64.whl (346.1 kB) Copy SHA256 hash SHA256 Wheel cp37 Oct 9, 2018
fastavro-0.21.9-cp37-cp37m-manylinux1_x86_64.whl (1.2 MB) Copy SHA256 hash SHA256 Wheel cp37 Oct 9, 2018
fastavro-0.21.9-cp37-cp37m-win_amd64.whl (293.3 kB) Copy SHA256 hash SHA256 Wheel cp37 Oct 9, 2018
fastavro-0.21.9.tar.gz (466.9 kB) Copy SHA256 hash SHA256 Source None Oct 9, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page