Skip to content

Commit eb04bbe

Browse files
committed
XXH3 docs
1 parent b6da104 commit eb04bbe

2 files changed

Lines changed: 22 additions & 3 deletions

File tree

README.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ the module properties ``VERSION`` AND ``XXHASH_VERSION`` respectively.
8181
8282
>>> import xxhash
8383
>>> xxhash.VERSION
84-
'1.4.4'
84+
'2.0.0'
8585
>>> xxhash.XXHASH_VERSION
86-
'0.7.3'
86+
'0.8.0'
8787
8888
This module is hashlib-compliant, which means you can use it in the same way as ``hashlib.md5``.
8989

@@ -221,6 +221,25 @@ so we can avoid allocating XXH32/64 state on heap:
221221
In [3]: %timeit xxhash.xxh64('xxhash').hexdigest()
222222
416 ns ± 17.3 ns per loop (mean ± std. dev. of 7 runs, 1000000 loops each)
223223
224+
225+
XXH3 hashes are available since v2.0.0 (xxHash v0.8.0), they are:
226+
227+
Streaming classes:
228+
229+
| xxh3_64
230+
| xxh3_128
231+
232+
Oneshot functions:
233+
234+
| xxh3_64_digest(bytes, seed=0)
235+
| xxh3_64_intdigest(bytes, seed=0)
236+
| xxh3_64_hexdigest(bytes, seed=0)
237+
| xxh3_128_digest(bytes, seed=0)
238+
| xxh3_128_intdigest(bytes, seed=0)
239+
| xxh3_128_hexdigest(bytes, seed=0)
240+
241+
242+
224243
Caveats
225244
-------
226245

xxhash/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
XXHASH_VERSION,
1919
)
2020

21-
VERSION = "1.5.0.dev1"
21+
VERSION = "2.0.0.dev1"
2222

2323
__all__ = [
2424
"xxh32",

0 commit comments

Comments
 (0)