MurmurHash

Warnings

• breaking Be aware that `murmurhash` (from `explosion`) is a distinct package from the widely used `mmh3` library for MurmurHash3. They have different import paths (`import murmurhash.mrmr` vs `import mmh3`) and potentially different API behaviors. Installing one and attempting to use the other's API will lead to `ImportError` or unexpected hash results.
  Fix: Ensure you `pip install murmurhash` and `import murmurhash.mrmr` for this library, or `pip install mmh3` and `import mmh3` if you intend to use the `mmh3` library. Always refer to the specific library's documentation for correct API usage.
• gotcha Starting from version 1.0.7, MurmurHash2 and MurmurHash3 implementations within this library were made endian-neutral. While this ensures consistent hash values across diverse system architectures (e.g., big-endian vs. little-endian), it may produce different hash outputs compared to older `murmurhash` versions or other MurmurHash implementations that are endian-sensitive.
  Fix: If comparing hash values with systems using older versions or different MurmurHash implementations, verify their endian-neutrality. For strict compatibility with older, endian-sensitive MurmurHash outputs, manual endian handling might be necessary, or consider pinning to an older `murmurhash` version if acceptable.
• gotcha MurmurHash is a non-cryptographic hash function optimized for speed and good distribution, not for security. It should not be used for cryptographic purposes such as password hashing, digital signatures, or data integrity where collision resistance and unpredictability are critical. Always use a consistent `seed` value to ensure reproducible hash outputs, especially when relying on hashes for data partitioning, caching, or lookups across different systems or application runs.
  Fix: For security-sensitive applications, use cryptographic hash functions from Python's `hashlib` module (e.g., `hashlib.sha256`). For consistent non-cryptographic hashing, explicitly pass the `seed` argument to `murmurhash.mrmr.hash()` (or `hash64`, `hash128`) or ensure all parts of your system use the same default seed.

Install

• pip install murmurhash Install stable version

Imports

• hash

  import murmurhash.mrmr
  murmurhash.mrmr.hash('data')

  This library (explosion/murmurhash) is distinct from the popular `mmh3` package, which has a different import path and API. Ensure you are using the correct library for your needs.
• hash64

  import murmurhash.mrmr
  murmurhash.mrmr.hash64('data')

  Provides a 64-bit MurmurHash output.
• hash128

  import murmurhash.mrmr
  murmurhash.mrmr.hash128('data')

  Provides a 128-bit MurmurHash output as a tuple of two integers.

Quickstart

Demonstrates basic usage of `murmurhash.mrmr.hash`, `hash64`, and `hash128` functions with string and bytes input, and explicit seed values. Strings are UTF-8 encoded by default.

import murmurhash.mrmr

# Hash a string (UTF-8 encoded by default)
text_hash = murmurhash.mrmr.hash('hello world', seed=42)
print(f"32-bit hash for 'hello world': {text_hash}")

# Hash bytes
bytes_hash = murmurhash.mrmr.hash(b'hello world', seed=42)
print(f"32-bit hash for b'hello world': {bytes_hash}")

# Get a 64-bit hash
hash_64 = murmurhash.mrmr.hash64('another example', seed=0)
print(f"64-bit hash: {hash_64}")

# Get a 128-bit hash (returns a tuple of two integers)
hash_128 = murmurhash.mrmr.hash128('long string data', seed=12345)
print(f"128-bit hash: {hash_128}")

# Example with environment variable for seed (not typical for hash, but for auth template)
# import os
# seed_from_env = int(os.environ.get('MURMURHASH_SEED', '0'))
# env_hash = murmurhash.mrmr.hash('secure_data', seed=seed_from_env)
# print(f"Hash with env seed: {env_hash}")