:py:mod:`test_helper_funcs`
===========================

.. py:module:: test_helper_funcs

.. autodoc2-docstring:: test_helper_funcs
   :parser: rst
   :allowtitles:

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

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`make_tuple_str <test_helper_funcs.make_tuple_str>`
     - .. autodoc2-docstring:: test_helper_funcs.make_tuple_str
          :parser: rst
          :summary:
   * - :py:obj:`compare_output_tuples <test_helper_funcs.compare_output_tuples>`
     - .. autodoc2-docstring:: test_helper_funcs.compare_output_tuples
          :parser: rst
          :summary:
   * - :py:obj:`run_single_test <test_helper_funcs.run_single_test>`
     - .. autodoc2-docstring:: test_helper_funcs.run_single_test
          :parser: rst
          :summary:
   * - :py:obj:`run_func_tests <test_helper_funcs.run_func_tests>`
     - .. autodoc2-docstring:: test_helper_funcs.run_func_tests
          :parser: rst
          :summary:
   * - :py:obj:`clean_input_tuple_list <test_helper_funcs.clean_input_tuple_list>`
     - .. autodoc2-docstring:: test_helper_funcs.clean_input_tuple_list
          :parser: rst
          :summary:
   * - :py:obj:`make_io_pairs_from_input_list <test_helper_funcs.make_io_pairs_from_input_list>`
     - .. autodoc2-docstring:: test_helper_funcs.make_io_pairs_from_input_list
          :parser: rst
          :summary:
   * - :py:obj:`test_bool_func <test_helper_funcs.test_bool_func>`
     - .. autodoc2-docstring:: test_helper_funcs.test_bool_func
          :parser: rst
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`ASSERT_EQUAL <test_helper_funcs.ASSERT_EQUAL>`
     - .. autodoc2-docstring:: test_helper_funcs.ASSERT_EQUAL
          :parser: rst
          :summary:
   * - :py:obj:`ASSERT_LESS <test_helper_funcs.ASSERT_LESS>`
     - .. autodoc2-docstring:: test_helper_funcs.ASSERT_LESS
          :parser: rst
          :summary:
   * - :py:obj:`ASSERT_LESS_OR_EQUAL <test_helper_funcs.ASSERT_LESS_OR_EQUAL>`
     - .. autodoc2-docstring:: test_helper_funcs.ASSERT_LESS_OR_EQUAL
          :parser: rst
          :summary:
   * - :py:obj:`ASSERT_GREATER <test_helper_funcs.ASSERT_GREATER>`
     - .. autodoc2-docstring:: test_helper_funcs.ASSERT_GREATER
          :parser: rst
          :summary:
   * - :py:obj:`ASSERT_GREATER_OR_EQUAL <test_helper_funcs.ASSERT_GREATER_OR_EQUAL>`
     - .. autodoc2-docstring:: test_helper_funcs.ASSERT_GREATER_OR_EQUAL
          :parser: rst
          :summary:
   * - :py:obj:`ASSERT_RAISES <test_helper_funcs.ASSERT_RAISES>`
     - .. autodoc2-docstring:: test_helper_funcs.ASSERT_RAISES
          :parser: rst
          :summary:
   * - :py:obj:`ASSERT_TYPE <test_helper_funcs.ASSERT_TYPE>`
     - .. autodoc2-docstring:: test_helper_funcs.ASSERT_TYPE
          :parser: rst
          :summary:
   * - :py:obj:`ASSERT_TYPES <test_helper_funcs.ASSERT_TYPES>`
     - .. autodoc2-docstring:: test_helper_funcs.ASSERT_TYPES
          :parser: rst
          :summary:

API
~~~

.. py:data:: ASSERT_EQUAL
   :canonical: test_helper_funcs.ASSERT_EQUAL
   :value: 'assert_equal'

   .. autodoc2-docstring:: test_helper_funcs.ASSERT_EQUAL
      :parser: rst

