asset_manifests

BaseAssetManifest dataclass

Bases: ABC

Base class for the Asset Manifest.

decode(*, manifest_data) abstractmethod classmethod

Turn a dictionary for a manifest into an AssetManifest object

encode() abstractmethod

Recursively encode the Asset Manifest into a string according to whatever format the Asset Manifest was written for.

get_default_hash_alg() abstractmethod classmethod

Returns the default hashing algorithm for the Asset Manifest

BaseManifestModel

The base Manifest Model

BaseManifestPath dataclass

Bases: ABC

Data class for paths in the Asset Manifest

__eq__(other)

By default dataclasses still check ClassVars for equality. We only want to compare fields. :param other: :return: True if all fields are equal, False otherwise.

HashAlgorithm

Bases: str, Enum

Enumerant of all hashing algorithms supported by this library.

Algorithms

XXH128 - The xxhash 128-bit hashing algorithm.

ManifestModelRegistry

get_manifest_model(*, version) classmethod

Get the manifest model for the specified version.

register() classmethod

Register the availble manifest models.

ManifestVersion

Bases: str, Enum

Enumerant of all Asset Manifest versions supported by this library.

Special values

UNDEFINED -- Purely for internal testing.

Versions

v2023_03_03 - First version.

hash_data(data, hash_alg)

Hashes the given data bytes using the given hashing algorithm.

hash_file(file_path, hash_alg)

Hashes the given file using the given hashing algorithm.