caikit.core.toolkit.fileio
==========================

.. py:module:: caikit.core.toolkit.fileio

.. autoapi-nested-parse::

   Basic routines for reading and writing common file types.



Functions
---------

.. autoapisummary::

   caikit.core.toolkit.fileio.load_txt
   caikit.core.toolkit.fileio.load_txt_lines
   caikit.core.toolkit.fileio.save_txt
   caikit.core.toolkit.fileio.load_binary
   caikit.core.toolkit.fileio.save_binary
   caikit.core.toolkit.fileio.load_csv
   caikit.core.toolkit.fileio.save_csv
   caikit.core.toolkit.fileio.load_dict_csv
   caikit.core.toolkit.fileio.save_dict_csv
   caikit.core.toolkit.fileio.load_json
   caikit.core.toolkit.fileio.save_json
   caikit.core.toolkit.fileio.load_yaml
   caikit.core.toolkit.fileio.save_yaml
   caikit.core.toolkit.fileio.load_pickle
   caikit.core.toolkit.fileio.save_pickle
   caikit.core.toolkit.fileio.save_raw
   caikit.core.toolkit.fileio.compress


Module Contents
---------------

.. py:function:: load_txt(filename)

   Load a string from a file with utf8 encoding.


.. py:function:: load_txt_lines(filename)

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


.. py:function:: save_txt(text, filename, mode='w')

   Write a string to a text file with utf8 encoding.


.. py:function:: load_binary(filename)

   Load a binary string from a file.


.. py:function:: save_binary(data, filename)

   Write a binary buffer to a file.


.. py:function:: load_csv(filename)

   Load a csv into a list-of-lists.


.. py:function:: save_csv(text_list, filename, mode='w')

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


.. py:function:: load_dict_csv(filename)

   Load a csv into a list-of-dicts.


.. py:function:: save_dict_csv(dict_list, filename, mode='w')

   Write a list of dicts to a csv file.


.. py:function:: load_json(filename)

   Load a json file into a dictionary.


.. py:function:: save_json(save_dict, filename, mode='w')

   Save a dictionary into a json file.


.. py:function:: load_yaml(filename)

   Load a yaml file into a dictionary.


.. py:function:: save_yaml(save_dict, filename, mode='w')

   Save a dictionary into a yaml file.


.. py:function:: load_pickle(filename)

   Load an object from a pickle file.


.. py:function:: save_pickle(obj, filename, mode='wb')

   Save an object to a pickle file.


.. py:function:: save_raw(save_content, filename, mode='w')

   Write the given raw string content to output file.


.. py:function:: 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