rpt_dosi.utils
==============

.. py:module:: rpt_dosi.utils


Attributes
----------

.. autoapisummary::

   rpt_dosi.utils.color_error


Exceptions
----------

.. autoapisummary::

   rpt_dosi.utils.RptError


Classes
-------

.. autoapisummary::

   rpt_dosi.utils.SimpleTest


Functions
---------

.. autoapisummary::

   rpt_dosi.utils.fatal
   rpt_dosi.utils.warning
   rpt_dosi.utils.read_and_check_input_infos
   rpt_dosi.utils.check_required_keys
   rpt_dosi.utils.find_closest_match
   rpt_dosi.utils.get_tests_folder
   rpt_dosi.utils.get_data_folder
   rpt_dosi.utils.get_tests_data_folder
   rpt_dosi.utils.get_tests_output_folder
   rpt_dosi.utils.get_tests_folders
   rpt_dosi.utils.print_tests
   rpt_dosi.utils.test_ok
   rpt_dosi.utils.start_test
   rpt_dosi.utils.stop_test
   rpt_dosi.utils.end_tests
   rpt_dosi.utils.get_subfolders
   rpt_dosi.utils.escape_special_characters
   rpt_dosi.utils.compare_dict
   rpt_dosi.utils.are_dicts_float_equal
   rpt_dosi.utils.run_cmd
   rpt_dosi.utils.indent
   rpt_dosi.utils.get_basename_and_extension
   rpt_dosi.utils.convert_datetime


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

.. py:data:: color_error

.. py:exception:: RptError

   Bases: :py:obj:`Exception`


   Common base class for all non-exit exceptions.


.. py:function:: fatal(s, stop_and_exit=False)

.. py:function:: warning(s)

.. py:function:: read_and_check_input_infos(json_file)

.. py:function:: check_required_keys(param, required_keys)

.. py:function:: find_closest_match(input_string, string_list)

.. py:function:: get_tests_folder()

.. py:function:: get_data_folder()

.. py:function:: get_tests_data_folder(sub_folder=None)

.. py:function:: get_tests_output_folder(sub_folder=None)

.. py:function:: get_tests_folders(test_name)

.. py:function:: print_tests(is_ok, s)

.. py:function:: test_ok(is_ok=False)

.. py:class:: SimpleTest(msg)

   .. py:attribute:: _test_num
      :value: 1



   .. py:attribute:: _global_ok_flag
      :value: True



   .. py:attribute:: _first_failing_test
      :value: None



   .. py:method:: stop_current_test(ok, msg)
      :staticmethod:



   .. py:method:: get_final_ok()
      :staticmethod:



   .. py:method:: get_number_of_tests()
      :staticmethod:



   .. py:method:: get_first_failing_test()
      :staticmethod:



.. py:function:: start_test(msg)

.. py:function:: stop_test(ok, msg)

.. py:function:: end_tests()

.. py:function:: get_subfolders(folder_path, depth=1)

.. py:function:: escape_special_characters(filename)

.. py:function:: compare_dict(dict1, dict2)

.. py:function:: are_dicts_float_equal(dict1, dict2, float_tolerance=1e-09)

.. py:function:: run_cmd(cmd, folder=None)

.. py:function:: indent(input_str, indentation='\t')

.. py:function:: get_basename_and_extension(filename)

   Return the basename and extension of a filename even if .nii.gz is used.


.. py:function:: convert_datetime(value)