raisefunction 0.0.2.dev0__tar.gz → 1.0.1__tar.gz

{raisefunction-0.0.2.dev0/src/raisefunction.egg-info → raisefunction-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: raisefunction
-Version: 0.0.2.dev0
+Version: 1.0.1
 Summary: This project provides a function that raises errors passed to it.
 Author-email: Johannes <johannes-programming@mailfence.com>
 License: The MIT License (MIT)
@@ -28,7 +28,7 @@ Project-URL: Download, https://pypi.org/project/raisefunction/#files
 Project-URL: Index, https://pypi.org/project/raisefunction/
 Project-URL: Source, https://github.com/johannes-programming/raisefunction/
 Project-URL: Website, https://raisefunction.johannes-programming.online/
-Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
@@ -40,6 +40,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
+Requires-Dist: overloadable>=1.0.9
 
 =============
 raisefunction

{raisefunction-0.0.2.dev0 → raisefunction-1.0.1}/pyproject.toml

@@ -9,7 +9,7 @@ authors = [
     { email = "johannes-programming@mailfence.com", name = "Johannes" },
 ]
 classifiers = [
-    "Development Status :: 2 - Pre-Alpha",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
@@ -19,13 +19,15 @@ classifiers = [
     "Programming Language :: Python :: 3 :: Only",
     "Typing :: Typed",
 ]
-dependencies = []
+dependencies = [
+    "overloadable>=1.0.9",
+]
 description = "This project provides a function that raises errors passed to it."
 keywords = []
 name = "raisefunction"
 readme = "README.rst"
 requires-python = ">=3.8"
-version = "0.0.2.dev0"
+version = "1.0.1"
 
 [project.license]
 file = "LICENSE.txt"

raisefunction-1.0.1/src/raisefunction/core/__init__.py

@@ -0,0 +1,31 @@
+from typing import *
+
+from overloadable import overloadable
+
+__all__ = ["raisefunction"]
+
+
+@overloadable
+def raisefunction(*args: Any) -> int:
+    "This function works as dispatcher."
+    if len(args) < 1:
+        raise TypeError(
+            "A raise statement requires at least 1 positional argument (0 given)."
+        )
+    if len(args) > 2:
+        raise TypeError(
+            "An assertion takes at most 2 positional arguments (%s given)." % len(args)
+        )
+    return len(args)
+
+
+@raisefunction.overload(1)
+def raisefunction(exc: BaseException, /) -> None:
+    "This function raises the given exception."
+    raise exc
+
+
+@raisefunction.overload(2)
+def raisefunction(exc: BaseException, cause: Optional[BaseException], /) -> None:
+    "This function raises the given exception with the given cause."
+    raise exc from cause

raisefunction-1.0.1/src/raisefunction/tests/test_0.py

@@ -0,0 +1,41 @@
+import unittest
+
+from raisefunction.core import raisefunction
+
+
+class TestRaiseFunction(unittest.TestCase):
+    def test_dispatcher_no_arguments(self):
+        """Test the dispatcher raises a TypeError with no arguments."""
+        with self.assertRaises(TypeError) as context:
+            raisefunction()
+        self.assertIn("requires at least 1 positional argument", str(context.exception))
+
+    def test_dispatcher_too_many_arguments(self):
+        """Test the dispatcher raises a TypeError with more than 2 arguments."""
+        with self.assertRaises(TypeError) as context:
+            raisefunction(1, 2, 3)
+        self.assertIn("takes at most 2 positional arguments", str(context.exception))
+
+    def test_raise_single_exception(self):
+        """Test the single exception raising overload."""
+        with self.assertRaises(ValueError):
+            raisefunction(ValueError("Test single exception"))
+
+    def test_raise_exception_with_cause(self):
+        """Test the exception raising overload with a cause."""
+        with self.assertRaises(ValueError) as context:
+            raisefunction(ValueError("Test exception"), TypeError("Cause exception"))
+        self.assertEqual(str(context.exception), "Test exception")
+        self.assertIsInstance(context.exception.__cause__, TypeError)
+        self.assertEqual(str(context.exception.__cause__), "Cause exception")
+
+    def test_invalid_arguments_in_overloads(self):
+        """Test invalid argument types raise appropriate errors."""
+        with self.assertRaises(TypeError):
+            raisefunction("not an exception")
+        with self.assertRaises(TypeError):
+            raisefunction("not an exception", "not a cause")
+
+
+if __name__ == "__main__":
+    unittest.main()

raisefunction-1.0.1/src/raisefunction/tests/test_1.py

@@ -0,0 +1,17 @@
+import unittest
+
+from raisefunction.core import raisefunction
+
+
+class TestRaiseFunction(unittest.TestCase):
+
+    def test_raise_exception_with_cause(self):
+        """Test the exception raising overload with a cause."""
+        with self.assertRaises(ValueError) as context:
+            raisefunction(ValueError("Test exception"), KeyError("Cause exception"))
+        self.assertEqual(str(context.exception), "Test exception")
+        self.assertIsInstance(context.exception.__cause__, KeyError)
+
+
+if __name__ == "__main__":
+    unittest.main()

{raisefunction-0.0.2.dev0 → raisefunction-1.0.1/src/raisefunction.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: raisefunction
-Version: 0.0.2.dev0
+Version: 1.0.1
 Summary: This project provides a function that raises errors passed to it.
 Author-email: Johannes <johannes-programming@mailfence.com>
 License: The MIT License (MIT)
@@ -28,7 +28,7 @@ Project-URL: Download, https://pypi.org/project/raisefunction/#files
 Project-URL: Index, https://pypi.org/project/raisefunction/
 Project-URL: Source, https://github.com/johannes-programming/raisefunction/
 Project-URL: Website, https://raisefunction.johannes-programming.online/
-Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
@@ -40,6 +40,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
+Requires-Dist: overloadable>=1.0.9
 
 =============
 raisefunction

{raisefunction-0.0.2.dev0 → raisefunction-1.0.1}/src/raisefunction.egg-info/SOURCES.txt

@@ -7,7 +7,9 @@ src/raisefunction/__init__.py
 src/raisefunction.egg-info/PKG-INFO
 src/raisefunction.egg-info/SOURCES.txt
 src/raisefunction.egg-info/dependency_links.txt
+src/raisefunction.egg-info/requires.txt
 src/raisefunction.egg-info/top_level.txt
 src/raisefunction/core/__init__.py
 src/raisefunction/tests/__init__.py
-src/raisefunction/tests/test_1984.py
+src/raisefunction/tests/test_0.py
+src/raisefunction/tests/test_1.py

raisefunction-1.0.1/src/raisefunction.egg-info/requires.txt

@@ -0,0 +1 @@
+overloadable>=1.0.9

raisefunction-0.0.2.dev0/src/raisefunction/core/__init__.py

@@ -1,6 +0,0 @@
-__all__ = ["raisefunction"]
-
-
-def raisefunction(error: BaseException, /) -> None:
-    "This function raises the error passed to it."
-    raise error

raisefunction-0.0.2.dev0/src/raisefunction/tests/test_1984.py

@@ -1,32 +0,0 @@
-import unittest
-
-from raisefunction.core import raisefunction
-
-
-class TestRaiseFunction(unittest.TestCase):
-
-    def test_raise_value_error(self):
-        """Test if raisefunction raises a ValueError as expected."""
-        with self.assertRaises(ValueError) as context:
-            raisefunction(ValueError("This is a ValueError"))
-        self.assertEqual(str(context.exception), "This is a ValueError")
-
-    def test_raise_type_error(self):
-        """Test if raisefunction raises a TypeError as expected."""
-        with self.assertRaises(TypeError) as context:
-            raisefunction(TypeError("This is a TypeError"))
-        self.assertEqual(str(context.exception), "This is a TypeError")
-
-    def test_raise_custom_exception(self):
-        """Test if raisefunction raises a custom exception as expected."""
-
-        class CustomError(Exception):
-            pass
-
-        with self.assertRaises(CustomError) as context:
-            raisefunction(CustomError("This is a CustomError"))
-        self.assertEqual(str(context.exception), "This is a CustomError")
-
-
-if __name__ == "__main__":
-    unittest.main()