# stablehash
The `stablehash` module provides a "pure" hash function that is stable across Python processes and runs. This is in
contrast to the builtin `hash()` function, which may return a different value for the same input in separate
invokations even with the Python version.
We support most Python built-in types, including mutable types such as `list` and `dict`, as well as dataclasses. The
default internal hash algorithm is Blake2b, but this can be changed by passing a different `hashlib` algorithm to the
`stablehash` function.
## Usage
```python
from stablehash import stablehash
assert stablehash({"key": "value"}, algorithm="md5").hexdigest() == 'd5994850379366e314563ea555532052'
```
## API
### `stablehash(obj=..., *, algorithm="blake2b")`
Returns a `hashlib`-compatible object with the given algorithm and the hash of the given object. The algorithm must be
one of the algorithms supported by `hashlib`.
### `stablehash.update(obj)`
Updates the hash with the given object. If the object is not supported, a `TypeError` is raised.
### `stablehash.digest()`
Returns the digest of the hash as a bytes object.
### `stablehash.hexdigest()`
Returns the digest of the hash as a string object.
## Supported types
The following types are supported:
- `None`
- `bool`
- `int`
- `float`
- `str`
- `bytes`
- `tuple`
- `list`
- `set`
- `frozenset`
- `dict`
- `@dataclass` objects
- `datetime` objects (`datetime`, `date`, `time` and `timedelta`)
- `uuid.UUID`
- Picklable objects (e.g. those that implement `__getstate__()`)
- `type` objects (by their full qualified name)
Raw data
{
"_id": null,
"home_page": null,
"name": "stablehash",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "dataclasses, hash, hashlib, python hashing, stable hash",
"author": null,
"author_email": "Niklas Rosenstein <rosensteinniklas@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0a/9f/114d42a5d67387aea869f853e72e04479b85809ab5483b6f1e34e82caeb6/stablehash-0.2.1.tar.gz",
"platform": null,
"description": "# stablehash\n\nThe `stablehash` module provides a \"pure\" hash function that is stable across Python processes and runs. This is in\ncontrast to the builtin `hash()` function, which may return a different value for the same input in separate\ninvokations even with the Python version.\n\nWe support most Python built-in types, including mutable types such as `list` and `dict`, as well as dataclasses. The\ndefault internal hash algorithm is Blake2b, but this can be changed by passing a different `hashlib` algorithm to the\n`stablehash` function.\n\n## Usage\n\n```python\nfrom stablehash import stablehash\n\nassert stablehash({\"key\": \"value\"}, algorithm=\"md5\").hexdigest() == 'd5994850379366e314563ea555532052'\n```\n\n## API\n\n### `stablehash(obj=..., *, algorithm=\"blake2b\")`\n\nReturns a `hashlib`-compatible object with the given algorithm and the hash of the given object. The algorithm must be\none of the algorithms supported by `hashlib`.\n\n### `stablehash.update(obj)`\n\nUpdates the hash with the given object. If the object is not supported, a `TypeError` is raised.\n\n### `stablehash.digest()`\n\nReturns the digest of the hash as a bytes object.\n\n### `stablehash.hexdigest()`\n\nReturns the digest of the hash as a string object.\n\n## Supported types\n\nThe following types are supported:\n\n- `None`\n- `bool`\n- `int`\n- `float`\n- `str`\n- `bytes`\n- `tuple`\n- `list`\n- `set`\n- `frozenset`\n- `dict`\n- `@dataclass` objects\n- `datetime` objects (`datetime`, `date`, `time` and `timedelta`)\n- `uuid.UUID`\n- Picklable objects (e.g. those that implement `__getstate__()`)\n- `type` objects (by their full qualified name)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Stable hashing of Python data structures across separate processes and platforms.",
"version": "0.2.1",
"project_urls": {
"Issues": "https://github.com/NiklasRosenstein/python-stablehash/issues",
"Repository": "https://github.com/NiklasRosenstein/python-stablehash"
},
"split_keywords": [
"dataclasses",
" hash",
" hashlib",
" python hashing",
" stable hash"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc2df0af155f6ca8ee525cdd991d25208b62b5e45a2055eb8cc5f015c681cdc8",
"md5": "8f1944027b53e9f2dc9855a19499ccca",
"sha256": "3605682ba0a4fada6b4436f6f231130d9682acec53b5f9fdbab8d7d8dde516d7"
},
"downloads": -1,
"filename": "stablehash-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f1944027b53e9f2dc9855a19499ccca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5991,
"upload_time": "2024-09-14T22:50:56",
"upload_time_iso_8601": "2024-09-14T22:50:56.606908Z",
"url": "https://files.pythonhosted.org/packages/bc/2d/f0af155f6ca8ee525cdd991d25208b62b5e45a2055eb8cc5f015c681cdc8/stablehash-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a9f114d42a5d67387aea869f853e72e04479b85809ab5483b6f1e34e82caeb6",
"md5": "fed8410fb39a492b346de29bdb7ed3aa",
"sha256": "b547e34cab6f24c199cda76f637a98973b24fb8ddd98f95e509581ed85b429b1"
},
"downloads": -1,
"filename": "stablehash-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "fed8410fb39a492b346de29bdb7ed3aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14914,
"upload_time": "2024-09-14T22:50:58",
"upload_time_iso_8601": "2024-09-14T22:50:58.042498Z",
"url": "https://files.pythonhosted.org/packages/0a/9f/114d42a5d67387aea869f853e72e04479b85809ab5483b6f1e34e82caeb6/stablehash-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-14 22:50:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NiklasRosenstein",
"github_project": "python-stablehash",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "stablehash"
}
JSON
