fleche.digest

Attributes

logger
DIGEST_LENGTH
T
_HOOKS
_EP_HOOKS
_TYPES_WITHOUT_DIGEST

Exceptions

Unhashable

Exception raised when an object cannot be digested.

Classes

Digest	str(object='') -> str
Hook

Functions

get_hooks()
add_hook(hook)
load_entry_points()
digest(→ Digest)
_digest(→ Digest)	Generates a SHA256 digest for a given Python object.

Module Contents

fleche.digest.logger

exception fleche.digest.Unhashable

Bases: Exception

Exception raised when an object cannot be digested.

class fleche.digest.Digest

Bases: str

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

expand(cache=None) → Digest

Expand a short digest prefix to its full-length digest using the cache.

Parameters:

cache – A cache instance to use. If None, uses the current context’s cache.

Returns:

The full-length Digest.

shrink(cache=None) → Digest

Shrink a digest to its shortest unambiguous prefix using the cache.

Parameters:

cache – A cache instance to use. If None, uses the current context’s cache.

Returns:

The shortest unambiguous Digest prefix.

fleche.digest.DIGEST_LENGTH = 64

fleche.digest.T

class fleche.digest.Hook

Bases: Generic[T]

type: T

digest: Callable[[T], str | Digest]

fleche.digest._HOOKS = []

fleche.digest._EP_HOOKS = []

fleche.digest._TYPES_WITHOUT_DIGEST: set[type]

fleche.digest.get_hooks()

fleche.digest.add_hook(hook: Hook | tuple[Type[T], Callable[[T], str]])

fleche.digest.load_entry_points()

fleche.digest.digest(value: Any) → Digest

fleche.digest._digest(value: Any) → Digest

Generates a SHA256 digest for a given Python object.

This function handles various types including strings, bytes, integers, floats, booleans, None, dictionaries, numpy arrays, dataclasses, and iterables. If an unhashable type is encountered, an Unhashable exception is raised.

Parameters:

value (Any) – The object to be digested.

Returns:

The SHA256 hexdigest of the object.

Return type:

str

Raises:

Unhashable – If the provided value cannot be digested.