.. py:data:: ASSERT_LESS
   :canonical: test_helper_funcs.ASSERT_LESS
   :value: 'assert_less_than'

   .. autodoc2-docstring:: test_helper_funcs.ASSERT_LESS
      :parser: rst

.. py:data:: ASSERT_LESS_OR_EQUAL
   :canonical: test_helper_funcs.ASSERT_LESS_OR_EQUAL
   :value: 'assert_less_or_equal'

   .. autodoc2-docstring:: test_helper_funcs.ASSERT_LESS_OR_EQUAL
      :parser: rst

.. py:data:: ASSERT_GREATER
   :canonical: test_helper_funcs.ASSERT_GREATER
   :value: 'assert_greater_than'

   .. autodoc2-docstring:: test_helper_funcs.ASSERT_GREATER
      :parser: rst

.. py:data:: ASSERT_GREATER_OR_EQUAL
   :canonical: test_helper_funcs.ASSERT_GREATER_OR_EQUAL
   :value: 'assert_greater_or_equal'

   .. autodoc2-docstring:: test_helper_funcs.ASSERT_GREATER_OR_EQUAL
      :parser: rst

.. py:data:: ASSERT_RAISES
   :canonical: test_helper_funcs.ASSERT_RAISES
   :value: 'assert_raises'

   .. autodoc2-docstring:: test_helper_funcs.ASSERT_RAISES
      :parser: rst

.. py:data:: ASSERT_TYPE
   :canonical: test_helper_funcs.ASSERT_TYPE
   :value: 'assert_output_is_type'

   .. autodoc2-docstring:: test_helper_funcs.ASSERT_TYPE
      :parser: rst

.. py:data:: ASSERT_TYPES
   :canonical: test_helper_funcs.ASSERT_TYPES
   :value: None

   .. autodoc2-docstring:: test_helper_funcs.ASSERT_TYPES
      :parser: rst

.. py:function:: make_tuple_str(input_tuple)
   :canonical: test_helper_funcs.make_tuple_str

   .. autodoc2-docstring:: test_helper_funcs.make_tuple_str
      :parser: rst

.. py:function:: compare_output_tuples(output_tuple1, output_tuple2, compare_type=ASSERT_EQUAL)
   :canonical: test_helper_funcs.compare_output_tuples

   .. autodoc2-docstring:: test_helper_funcs.compare_output_tuples
      :parser: rst

.. py:function:: run_single_test(test_func, test_input=(), expected_output=(), assert_type=ASSERT_EQUAL, test_desc='', raise_error_on_fail=True, add_new_line=True, include_input_in_error_msg=True)
   :canonical: test_helper_funcs.run_single_test

   .. autodoc2-docstring:: test_helper_funcs.run_single_test
      :parser: rst

.. py:function:: run_func_tests(test_func, correct_io_pairs, assert_type=ASSERT_EQUAL, test_desc='', raise_error_on_fail=True)
   :canonical: test_helper_funcs.run_func_tests

   .. autodoc2-docstring:: test_helper_funcs.run_func_tests
      :parser: rst

.. py:function:: clean_input_tuple_list(input_list)
   :canonical: test_helper_funcs.clean_input_tuple_list

   .. autodoc2-docstring:: test_helper_funcs.clean_input_tuple_list
      :parser: rst

.. py:function:: make_io_pairs_from_input_list(input_list, expected_output)
   :canonical: test_helper_funcs.make_io_pairs_from_input_list

   .. autodoc2-docstring:: test_helper_funcs.make_io_pairs_from_input_list
      :parser: rst

.. py:function:: test_bool_func(test_func, true_inputs=None, false_inputs=None, test_desc='', error_if_false=False, error_if_false_type=Exception, raise_error_on_fail=True, type_error_inputs=None, value_error_inputs=None, assert_error_inputs=None)
   :canonical: test_helper_funcs.test_bool_func

   .. autodoc2-docstring:: test_helper_funcs.test_bool_func
      :parser: rst