HashFunction

Package: flyte.io

A hash method that wraps a user-provided function to compute hashes.

This class allows you to define custom hashing logic by providing a callable
that takes data and returns a hash string. It implements the HashMethod protocol,
making it compatible with Flyte's hashing infrastructure.

Example:
    >>> def my_hash(data: bytes) -> str:
    ...     return hashlib.md5(data).hexdigest()
    >>> hash_fn = HashFunction.from_fn(my_hash)
    >>> hash_fn.update(b"hello")
    >>> hash_fn.result()
    '5d41402abc4b2a76b9719d911017c592'

Attributes:
    _fn: The callable that computes the hash from input data.
    _value: The most recently computed hash value.

Parameters

class HashFunction(
    fn: Callable[[Any], str],
)

Initialize a HashFunction with a custom hash callable.

Methods

from_fn()

def from_fn(
    fn: Callable[[Any], str],
) -> HashFunction

Create a HashFunction from a callable.

This is a convenience factory method for creating HashFunction instances.

Example: »> hash_fn = HashFunction.from_fn(lambda x: hashlib.sha256(x).hexdigest())

Returns

A new HashFunction instance wrapping the provided callable.

reset()

def reset()

result()

def result()

Return the most recently computed hash value.

Returns: The hash string from the last call to update().

update()

def update(
    data: Any,
)

Update the hash value by applying the hash function to the given data.