Functions

List of functions in the ude.storage namespace.

Entity Name	Description
save_compressed_ir	Serializes a ProjectCatalog model into JSON and compresses it on-the-fly using Gzip.
load_compressed_ir	Reads a Gzip-compressed file, decompresses it, and parses it into a typed ProjectCatalog.
calculate_sha256	Calculates the SHA-256 hash of a string or bytes content.
compute_template_hash	Calculates a stable SHA-256 hash of all file contents inside a template directory.
get_file_metadata	Retrieves modification time, size, and SHA-256 content hash of a file.

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

calculate_sha256 function

Calculates the SHA-256 hash of a string or bytes content.

Returns:

The hex-encoded SHA-256 digest.

Methods

calculate_sha256

calculate_sha256(content: Union) -> str

Calculates the SHA-256 hash of a string or bytes content.

Returns:

The hex-encoded SHA-256 digest.

Parameter	Type	Description
content	`Union`	The content to hash; str is encoded as UTF-8 first.

Generated with Flude

compute_template_hash function

Calculates a stable SHA-256 hash of all file contents inside a template directory.

Files are read in UTF-8 and hashed in alphabetical order of their relative path to ensure cross-platform stability.

Returns:

The hex-encoded SHA-256 digest of the combined file contents, or ""

Methods

compute_template_hash

compute_template_hash(template_dir: Union) -> str

Calculates a stable SHA-256 hash of all file contents inside a template directory.

Files are read in UTF-8 and hashed in alphabetical order of their relative path to ensure cross-platform stability.

get_file_metadata function

Retrieves modification time, size, and SHA-256 content hash of a file.

Returns:

A 3-tuple of (mtime, size in bytes, hex-encoded SHA-256 digest).

Methods

get_file_metadata

get_file_metadata(file_path: Union) -> tuple[float, int, str]

Retrieves modification time, size, and SHA-256 content hash of a file.

Returns:

A 3-tuple of (mtime, size in bytes, hex-encoded SHA-256 digest).

Parameter	Type	Description
file_path	`Union`	Path to the file to inspect.

Generated with Flude

load_compressed_ir function

Reads a Gzip-compressed file, decompresses it, and parses it into a typed ProjectCatalog.

Raises: FileNotFoundError: If the file does not exist.

Returns:

The deserialized and validated ProjectCatalog instance.

Methods

load_compressed_ir

load_compressed_ir(file_path: Union) -> ProjectCatalog

Reads a Gzip-compressed file, decompresses it, and parses it into a typed ProjectCatalog.

Raises: FileNotFoundError: If the file does not exist.

Returns:

The deserialized and validated ProjectCatalog instance.

Parameter	Type	Description
file_path	`Union`	The file path to load from.

Generated with Flude

save_compressed_ir function

Serializes a ProjectCatalog model into JSON and compresses it on-the-fly using Gzip.

Methods

save_compressed_ir

save_compressed_ir(catalog: ProjectCatalog, file_path: Union)

Serializes a ProjectCatalog model into JSON and compresses it on-the-fly using Gzip.

Parameter	Type	Description
catalog	`ProjectCatalog`	The ProjectCatalog instance to save.
file_path	`Union`	The target file path on disk (usually with a .json.gz extension).

Generated with Flude