Add buffer argument to hasher constructors (#83)

Author: hajimes

CHANGELOG.md

@@ -25,12 +25,15 @@ This project has adhered to
 - Change the format of CHANGELOG.md to conform to the
   [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) standard
   ([#63](https://github.com/hajimes/mmh3/issues/63)).
+- **Backward-incompatible**: Change the constructors of hasher classes to
+  accept a buffer as the first argument.
 
 ### Fixed
 
 - Fix a reference leak in the `hash_from_buffer()` function
   ([#75](https://github.com/hajimes/mmh3/issues/75)).
-- Fix type hints.
+- Fix type hints ([#76](https://github.com/hajimes/mmh3/issues/76),
+  [#77](https://github.com/hajimes/mmh3/issues/77)).
 
 ## [4.1.0] - 2024-01-09
 

README.md

@@ -150,12 +150,15 @@ complete changelog.
 - Change the format of CHANGELOG.md to conform to the
   [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) standard
   ([#63](https://github.com/hajimes/mmh3/issues/63)).
+- **Backward-incompatible**: Change the constructors of hasher classes to
+  accept a buffer as the first argument.
 
 #### Fixed
 
 - Fix a reference leak in the `hash_from_buffer()` function
   ([#75](https://github.com/hajimes/mmh3/issues/75)).
-- Fix type hints.
+- Fix type hints ([#76](https://github.com/hajimes/mmh3/issues/76),
+  [#77](https://github.com/hajimes/mmh3/issues/77)).
 
 ### [4.1.0] - 2024-01-09
 
@@ -166,20 +169,11 @@ complete changelog.
 #### Fixed
 
 - Fix issues with Bazel by changing the directory structure of the project
-  (<https://github.com/hajimes/mmh3/issues/50>).
-- Fix incorrect type hints (<https://github.com/hajimes/mmh3/issues/51>).
+  ([#50](https://github.com/hajimes/mmh3/issues/50)).
+- Fix incorrect type hints ([#51](https://github.com/hajimes/mmh3/issues/51)).
 - Fix invalid results on s390x when the arg `x64arch` of `hash64` or
-  `hash_bytes` is set to `False` (<https://github.com/hajimes/mmh3/issues/52>).
-
-### [4.0.1] - 2023-07-14
-
-#### Changed
-
-- Refactor the project structure (<https://github.com/hajimes/mmh3/issues/48>).
-
-#### Fixed
-
-- Fix incorrect type hints.
+  `hash_bytes` is set to `False`
+  ([#52](https://github.com/hajimes/mmh3/issues/52)).
 
 ## License
 
@@ -300,4 +294,3 @@ is useful for OSINT and cybersecurity activities.
 
 [unreleased]: https://github.com/hajimes/mmh3/compare/v4.1.0...HEAD
 [4.1.0]: https://github.com/hajimes/mmh3/compare/v4.0.1...v4.1.0
-[4.0.1]: https://github.com/hajimes/mmh3/compare/v4.0.0...v4.0.1

docs/CONTRIBUTING.md

@@ -20,7 +20,7 @@ to see if the problem has already been noted.
 
 ## Project structure
 
-As of version 4.2.0, the project layout is structured as follows:
+As of version 5.0.0-dev, the project layout is structured as follows:
 
 - `src/mmh3`
   - `mmh3module.c`: the main file that serves as the interface between Python
@@ -102,6 +102,14 @@ by Python.
 by Simon Willison is a good introduction to Docker/QEMU settings for emulating
 s390x.
 
+If the above does not work, you may also want to try the following:
+
+```shell
+docker run --rm --privileged tonistiigi/binfmt --install all
+docker buildx create --name mybuilder --use
+docker run -it multiarch/ubuntu-core:s390x-focal /bin/bash
+```
+
 ## Pull request
 
 Once you've pushed your changes to your fork, you can
@@ -160,7 +168,7 @@ For example,
 pip install ".[benchmark]"
 mkdir results
 python benchmark/benchmark.py -o results/mmh3_128.json \
-            --test-hash mmh3_128 --test-buffer-size-max 134217728
+            --test-hash mmh3_128 --test-buffer-size-max 262144
 ```
 
 As of version 4.2.0, the following hash function identifiers are available for

docs/api.md

@@ -1,8 +1,8 @@
 # API Reference
 
 ```{caution}
-  This reference contains functions that are not yet released in the stable
-  version.
+  This reference contains functions and APIs that are not yet released in the
+  stable version (4.1.0).
 ```
 
 ## Functions for immutables

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mmh3"
-version = "4.2.0-alpha.4"
+version = "5.0.0-dev.1"
 description = "Python extension for MurmurHash (MurmurHash3), a set of fast and robust hash functions."
 readme = "README.md"
 license = {file = "LICENSE"}

src/mmh3/__init__.pyi

@@ -45,7 +45,7 @@ def mmh3_x86_128_utupledigest(
 ) -> tuple[int, int]: ...
 
 class Hasher:
-    def __init__(self, seed: int = 0) -> None: ...
+    def __init__(self, data: Union[Buffer, None] = None, seed: int = 0) -> None: ...
     def update(self, data: Buffer) -> None: ...
     def digest(self) -> bytes: ...
     def sintdigest(self) -> int: ...