Python bindings for the Rust blake3 crate

Project description

blake3-py

Python bindings for the official Rust implementation of BLAKE3, based on PyO3. These bindings expose all the features of BLAKE3, including extendable output, keying, and multithreading. The basic API matches that of Python's standard hashlib module.

Examples

from blake3 import blake3

# Hash some input all at once. The input can be bytes, a bytearray, or a memoryview.
hash1 = blake3(b"foobarbaz").digest()

# Hash the same input incrementally.
hasher = blake3()
hasher.update(b"foo")
hasher.update(b"bar")
hasher.update(b"baz")
hash2 = hasher.digest()
assert hash1 == hash2

# Hexadecimal output.
print("The hash of 'hello world' is", blake3(b"hello world").hexdigest())

# Use the keyed hashing mode, which takes a 32-byte key.
import secrets
random_key = secrets.token_bytes(32)
message = b"a message to authenticate"
mac = blake3(message, key=random_key).digest()

# Use the key derivation mode, which takes a context string. Context strings
# should be hardcoded, globally unique, and application-specific.
context = "blake3-py 2020-03-04 11:13:10 example context"
key_material = b"usually at least 32 random bytes, not a password"
derived_key = blake3(key_material, derive_key_context=context).digest()

# Extendable output. The default digest size is 32 bytes.
extended = blake3(b"foo").digest(length=100)
assert extended[:32] == blake3(b"foo").digest()
assert extended[75:100] == blake3(b"foo").digest(length=25, seek=75)

# Hash a large input using multiple threads. Note that this can be slower for
# inputs shorter than ~1 MB, and it's a good idea to benchmark it for your use
# case on your platform.
large_input = bytearray(1_000_000)
hash_single = blake3(large_input).digest()
hash_two = blake3(large_input, max_threads=2).digest()
hash_many = blake3(large_input, max_threads=blake3.AUTO).digest()
assert hash_single == hash_two == hash_many

# Copy a hasher that has already accepted some input.
hasher1 = blake3(b"foo")
hasher2 = hasher1.copy()
hasher1.update(b"bar")
hasher2.update(b"baz")
assert hasher1.digest() == blake3(b"foobar").digest()
assert hasher2.digest() == blake3(b"foobaz").digest()

Installation

pip install blake3

As usual with Pip, you might need to use sudo or the --user flag with the command above, depending on how you installed Python on your system.

There are binary wheels available on PyPI for most environments. But if you're building the source distribution, or if a binary wheel isn't available for your environment, you'll need to install the Rust toolchain.

Thread Safety and the GIL

Like the hashlib functions in the Python standard library, we release the GIL while hashing, to avoid blocking other threads for a potentially long time. However, this allows race conditions: it's possible for other threads to access a hasher or an input buffer while hashing is going on. This is worse than an ordinary Python race condition. It's undefined behavior in the C/C++/Rust sense. But this seems to be the standard way to do hashing in Python. In any case, it should be rare for real world programs to share a hasher between threads. For more details about this issue, see the comments on usafe code in lib.rs.

C Bindings

Experimental bindings for the official BLAKE3 C implementation are available in the c_impl directory. These will probably not be published on PyPI, and most applications should prefer the Rust-based bindings. But if you can't depend on the Rust toolchain, and you're on some platform that this project doesn't provide binary wheels for, the C-based bindings might be an alternative.

Project details

Release history Release notifications | RSS feed

0.4.1

Feb 4, 2024

0.4.0

Feb 1, 2024

0.3.4

Dec 12, 2023

0.3.3

Dec 20, 2022

0.3.2

Dec 17, 2022

0.3.1

Jan 13, 2022

This version

0.3.0

Jan 11, 2022

0.2.1

Oct 22, 2021

0.2.0

Jul 18, 2021

0.1.8

Nov 5, 2020

0.1.7

Sep 12, 2020

0.1.6

Jul 30, 2020

0.1.5

Apr 30, 2020

0.1.4

Mar 30, 2020

0.1.3

Mar 4, 2020

0.1.2

Mar 3, 2020

0.1.1

Mar 3, 2020

0.1.0

Feb 29, 2020

Download files

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

Source Distribution

blake3-0.3.0.tar.gz (130.2 kB view details)

Uploaded Jan 11, 2022 Source

Built Distributions

