test-helper-by-delica 0.1.dev1__tar.gz

test_helper_by_delica-0.1.dev1/.github/workflows/main.yml

@@ -0,0 +1,77 @@
+name: publish-python-to-pypi
+#Workflow Source: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    #if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/test_helper_by_delica  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  # publish-to-testpypi:
+  #   name: Publish Python 🐍 distribution 📦 to TestPyPI
+  #   needs:
+  #   - build
+  #   runs-on: ubuntu-latest
+
+  #   environment:
+  #     name: testpypi
+  #     url: https://test.pypi.org/p/<package-name>
+
+  #   permissions:
+  #     id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+  #   steps:
+  #   - name: Download all the dists
+  #     uses: actions/download-artifact@v4
+  #     with:
+  #       name: python-package-distributions
+  #       path: dist/
+  #   - name: Publish distribution 📦 to TestPyPI
+  #     uses: pypa/gh-action-pypi-publish@release/v1
+  #     with:
+  #       repository-url: https://test.pypi.org/legacy/

test_helper_by_delica-0.1.dev1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 DelicaLM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

test_helper_by_delica-0.1.dev1/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: test_helper_by_delica
+Version: 0.1.dev1
+Summary: A Python package that simplifies the creation and execution of unittest test cases.
+Author: Delica Leboe-McGowan
+Author-email: Delica Leboe-McGowan <stormindustries22@outlook.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Dynamic: author
+
+# Test-helper-by-delica 
+
+## Purpose
+
+This Python package simplifies the creation and execution of unittest (a widely used library for unit testing) test 
+cases, in order to help programmers efficiently develop and run tests for their Python software.
+
+## Installation
+
+## Getting Started
+
+## Citation

test_helper_by_delica-0.1.dev1/README.md

@@ -0,0 +1,12 @@
+# Test-helper-by-delica 
+
+## Purpose
+
+This Python package simplifies the creation and execution of unittest (a widely used library for unit testing) test 
+cases, in order to help programmers efficiently develop and run tests for their Python software.
+
+## Installation
+
+## Getting Started
+
+## Citation

