:py:mod:`mloq._utils`
=====================

.. py:module:: mloq._utils

.. autoapi-nested-parse::

   This module contains some utilities that are not currently used.



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


Functions
~~~~~~~~~

.. autoapisummary::

   mloq._utils.dir_trees_are_equal
   mloq._utils.files_are_equal
   mloq._utils.get_generated_files
   mloq._utils.get_generated_directories
   mloq._utils.check_directories_exist
   mloq._utils.get_docker_python_version
   mloq._utils.write_config_setup
   mloq._utils.load_empty_config_setup



.. py:function:: dir_trees_are_equal(dir1, dir2)

   Compare two directories recursively. Files in each directory are     assumed to be equal if their names and contents are equal.

   @param dir1: First directory path
   @param dir2: Second directory path

   @return: True if the directory trees are the same and
       there were no errors while accessing the directories or files,
       False otherwise.


.. py:function:: files_are_equal(path1, path2)

   Compare the content of two files.

   Compare two incoming files. They are assumed equal if their contents
   are the same.

   :param path1: Path containing the first file to be compared.
   :param path2: Path containing the second file to be compared.

   :returns:

             It returns True if the two given files are equal and no errors
                have arisen during the process. False otherwise.


.. py:function:: get_generated_files(path)

   List all the files generated in the last mloq run.

   :param path: path to WHAT_MLOQ_GENERATED.md file.

   :returns: List of Path containing the names of the files generated by mloq.


.. py:function:: get_generated_directories(path)

   List all the directories generated in the last mloq run.

   :param path: path to WHAT_MLOQ_GENERATED.md file.

   :returns: List of Path containing the names of the directories generated by mloq.


.. py:function:: check_directories_exist(paths)

   Check if the provided paths exist.

   :param paths: List of paths that will be checked

   :returns: True if all the provided paths exist. False otherwise.


.. py:function:: get_docker_python_version(template)

   Return the highest python version defined for the project.


.. py:function:: write_config_setup(config, path, safe = False)

   Write setup config in a yaml file.


.. py:function:: load_empty_config_setup()

   Return a dictionary containing all the MLOQ setup config values set to None.