elasticai.creator.file_generation.resource_utils#

Module Contents#

Functions#

get_file_from_package

This is a context manager, because the returned file might be extracted from a zip file and the context manager will take care of removing the resulting temporary files on exit

read_text

copy_file

get_full_path

read_text_from_path

save_text_to_path

Data#

API#

elasticai.creator.file_generation.resource_utils.PathType#

None

elasticai.creator.file_generation.resource_utils.Package#

None

elasticai.creator.file_generation.resource_utils.get_file_from_package(package: elasticai.creator.file_generation.resource_utils.Package, file_name: str) ContextManager[pathlib.Path][source]#

This is a context manager, because the returned file might be extracted from a zip file and the context manager will take care of removing the resulting temporary files on exit

elasticai.creator.file_generation.resource_utils.read_text(package: elasticai.creator.file_generation.resource_utils.Package, file_name: str) collections.abc.Iterator[str][source]#
elasticai.creator.file_generation.resource_utils.copy_file(package: elasticai.creator.file_generation.resource_utils.Package, file_name: str, destination: elasticai.creator.file_generation.resource_utils.PathType) None[source]#
elasticai.creator.file_generation.resource_utils.get_full_path(package: elasticai.creator.file_generation.resource_utils.Package, file_name: str) str[source]#
elasticai.creator.file_generation.resource_utils.read_text_from_path(path: elasticai.creator.file_generation.resource_utils.PathType, encoding: str = 'utf-8') str[source]#
elasticai.creator.file_generation.resource_utils.save_text_to_path(text: str, path: elasticai.creator.file_generation.resource_utils.PathType, encoding: str = 'utf-8') None[source]#