blake3-0.3.0-cp310-none-win_amd64.whl (191.4 kB view details)

Uploaded Jan 11, 2022 CPython 3.10 Windows x86-64

blake3-0.3.0-cp310-none-win32.whl (208.2 kB view details)

Uploaded Jan 11, 2022 CPython 3.10 Windows x86

blake3-0.3.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Jan 11, 2022 CPython 3.10 manylinux: glibc 2.5+ x86-64

blake3-0.3.0-cp310-cp310-macosx_11_0_arm64.whl (293.5 kB view details)

Uploaded Jan 11, 2022 CPython 3.10 macOS 11.0+ ARM64

blake3-0.3.0-cp310-cp310-macosx_10_7_x86_64.whl (315.3 kB view details)

Uploaded Jan 11, 2022 CPython 3.10 macOS 10.7+ x86-64

blake3-0.3.0-cp39-none-win_amd64.whl (191.7 kB view details)

Uploaded Jan 11, 2022 CPython 3.9 Windows x86-64

blake3-0.3.0-cp39-none-win32.whl (208.4 kB view details)

Uploaded Jan 11, 2022 CPython 3.9 Windows x86

blake3-0.3.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Jan 11, 2022 CPython 3.9 manylinux: glibc 2.5+ x86-64

blake3-0.3.0-cp39-cp39-macosx_11_0_arm64.whl (293.6 kB view details)

Uploaded Jan 11, 2022 CPython 3.9 macOS 11.0+ ARM64

blake3-0.3.0-cp39-cp39-macosx_10_7_x86_64.whl (315.4 kB view details)

Uploaded Jan 11, 2022 CPython 3.9 macOS 10.7+ x86-64

blake3-0.3.0-cp38-none-win_amd64.whl (191.9 kB view details)

Uploaded Jan 11, 2022 CPython 3.8 Windows x86-64

blake3-0.3.0-cp38-none-win32.whl (208.7 kB view details)

Uploaded Jan 11, 2022 CPython 3.8 Windows x86

blake3-0.3.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Jan 11, 2022 CPython 3.8 manylinux: glibc 2.5+ x86-64

blake3-0.3.0-cp38-cp38-macosx_11_0_arm64.whl (294.0 kB view details)

Uploaded Jan 11, 2022 CPython 3.8 macOS 11.0+ ARM64

blake3-0.3.0-cp38-cp38-macosx_10_7_x86_64.whl (315.5 kB view details)

Uploaded Jan 11, 2022 CPython 3.8 macOS 10.7+ x86-64

blake3-0.3.0-cp37-none-win_amd64.whl (191.8 kB view details)

Uploaded Jan 11, 2022 CPython 3.7 Windows x86-64

blake3-0.3.0-cp37-none-win32.whl (208.1 kB view details)

Uploaded Jan 11, 2022 CPython 3.7 Windows x86

blake3-0.3.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Jan 11, 2022 CPython 3.7m manylinux: glibc 2.5+ x86-64

blake3-0.3.0-cp37-cp37m-macosx_10_7_x86_64.whl (315.5 kB view details)

Uploaded Jan 11, 2022 CPython 3.7m macOS 10.7+ x86-64

blake3-0.3.0-cp36-none-win_amd64.whl (190.6 kB view details)

Uploaded Jan 11, 2022 CPython 3.6 Windows x86-64

blake3-0.3.0-cp36-none-win32.whl (206.7 kB view details)

Uploaded Jan 11, 2022 CPython 3.6 Windows x86

blake3-0.3.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.whl (1.1 MB view details)

Uploaded Jan 11, 2022 CPython 3.6m manylinux: glibc 2.5+ x86-64

blake3-0.3.0-cp36-cp36m-macosx_10_7_x86_64.whl (312.7 kB view details)

Uploaded Jan 11, 2022 CPython 3.6m macOS 10.7+ x86-64

File details

Details for the file blake3-0.3.0.tar.gz.

File metadata

Download URL: blake3-0.3.0.tar.gz
Upload date: Jan 11, 2022
Size: 130.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for blake3-0.3.0.tar.gz
Algorithm	Hash digest
SHA256	`ed64e35778208c6d2ad7d6066450c5c649ea6632b8994a771889fd59594fa2f8`
MD5	`deffd648cd96a26492612681cc23df45`
BLAKE2b-256	`4a0334445777a4b1e9d8c67aafb6f567e3115697fc4347fac00fc2f2a61dd0a9`