test_helper_by_delica-0.1.dev1/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "test_helper_by_delica"
+dynamic = ["version"]
+authors = [
+  { name="Delica Leboe-McGowan", email="stormindustries22@outlook.com" },
+]
+
+description = "A Python package that simplifies the creation and execution of unittest test cases."
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICENCE*"]
+
+[build-system]
+requires = ["setuptools >= 77.0.3", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+local_scheme = "no-local-version"

test_helper_by_delica-0.1.dev1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

test_helper_by_delica-0.1.dev1/setup.py

@@ -0,0 +1,20 @@
+from setuptools import setup
+from pathlib import Path
+
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
+setup(
+    name='test_helper_by_delica',
+    use_scm_version=True,
+    setup_requires=['setuptools_scm'],
+    description="A Python package that simplifies the creation and execution of unittest test cases.",
+    author="Delica Leboe-McGowan",
+    author_email="stormindustries22@outlook.com",
+    packages=['test_helper_by_delica'],
+    install_requires=[
+
+    ],
+    long_description=long_description,
+    long_description_content_type='text/markdown'
+)

test_helper_by_delica-0.1.dev1/test_helper_by_delica/__init__.py

@@ -0,0 +1,5 @@
+from test_helper_by_delica.test_helper_funcs import test_bool_func
+
+
+
+

test_helper_by_delica-0.1.dev1/test_helper_by_delica/test_helper_funcs.py

@@ -0,0 +1,209 @@
+from unittest import TestCase
+
+def run_single_test(unittest_obj, assert_func, test_func, test_input=(), expected_output=(),
+                    test_desc=""):
+    """Runs a single test using an unittest TestCase object.
+
+    Parameters
+    ----------
+    unittest_obj : TestCase
+        The unittest TestCase object that should be used to run the test.
+    assert_func : function
+        The unittest assertion function that should be used to verify the result of the test.
+    test_func : function
+        The function that should be tested.
+    test_input : tuple, default=()
+        The input tuple that will be passed to the test function.
+    expected_output : tuple, default=()
+        The expected output that should be returned by the test function.
+    test_desc : str, default=""
+        A description of the test that should be printed to stdout.
+
+    Returns
+    -------
+    None
+
+    Raises
+    ______
+    AssertionError
+        Raised if the test fails.
+    """
+    assert isinstance(unittest_obj, TestCase)
+    assert callable(assert_func)
+    # test = getattr(TestCase, assert_func.__name__)
+    # assert callable(getattr(unittest_obj, assert_func.__name__))
+    assert callable(test_func)
+    print("Testing " + test_desc)
+    input_string = str(test_input)
+    expected_output_string = str(expected_output)
+    use_assert_raises = False
+    error_type = None
+    use_assert_raises = False
+    if type(expected_output) is type:
+        use_assert_raises = issubclass(expected_output, Exception)
+        if use_assert_raises:
+            error_type = expected_output
+
+    if use_assert_raises:
+        assert error_type is not None
+        # error_type = Exception
+        # if len(expected_output) > 0:
+        #     error_type = expected_output[0]
+        assert error_type is Exception or issubclass(error_type, Exception)
+        with unittest_obj.assertRaises(error_type) as context_manager:
+            test_func(*test_input)
+        raised_exception = context_manager.exception
+        if raised_exception is not None:
+            print(f"ERROR MESSAGE: {str(raised_exception)}")
+
+    else:
+        test_output = test_func(*test_input)
+        if hasattr(test_output, "__len__"):
+            assert len(test_output) == len(expected_output)
+        if type(test_output) is tuple:
+            assert_func(*test_output, *expected_output)
+        else:
+            assert_func(test_output, expected_output)
+
+        # assert_func(test_output, *expected_output)
+    print(f"SUCCESS: input={input_string} -> output={expected_output_string}")
+
+
+def run_func_tests(unittest_obj, assert_func, test_func, input_output_pairs, test_desc=""):
+    """Runs a set of unittest tests for a specified function.
+
+    Parameters
+    ----------
+    unittest_obj : TestCase
+        The unittest TestCase object that should be used to run the tests.
+    assert_func : function
+        The unittest assertion function that should be used to verify the results of the tests.
+    test_func : function
+        The function that should be tested.
+    input_output_pairs : list
+        List of the input/output tuples that should be passed to the test function. The length of this list determines
+        the number of tests that will be run.
+    test_desc : str, default="",
+        A description of the tests that should be printed to stdout.
+
+    Returns
+    -------
+    None
+
+    Raises
+    ______
+    AssertionError
+        Raised if any of the tests fail (stdout messages allow the user to easily determine which test case failed).
+
+    """
+    assert isinstance(unittest_obj, TestCase)
+    assert callable(test_func)
+    assert callable(assert_func)
+    assert type(input_output_pairs) == list
+    assert type(test_desc) == str
+    print("TESTING " + test_desc.upper())
+    io_pairs = []
+    for io_pair in input_output_pairs:
+        if io_pair != ():
+            io_pairs.append(io_pair)
+    num_tests = len(io_pairs)
+    test_num = 1
+    for io_pair in io_pairs:
+        assert type(io_pair) == tuple
+        assert len(io_pair) == 1 or len(io_pair) == 2
+        test_input = io_pair[0]
+        expected_output = ()
+        if len(io_pair) == 2:
+            expected_output = io_pair[1]
+        print(f"Test #{test_num} of {num_tests}")
+        run_single_test(unittest_obj, assert_func, test_func, test_input, expected_output,
+                        f"{test_func.__name__} function for input " + str(test_input))
+        test_num += 1
+    print(f"ALL {num_tests} TESTS COMPLETED FOR {test_desc.upper()}\n")
+
+
+def test_bool_func(unittest_obj, test_func, true_inputs=None, false_inputs=None, error_if_false=False, error_type=Exception,
+                   test_desc="", success_desc=""):
+    """Runs a set of unittest tests for a function that returns a boolean value.
+
+    Parameters
+    ----------
+    unittest_obj : TestCase
+        The unittest TestCase object that should be used to run the tests.
+    test_func : function
+        The boolean function that should be tested.
+    true_inputs : list
+        List of input tuples that should cause the test function to return True.
+    false_inputs : list
+        List of input tuples that should cause the test function to return False.
+    error_if_false : bool, default=False
+        Boolean flag for whether the function should raise an error when the condition it evaluates is False.
+    error_type : type, default=Exception
+        The type of exception that should be raised for False results.
+    test_desc : str, default="",
+        A description of the tests that should be printed to stdout.
+
+    Returns
+    -------
+    None
+
+    Raises
+    ______
+    AssertionError
+        Raised if any of the tests fail (stdout messages allow the user to easily determine which test case failed).
+
+    """
+    assert isinstance(unittest_obj, TestCase)
+    assert callable(test_func)
+    if true_inputs is None:
+        true_inputs = []
+    else:
+        assert type(true_inputs) == list
+    if false_inputs is None:
+        false_inputs = []
+    else:
+        assert type(false_inputs) == list
+    assert type(false_inputs) == list
+    assert type(error_if_false) == bool
+    assert issubclass(error_type, Exception)
+    assert type(test_desc) == str
+    assert type(success_desc) == str
+    # print("TESTING " + test_desc.upper())
+    assert_func = unittest_obj.assertEqual
+    test_inputs = true_inputs.copy()
+    test_inputs.extend(false_inputs)
+    expected_outputs = [(True)] * len(true_inputs)
+    false_output = False
+    if error_if_false:
+        false_output = error_type
+    expected_outputs.extend([(false_output)] * len(false_inputs))
+    num_tests = len(test_inputs)
+    assert num_tests == len(expected_outputs)
+    if num_tests > 0:
+        io_pairs = [()]*num_tests
+        io_index = 0
+        while io_index < num_tests:
+            test_input = test_inputs[io_index]
+            expected_output = expected_outputs[io_index]
+            io_pairs[io_index] = (test_input, expected_output)
+            io_index += 1
+        run_func_tests(unittest_obj, assert_func, test_func, io_pairs, test_desc)
+
+
+    # test_num = 1
+    # num_tests = len(true_inputs) + len(false_inputs)
+    # for true_input in true_inputs:
+    #     assert type(true_input) == tuple
+    #     print(f"Test #{test_num} of {num_tests}")
+    #     run_single_test(unittest_obj, assert_func, test_func, true_input, (True), f"{test_func.__name__} function for input "
+    #                     + str(true_input), success_desc)
+    #     test_num += 1
+    # for false_input in false_inputs:
+    #     assert type(false_input) == tuple
+    #     print(f"Test #{test_num} of {num_tests}")
+    #     if error_if_false:
+    #         assert_func = unittest_obj.assertRaises
+    #     run_single_test(unittest_obj, assert_func, test_func, false_input, TypeError,
+    #                     f"{test_func.__name__} function for input "
+    #                     + str(false_input), success_desc)
+    # test_num += 1

test_helper_by_delica-0.1.dev1/test_helper_by_delica.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: test_helper_by_delica
+Version: 0.1.dev1
+Summary: A Python package that simplifies the creation and execution of unittest test cases.
+Author: Delica Leboe-McGowan
+Author-email: Delica Leboe-McGowan <stormindustries22@outlook.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Dynamic: author
+
+# Test-helper-by-delica 
+
+## Purpose
+
+This Python package simplifies the creation and execution of unittest (a widely used library for unit testing) test 
+cases, in order to help programmers efficiently develop and run tests for their Python software.
+
+## Installation
+
+## Getting Started
+
+## Citation

test_helper_by_delica-0.1.dev1/test_helper_by_delica.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+requirements.txt
+setup.py
+.github/workflows/main.yml
+test_helper_by_delica/__init__.py
+test_helper_by_delica/test_helper_funcs.py
+test_helper_by_delica.egg-info/PKG-INFO
+test_helper_by_delica.egg-info/SOURCES.txt
+test_helper_by_delica.egg-info/dependency_links.txt
+test_helper_by_delica.egg-info/top_level.txt
+tests/test_test_helper_funcs.py

test_helper_by_delica-0.1.dev1/test_helper_by_delica.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

test_helper_by_delica-0.1.dev1/test_helper_by_delica.egg-info/top_level.txt

@@ -0,0 +1 @@
+test_helper_by_delica

test_helper_by_delica-0.1.dev1/tests/test_test_helper_funcs.py

@@ -0,0 +1,34 @@
+from unittest import TestCase
+import test_helper_by_delica.test_helper_funcs as test_lib
+
+def test_func_always_true(test_int1=0, test_int2=0, test_bool1=True, test_bool2=False, test_str1="", test_str2=""):
+    return True
+
+def test_func_always_false(test_int1=0, test_int2=0, test_bool1=True, test_bool2=False, test_str1="", test_str2=""):
+    return False
+
+def test_func_is_int(test_input=0):
+    return type(test_input) is int
+
+def test_func_is_int_type_error_if_false(test_input=0):
+    is_int = type(test_input) is int
+    if not is_int:
+        raise TypeError(f"{test_input} is not an integer")
+    return is_int
+
+class Test(TestCase):
+    def test_test_bool_func(self):
+        # test_lib.test_bool_func(self, test_func_always_true, true_inputs=[(),(1,),(1,2),(1,2,True,False),
+        #                                                                   (1,2,True,False,"A","ab")],
+        #                         test_desc="always true function")
+        # test_lib.test_bool_func(self, test_func_always_false, false_inputs=[(),(1,),(1,2),(1,2,True,False),
+        #                                                                   (1,2,True,False,"A","ab")],
+        #                         test_desc="always false function")
+        # test_lib.test_bool_func(self, test_func_is_int, true_inputs=[(),(1,),(-1,),(10000,),(-10000,)],
+        #                         false_inputs=[(1.0,),(-1.0,),(10000.0,),(-10000.0,),("",),("int",),(True,),(False,)],
+        #                         test_desc="is int function")
+        test_lib.test_bool_func(self, test_func_is_int_type_error_if_false, true_inputs=[(), (1,), (-1,), (10000,), (-10000,)],
+                                false_inputs=[(1.0,), (-1.0,), (10000.0,), (-10000.0,), ("",), ("int",), (True,),
+                                              (False,)],
+                                test_desc="is int function with TypeError if false", error_if_false=True, error_type=TypeError)
+        test = 0