sentinelhub.os_utils

Module for managing files and folders

sentinelhub.os_utils.get_content_list(folder='.')

Get list of contents in input folder

Parameters

folder (str) – input folder to list contents. Default is '.'

Returns

list of folder contents

Return type

List[str]

sentinelhub.os_utils.get_folder_list(folder='.')

Get list of sub-folders contained in input folder

Parameters

folder (str) – input folder to list sub-folders. Default is '.'

Returns

list of sub-folders

Return type

List[str]

sentinelhub.os_utils.get_file_list(folder='.')

Get list of files contained in input folder

Parameters

folder (str) – input folder to list files only. Default is '.'

Returns

list of files

Return type

List[str]

sentinelhub.os_utils.create_parent_folder(filename)

Create parent folder for input filename recursively

Parameters

filename (str) – input filename

Raises

error if folder cannot be created

Return type

None

sentinelhub.os_utils.make_folder(path)

Create folder at input path recursively

Create a folder specified by input path if one does not exist already

Parameters

path (str) – input path to folder to be created

Raises

os.error if folder cannot be created

Return type

None

sentinelhub.os_utils.rename(old_path, new_path, edit_folders=True)

Rename files or folders

Parameters

• old_path (str) – name of file or folder to rename

• new_path (str) – name of new file or folder

• edit_folders (bool) – flag to allow recursive renaming of folders. Default is True

Return type

None

sentinelhub.os_utils.size(pathname)

Returns size of a file or folder in Bytes

Parameters

pathname (str) – path to file or folder to be sized

Returns

size of file or folder in Bytes

Raises

os.error if file is not accessible

Return type

int

sentinelhub.os_utils.sys_is_windows()

Check if user is running the code on Windows machine

Returns

True if OS is Windows and False otherwise

Return type

bool