Algorithm	Hash digest
SHA256	`5a8998b25aeb02251a993b600846d81d72ebce46b1765c46fc19441216b0dc64`
MD5	`31b4c5014542964a603c08f702d37d33`
BLAKE2b-256	`0026b01924ae2edfb56bdcd790fb48e4245b09f333545f164a4e0a236f8f3867`

Algorithm	Hash digest
SHA256	`d6d082cc650f22241eabaa3b2c81c896ba35fc11e0b5f7e8be497bd8a0336115`
MD5	`d978e24748e897d6eeab424160f0532c`
BLAKE2b-256	`c5ab2cfe395d61de7795c4f0ad2a3c9c8e944132c05716b302fa9a1a567a96c9`

Algorithm	Hash digest
SHA256	`cf23225bddc5560ab7aa6a5142c6f7b8a6d63fae587893a984e26cfe8ee5f585`
MD5	`40fdac8d203e77aa45a3fdc55e2a51ed`
BLAKE2b-256	`49ee61899ec1e0ae507b68c2a4aa711160ea41f498a901bac3e3a0491aaf045f`

Algorithm	Hash digest
SHA256	`dcd21e88d724506ed05788a8f4adc56142e4bc6331dc895514fdd611955354d9`
MD5	`54ed89e003130b9eb89e4095f5633a17`
BLAKE2b-256	`168430cd5e833b505f579c781555413cd2010db11e94b1bc37a56adbb364fc9f`

Algorithm	Hash digest
SHA256	`036a99adf6935dd9d1931085f71d6e1e548bbdd12da41432ad87d9fb6a75989d`
MD5	`c1cd628caf3f7704409acc0241f6e759`
BLAKE2b-256	`13861b304a76794290793fa4fbdb85ca12380b9180ea055ac43f274936c5bfd9`

Algorithm	Hash digest
SHA256	`d886ee57659404476f74dcbd9bbf5ba74dd8c74939e3e906a1f1ca678c2cc112`
MD5	`86affbf788eee712972bebe8697a54ec`
BLAKE2b-256	`b15484cff87434be5edd90b06f904a2e2453c3d06d662d51bfe994eb26cc1fb7`

Algorithm	Hash digest
SHA256	`eeb617771d0d06c4a104b6e5d1319ca9b44e93fd26f490c175c8f4654e3045eb`
MD5	`9b8fa5632b1b4dadef318d15926bd07c`
BLAKE2b-256	`22ea6f8422230a7589c13e6be6c7451b180bcf6353ae5fad4f295c51a2804139`

Algorithm	Hash digest
SHA256	`63a181dba9247c76b173cbdc99949059f3a02c7ff0e458d3452d052357054360`
MD5	`7faef344940495ce5fb0fb15185114e2`
BLAKE2b-256	`9f3bbed3765877d7ffd1c5bbdee15fa497870ef7d3c4f080c8d505644b081891`

Algorithm	Hash digest
SHA256	`3b9b3d17d6f5ae82adfb9c7a90bf18b3055be86aded7bf37bf722a734afd2fa6`
MD5	`5864deec08a960a9a50988d41d61f261`
BLAKE2b-256	`ed61d08f15ea7fbc47fb5e80380f90d5e0a4d579f4ee61a86364ad8cc2092171`

Algorithm	Hash digest
SHA256	`7de2dcb79cbded4e066e4152a9c4774ca5c729570f346e62eed1f207531ad935`
MD5	`991beb04d61b4ef345413411f165afce`
BLAKE2b-256	`c2a8c771ee8df554c5676b1eb336ef39220e5eecfaef08c28e494898f23cdd5a`

Algorithm	Hash digest
SHA256	`2d05bd525dd69dfffb082a9b55deec03e71c99594773d73cc857ec5e7c7180e9`
MD5	`ef2d25f5e45786badd202e328f2fe71d`
BLAKE2b-256	`2aab381ef2a3d213693c1b2078bbbab9d1ab0e21970d084ceaa13866626d1e5b`

Algorithm	Hash digest
SHA256	`8b4b0cac5ff999128bad0e81c3656171e3126b59246afe3d8c7f1306c73612f1`
MD5	`286ba94e663af73d605aba1143b9610f`
BLAKE2b-256	`65567e0eb63769f4af3d6e35eb40d7e6ec31d7d8c959e4be25477e6f70950a59`

