file

File Utility API

This module provides utility functions to interact with files.

Functions

Name	Description
download_file	Download file from supplied url to destination streaming
compute_checksum	Compute checksum of file
load_pkl	Load pickled file
save_pkl	Save python objects into pickle file
resolve_template_path	Resolve templated path w/ supplied substitutions

Machine-readable model

• download_filefunctionDownload file from supplied url to destination streaming.
• compute_checksumfunctionCompute checksum of file.
• load_pklfunctionLoad pickled file.
• save_pklfunctionSave python objects into pickle file.
• resolve_template_pathfunctionResolve templated path w/ supplied substitutions.

function

download_file

Python

Download file from supplied url to destination streaming.

helia_edge/utils/file.py:26

download_file(src: str, dst: os.PathLike, progress: bool = True, chunk_size: int = 8192)

Download file from supplied url to destination streaming.

Parameters

Parameters of download_file

Name	Type	Default	Description
src	str	Required	Source URL path
dst	PathLike	Required	Destination file path
progress	bool	True	Display progress bar. Defaults to True.

function

compute_checksum

Python

Compute checksum of file.

helia_edge/utils/file.py:49

compute_checksum(file: Path, checksum_type: str = 'md5', chunk_size: int = 8192) -> str

Compute checksum of file.

Parameters

Parameters of compute_checksum

Name	Type	Default	Description
file	Path	Required	File path
checksum_type	str	'md5'	Checksum type. Defaults to "md5".
chunk_size	int	8192	Chunk size. Defaults to 8192.

Returns

Returns of compute_checksum

Value	Type	Description
str	str	Checksum value

function

load_pkl

Python

Load pickled file.

helia_edge/utils/file.py:69

load_pkl(file: str, compress: bool = True) -> dict[str, Any]

Load pickled file.

Parameters

Parameters of load_pkl

Name	Type	Default	Description
file	str	Required	File path (.pkl)
compress	bool	True	If file is compressed. Defaults to True.

Returns

Returns of load_pkl

Type	Description
dict[str, Any]	dict[str, Any]: Dictionary of pickled objects

function

save_pkl

Python

Save python objects into pickle file.

helia_edge/utils/file.py:87

save_pkl(file: str, compress: bool = True, **kwargs={})

Save python objects into pickle file.

Parameters

Parameters of save_pkl

Name	Type	Default	Description
file	str	Required	File path (.pkl)
compress	bool	True	Whether to compress file. Defaults to True.

function

resolve_template_path

Python

Resolve templated path w/ supplied substitutions.

helia_edge/utils/file.py:102

resolve_template_path(fpath: Path, **kwargs: Any = {}) -> Path

Resolve templated path w/ supplied substitutions.

Parameters

Parameters of resolve_template_path

Name	Type	Default	Description
fpath	Path	Required	File path
**kwargs	Any	{}	Template arguments

Returns

Returns of resolve_template_path

Value	Type	Description
Path	Path	Resolved file path