Skip to main content

Python bindings for MetroHash, a fast non-cryptographic hash algorithm

Project description

A Python wrapper around MetroHash

Latest Version Downloads Tests Status

Getting Started

To use this package in your program, simply type

pip install metrohash

After that, you should be able to import the module and do things with it (see Example Usage below).

Example Usage

This package provides Python interfaces to 64- and 128-bit implementations of MetroHash algorithm. For stateless hashing, it exports metrohash64 and metrohash128 functions. Both take a value to be hashed (either string or unicode) and an optional seed parameter:

>>> import metrohash
>>> metrohash.metrohash64("abc", seed=0)
>>> metrohash.metrohash128("abc")

For incremental hashing, use MetroHash64 and MetroHash128 classes. Incremental hashing is associative and guarantees that any combination of input slices will result in the same final hash value. This is useful for processing large inputs and stream data. Example with two slices:

>>> mh = metrohash.MetroHash64()
>>> mh.update("Nobody inspects")
>>> mh.update(" the spammish repetition")
>>> mh.intdigest()

Note that the resulting hash value above is the same as in:

>>> mh = metrohash.MetroHash64()
>>> mh.update("Nobody inspects the spammish repetition")
>>> mh.intdigest()


For those who want to contribute, here is a quick start using some makefile commands:

git clone
cd python-metrohash
make env           # creates a Python virtualenv
make test          # run Python tests
make cpp-test      # run C++ tests

The Makefiles provided have self-documenting targets. To find out which targets are available, type:

make help

See Also

For other fast non-cryptographic hashing implementations available as Python extensions, see CityHash and xxh.


The original MetroHash algorithm was designed by J. Andrew Rogers. The Python bindings in this package were written by Eugene Scherba.


This software is licensed under the MIT License. See the included LICENSE file for more information.

Project details

Download files

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

Source Distribution

metrohash-0.1.0.tar.gz (61.0 kB view hashes)

Uploaded Source

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