Algorithm	Hash digest
SHA256	`1437511be5c63bd51ee6367c4175018d9b5af25675aa04e4932c5b749b32fa91`
MD5	`db13a5d8552a43d26eca89e9e169b751`
BLAKE2b-256	`75ced4330c185a9f6c04d765302ae407a2340777ba7a187478e83c32927bf8ff`

Algorithm	Hash digest
SHA256	`8cd74632b2c21c7511ecbb011de579c1d05c22633724654cb742b8a754af9b0b`
MD5	`df251a37f8f22e4d990583f526dacf9a`
BLAKE2b-256	`4cd4f72ee85b9702add26c960cfa0b7cf53cee5c0b2739fa3c4638d8bffa01ca`

Algorithm	Hash digest
SHA256	`aab6bd8b47be60efbccdec906bf4fe91593e0058309834649f86311c0a0039bf`
MD5	`d3a867dc801d5d7b4b6455a3ccc49079`
BLAKE2b-256	`6b7b111399d5641c4c8088f62c2bdd4acade9cbfb985e70557545628dab8be5f`

Algorithm	Hash digest
SHA256	`28ebba2efc3d9671166ecfbffb3c04d6a634a3d866fb3012970ad5092334a1d3`
MD5	`168962d4b0d9885474fef32a07eff84c`
BLAKE2b-256	`1a454273d78901a2c18bc72ed736480b1e5f089cd834f35204b2a5d61da068c8`

Algorithm	Hash digest
SHA256	`061ad34772e61396a4c88cf04b4a29f4036fe6e02b983c89f1474771c6f06866`
MD5	`39b9aff077c46008ceb7ef44f54c11bb`
BLAKE2b-256	`64bc706487ed4db5d845b166211c8f9c9ef8f0948d769c76cca4c9e15a64ee5a`

Algorithm	Hash digest
SHA256	`f2182ecda1f45449f1f31b85e22aecc62bde5d4baa8fc009cd92d65c1b92c099`
MD5	`39edfe8d7c8e59da7253f723ad8dc27c`
BLAKE2b-256	`24eb646b352bfee5fa3f86a6ab03fa2abce0757d211df312814ed176e8ec78fc`

Algorithm	Hash digest
SHA256	`b9bb9ab823a90a61ea836f0fab500941a3e259f3de0867614a0df04df21e2a83`
MD5	`7b96e089015cff97ade17a71c789d312`
BLAKE2b-256	`0293a2470800fd24478b526a59e7cd184b1035ee27aaddc0d6fb660148227ed8`

Algorithm	Hash digest
SHA256	`4ef884b36eb500c11e00745584256ae486fae4bdc58b0a52c5eb4a04e8f71c0e`
MD5	`4760cb299d68e1ca445b8d404854bbd6`
BLAKE2b-256	`a55d1ec5f1bad763ee3d13ff55f1b4cfa2d684c7a0d9c78ad95066123949dea0`

blake3 0.3.0

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Project description

blake3-py

Examples

Installation

Thread Safety and the GIL

C Bindings

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

Algorithm	Hash digest
SHA256	`09eaea7f995adf135f784bf698cce19b8346de4db870174a36856680ad55bbef`
MD5	`dabbd1b736adda01a529389da01d2a72`
BLAKE2b-256	`d1b060b08dce9fa8a02154ac069c5e0018348f5bb794f91e6777859dfd5cc125`

Algorithm	Hash digest
SHA256	`745a52293f3c8107d27c4f04b96893b5e529fd49c06042971625e2656e084fc7`
MD5	`28c17357fc3cbae57dac3188c9b1da43`
BLAKE2b-256	`5ca68f5bfa1f8d55fe602b95d7a397c89e5b21a8d62c48ff22b573533d85773b`

Algorithm	Hash digest
SHA256	`ab576e8afadf526b0e86c8e6451a2aa65be8d71f5c111dcf52cc7a2a94947afe`
MD5	`670c40227ec251cd8e44c2fcd730f7a8`
BLAKE2b-256	`509bdcd7d716f167816af0b97dd18521f1dc291e2b3ea66f7ddaffc83a43e8b5`