caikit.core.toolkit.fileio

Basic routines for reading and writing common file types.

Functions

load_txt(filename)	Load a string from a file with utf8 encoding.
load_txt_lines(filename)	Load a list of files from a text file with utf8 encoding
save_txt(text, filename[, mode])	Write a string to a text file with utf8 encoding.
load_binary(filename)	Load a binary string from a file.
save_binary(data, filename)	Write a binary buffer to a file.
load_csv(filename)	Load a csv into a list-of-lists.
save_csv(text_list, filename[, mode])	Write a list-of-lists to a csv file.
load_dict_csv(filename)	Load a csv into a list-of-dicts.
save_dict_csv(dict_list, filename[, mode])	Write a list of dicts to a csv file.
load_json(filename)	Load a json file into a dictionary.
save_json(save_dict, filename[, mode])	Save a dictionary into a json file.
load_yaml(filename)	Load a yaml file into a dictionary.
save_yaml(save_dict, filename[, mode])	Save a dictionary into a yaml file.
load_pickle(filename)	Load an object from a pickle file.
save_pickle(obj, filename[, mode])	Save an object to a pickle file.
save_raw(save_content, filename[, mode])	Write the given raw string content to output file.
compress(dir_path[, output_path, extension])	Compress a given folder recursively to an archive with a given extension format

Module Contents

caikit.core.toolkit.fileio.load_txt(filename)

Load a string from a file with utf8 encoding.

caikit.core.toolkit.fileio.load_txt_lines(filename)

Load a list of files from a text file with utf8 encoding

caikit.core.toolkit.fileio.save_txt(text, filename, mode='w')

Write a string to a text file with utf8 encoding.

caikit.core.toolkit.fileio.load_binary(filename)

Load a binary string from a file.

caikit.core.toolkit.fileio.save_binary(data, filename)

Write a binary buffer to a file.

caikit.core.toolkit.fileio.load_csv(filename)

Load a csv into a list-of-lists.

caikit.core.toolkit.fileio.save_csv(text_list, filename, mode='w')

Write a list-of-lists to a csv file.

caikit.core.toolkit.fileio.load_dict_csv(filename)

Load a csv into a list-of-dicts.

caikit.core.toolkit.fileio.save_dict_csv(dict_list, filename, mode='w')

Write a list of dicts to a csv file.

caikit.core.toolkit.fileio.load_json(filename)

Load a json file into a dictionary.

caikit.core.toolkit.fileio.save_json(save_dict, filename, mode='w')

Save a dictionary into a json file.

caikit.core.toolkit.fileio.load_yaml(filename)

Load a yaml file into a dictionary.

caikit.core.toolkit.fileio.save_yaml(save_dict, filename, mode='w')

Save a dictionary into a yaml file.

caikit.core.toolkit.fileio.load_pickle(filename)

Load an object from a pickle file.

caikit.core.toolkit.fileio.save_pickle(obj, filename, mode='wb')

Save an object to a pickle file.

caikit.core.toolkit.fileio.save_raw(save_content, filename, mode='w')

Write the given raw string content to output file.

caikit.core.toolkit.fileio.compress(dir_path, output_path=None, extension='zip')

Compress a given folder recursively to an archive with a given extension format

Args:

dir_path (str): Path of directory to compress output_path: (Optional) str

Output path where the archive is created. Defaults to current path + ‘archive’ + format extension >>> compress(‘.’, ‘my/path’, ‘tar’) >>> # saves to ‘my/path/archive.tar’

extension: (Optional) (one of: zip/tar/gztar/bztar/xztar depending on module availability)

Defaults to .zip

Returns:

str: Path to created archive