raisefunction 1.0.4__tar.gz → 1.1.0__tar.gz

{raisefunction-1.0.4 → raisefunction-1.1.0}/LICENSE.txt

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

raisefunction-1.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include docs *.rst
+recursive-include src/raisefunction *.toml

{raisefunction-1.0.4/src/raisefunction.egg-info → raisefunction-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: raisefunction
-Version: 1.0.4
+Version: 1.1.0
 Summary: This project provides a function that raises errors passed to it.
 Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)
@@ -24,6 +24,7 @@ License: The MIT License (MIT)
         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.
+        
 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/
@@ -42,8 +43,10 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Dynamic: license-file
 
-=============
-raisefunction
-=============
+====
+v440
+====
 
-Visit the website `https://raisefunction.johannes-programming.online/ <https://raisefunction.johannes-programming.online/>`_ for more information.
+Each minor version has its own documentation.
+These docs can be found as rst-files in the ``docs/`` directory of this project.
+They can also be viewed on the website `https://raisefunction.johannes-programming.online/ <https://raisefunction.johannes-programming.online/>`_.

raisefunction-1.1.0/README.rst

@@ -0,0 +1,7 @@
+====
+v440
+====
+
+Each minor version has its own documentation.
+These docs can be found as rst-files in the ``docs/`` directory of this project.
+They can also be viewed on the website `https://raisefunction.johannes-programming.online/ <https://raisefunction.johannes-programming.online/>`_.

raisefunction-1.1.0/docs/v1.0.rst

@@ -0,0 +1,55 @@
+Introduction
+------------
+
+This project provides a function that raises errors passed to it.
+
+Installation
+------------
+
+To install ``raisefunction``, you can use ``pip``.
+Open your terminal and run:
+
+.. code-block:: shell
+
+    pip install raisefunction
+
+Features
+--------
+
+``raisefunction.raisefunction(exc: BaseException) -> Never`` ``raisefunction.raisefunction(exc: BaseException, cause: Optional[BaseException]) -> Never``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This function binds the raise command.
+
+``raisefunction.tests.test() -> unittest.TextTestResult``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project can be tested through its test function.
+
+.. code-block:: python
+
+    import raisefunction.tests
+    raisefunction.tests.test()
+
+License
+-------
+
+This project is licensed under the MIT License.
+
+Links
+-----
+
+- Download: https://pypi.org/project/raisefunction/#files
+- Index: https://pypi.org/project/raisefunction/
+- Source: https://github.com/johannes-programming/raisefunction/
+- Website: https://raisefunction.johannes-programming.online/
+
+Impressum
+---------
+
+**Johannes Programming**
+
+- Name: Johannes
+- Email: johannes.programming@gmail.com
+- Homepage: https://www.johannes-programming.online/
+- Gravatar: https://www.johannes-programming.fyi/

raisefunction-1.1.0/docs/v1.1.rst

@@ -0,0 +1,64 @@
+Introduction
+------------
+
+This project provides a function that raises errors passed to it.
+
+Installation
+------------
+
+To install ``raisefunction``, you can use ``pip``.
+Open your terminal and run:
+
+.. code-block:: shell
+
+    pip install raisefunction
+
+Typing
+------
+
+This project is strictly typed with ``mypy``.
+
+.. container:: versionadded
+
+    **Added in version 1.1.**
+
+Features
+--------
+
+``raisefunction.raisefunction(exc: BaseException) -> Never`` ``raisefunction.raisefunction(exc: BaseException, cause: Optional[BaseException]) -> Never``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This function binds the raise command.
+
+``raisefunction.tests.test() -> unittest.TextTestResult``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project can be tested through its test function.
+
+.. code-block:: python
+
+    import raisefunction.tests
+    raisefunction.tests.test()
+
+License
+-------
+
+This project is licensed under the MIT License.
+
+Links
+-----
+
+- Download: https://pypi.org/project/raisefunction/#files
+- Index: https://pypi.org/project/raisefunction/
+- Source: https://github.com/johannes-programming/raisefunction/
+- Website: https://raisefunction.johannes-programming.online/
+
+Impressum
+---------
+
+**Johannes Programming**
+
+- Name: Johannes
+- Email: johannes.programming@gmail.com
+- Homepage: https://www.johannes-programming.online/
+- Gravatar: https://www.johannes-programming.fyi/

{raisefunction-1.0.4 → raisefunction-1.1.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 build-backend = "setuptools.build_meta"
 requires = [
-    "setuptools>=64.0",
+    "setuptools>=77.0",
 ]
 
 [project]
@@ -25,7 +25,7 @@ keywords = []
 name = "raisefunction"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "1.0.4"
+version = "1.1.0"
 
 [project.license]
 file = "LICENSE.txt"
@@ -35,3 +35,10 @@ Download = "https://pypi.org/project/raisefunction/#files"
 Index = "https://pypi.org/project/raisefunction/"
 Source = "https://github.com/johannes-programming/raisefunction/"
 Website = "https://raisefunction.johannes-programming.online/"
+
+[tool.mypy]
+files = [
+    ".",
+]
+python_version = "3.11"
+strict = true

raisefunction-1.1.0/src/raisefunction/__init__.py

@@ -0,0 +1,2 @@
+from raisefunction.core import raisefunction
+from raisefunction.tests import test

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

@@ -0,0 +1,27 @@
+from typing import Final, Never, Optional, cast, overload
+
+__all__ = ["raisefunction"]
+
+DEFAULT: Final[object] = object()
+
+
+@overload
+def raisefunction(
+    exc: BaseException | type[BaseException],
+) -> Never: ...
+@overload
+def raisefunction(
+    exc: BaseException | type[BaseException],
+    cause: Optional[BaseException],
+) -> Never: ...
+
+
+def raisefunction(
+    exc: BaseException | type[BaseException],
+    cause: Optional[BaseException] | object = DEFAULT,
+) -> Never:
+    "This function raises the given exception."
+    if cause is DEFAULT:
+        raise exc
+    else:
+        raise exc from cast(Optional[BaseException], cause)

{raisefunction-1.0.4 → raisefunction-1.1.0}/src/raisefunction/tests/__init__.py

@@ -3,7 +3,7 @@ import unittest
 __all__ = ["test"]
 
 
-def test() -> unittest.TextTestRunner:
+def test() -> unittest.TextTestResult:
     "This function runs all the tests."
     loader: unittest.TestLoader
     tests: unittest.TestSuite

{raisefunction-1.0.4 → raisefunction-1.1.0}/src/raisefunction/tests/test_0.py

@@ -3,20 +3,20 @@ from typing import *
 
 from raisefunction.core import raisefunction
 
-__all__ = ["TestRaiseFunction"]
+__all__ = ["Test0"]
 
 
-class TestRaiseFunction(unittest.TestCase):
+class Test0(unittest.TestCase):
     def test_dispatcher_no_arguments(self: Self) -> None:
         "Test the dispatcher raises a TypeError with no arguments."
-        with self.assertRaises(TypeError) as context:
-            raisefunction()
+        with self.assertRaises(TypeError):
+            raisefunction()  # type: ignore[call-overload]
         # self.assertIn("requires at least 1 positional argument", str(context.exception))
 
     def test_dispatcher_too_many_arguments(self: Self) -> None:
         "Test the dispatcher raises a TypeError with more than 2 arguments."
-        with self.assertRaises(TypeError) as context:
-            raisefunction(1, 2, 3)
+        with self.assertRaises(TypeError):
+            raisefunction(1, 2, 3)  # type: ignore[call-overload]
         # self.assertIn("takes at most 2 positional arguments", str(context.exception))
 
     def test_raise_single_exception(self: Self) -> None:
@@ -24,10 +24,12 @@ class TestRaiseFunction(unittest.TestCase):
         with self.assertRaises(ValueError):
             raisefunction(ValueError("Test single exception"))
 
-    def test_raise_exception_with_cause(self: Self) -> None:
+    def test_raise_exception_with_cause_0(self: Self) -> None:
         "Test the exception raising overload with a cause."
         with self.assertRaises(ValueError) as context:
-            raisefunction(ValueError("Test exception"), TypeError("Cause exception"))
+            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")
@@ -35,14 +37,16 @@ class TestRaiseFunction(unittest.TestCase):
     def test_invalid_arguments_in_overloads(self: Self) -> None:
         "Test invalid argument types raise appropriate errors."
         with self.assertRaises(TypeError):
-            raisefunction("not an exception")
+            raisefunction("not an exception")  # type: ignore[call-overload]
         with self.assertRaises(TypeError):
-            raisefunction("not an exception", "not a cause")
+            raisefunction("not an exception", "not a cause")  # type: ignore[call-overload]
 
     def test_raise_exception_with_cause(self: Self) -> None:
         "Test the exception raising overload with a cause."
         with self.assertRaises(ValueError) as context:
-            raisefunction(ValueError("Test exception"), KeyError("Cause exception"))
+            raisefunction(
+                ValueError("Test exception"), KeyError("Cause exception")
+            )
         self.assertEqual(str(context.exception), "Test exception")
         self.assertIsInstance(context.exception.__cause__, KeyError)
 

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

@@ -0,0 +1,66 @@
+import unittest
+from typing import *
+
+from raisefunction import core
+
+__all__ = ["Test1"]
+
+
+class Test1(unittest.TestCase):
+    def test_raises_given_exception_instance_without_cause(self: Self) -> None:
+        exc: ValueError
+        exc = ValueError("boom")
+
+        with self.assertRaises(ValueError) as cm:
+            core.raisefunction(exc)
+
+        self.assertIs(cm.exception, exc)
+        # When no explicit cause is given, __cause__ is normally None
+        # and __context__ may or may not be set depending on context.
+        self.assertIsNone(cm.exception.__cause__)
+
+    def test_raises_given_exception_class_without_cause(self: Self) -> None:
+        # Using a class mirrors: raise ValueError
+        with self.assertRaises(ValueError) as cm:
+            core.raisefunction(ValueError)
+        self.assertIsInstance(cm.exception, ValueError)
+        self.assertIsNone(cm.exception.__cause__)
+
+    def test_raises_with_explicit_cause(self: Self) -> None:
+        cause: RuntimeError
+        exc: ValueError
+        cause = RuntimeError("original")
+        exc = ValueError("wrapped")
+
+        with self.assertRaises(ValueError) as cm:
+            core.raisefunction(exc, cause)
+
+        self.assertIs(cm.exception.__cause__, cause)
+
+    def test_raises_with_suppressed_context_when_cause_is_none(
+        self: Self,
+    ) -> None:
+        exc: ValueError
+        exc = ValueError("no context")
+
+        # Explicit `from None` should result in __cause__ being None,
+        # and suppress linking to any active exception.
+        with self.assertRaises(ValueError) as cm:
+            core.raisefunction(exc, None)
+
+        self.assertIsNone(cm.exception.__cause__)
+
+    def test_raising_class_that_requires_args_produces_type_error(
+        self: Self,
+    ) -> None:
+        class NeedsArg(Exception):
+            def __init__(self: Self, msg: str) -> None:
+                super().__init__(msg)
+
+        # This mirrors normal `raise NeedsArg` behaviour
+        with self.assertRaises(TypeError):
+            core.raisefunction(NeedsArg)
+
+
+if __name__ == "__main__":
+    unittest.main()

raisefunction-1.1.0/src/raisefunction/tests/test_2.py

@@ -0,0 +1,78 @@
+import unittest
+from typing import *
+
+from raisefunction import core
+
+__all__ = ["Test2"]
+
+
+class Test2(unittest.TestCase):
+    def test_raises_given_exception_instance_without_cause(self: Self) -> None:
+        cm: Any
+        exc: ValueError
+        exc = ValueError("boom")
+
+        with self.assertRaises(ValueError) as cm:
+            core.raisefunction(exc)
+
+        self.assertIs(cm.exception, exc)
+        # When no explicit cause is given, __cause__ is normally None.
+        # __context__ may or may not be set depending on context.
+        self.assertIsNone(cm.exception.__cause__)
+
+    def test_raises_given_exception_class_without_cause(self: Self) -> None:
+        cm: Any
+        with self.assertRaises(ValueError) as cm:
+            core.raisefunction(ValueError)
+
+        self.assertIsInstance(cm.exception, ValueError)
+        self.assertIsNone(cm.exception.__cause__)
+
+    def test_raises_with_explicit_cause(self: Self) -> None:
+        cause: RuntimeError
+        cm: Any
+        exc: ValueError
+        cause = RuntimeError("original")
+        exc = ValueError("wrapped")
+
+        with self.assertRaises(ValueError) as cm:
+            core.raisefunction(exc, cause)
+
+        self.assertIs(cm.exception.__cause__, cause)
+
+    def test_raise_from_None(self: Self) -> None:
+        cm: Any
+        exc: ValueError
+        one: int
+        zero: int
+
+        exc = ValueError("no context")
+        with self.assertRaises(ValueError) as cm:
+            try:
+                # Create a real context exception
+                one = 1
+                zero = 0
+                one / zero
+            except ZeroDivisionError:
+                raise exc from None
+        self.assertIsNone(cm.exception.__cause__)
+        self.assertIsInstance(cm.exception.__context__, ZeroDivisionError)
+        self.assertTrue(cm.exception.__suppress_context__)
+
+    def test_raising_class_that_requires_args_produces_type_error(
+        self: Self,
+    ) -> None:
+        class NeedsArg(Exception):
+            def __init__(self: Self, msg: str) -> None:
+                super().__init__(msg)
+
+        cm: Any
+        with self.assertRaises(TypeError) as cm:
+            core.raisefunction(NeedsArg)
+
+        # Optional: sanity check on the error type/message
+        self.assertIsInstance(cm.exception, TypeError)
+
+
+if __name__ == "__main__":
+    unittest.main()

raisefunction-1.1.0/src/raisefunction/tests/test_3.py

@@ -0,0 +1,42 @@
+import unittest
+from typing import *
+
+from raisefunction import core
+
+__all__ = ["Test3"]
+
+
+class Test3(unittest.TestCase):
+
+    def go(self: Self, *, use_func: bool) -> None:
+        cm: Any
+        exc: ValueError
+        exc = ValueError("no context")
+        with self.assertRaises(ValueError) as cm:
+            self.go_with(use_func=use_func, exc=exc)
+        self.assertIsNone(cm.exception.__cause__)
+        self.assertIsInstance(cm.exception.__context__, ZeroDivisionError)
+        self.assertTrue(cm.exception.__suppress_context__)
+
+    def go_with(self: Self, *, use_func: bool, exc: Exception) -> None:
+        one: int
+        zero: int
+        try:
+            # Create a real context exception
+            one = 1
+            zero = 0
+            one / zero
+        except ZeroDivisionError:
+            # This should behave like: raise exc from None
+            if use_func:
+                core.raisefunction(exc, None)
+            else:
+                raise exc from None
+
+    def test_raise_from_None(self: Self) -> None:
+        self.go(use_func=False)
+        self.go(use_func=True)
+
+
+if __name__ == "__main__":
+    unittest.main()

{raisefunction-1.0.4 → raisefunction-1.1.0/src/raisefunction.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: raisefunction
-Version: 1.0.4
+Version: 1.1.0
 Summary: This project provides a function that raises errors passed to it.
 Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)
@@ -24,6 +24,7 @@ License: The MIT License (MIT)
         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.
+        
 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/
@@ -42,8 +43,10 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Dynamic: license-file
 
-=============
-raisefunction
-=============
+====
+v440
+====
 
-Visit the website `https://raisefunction.johannes-programming.online/ <https://raisefunction.johannes-programming.online/>`_ for more information.
+Each minor version has its own documentation.
+These docs can be found as rst-files in the ``docs/`` directory of this project.
+They can also be viewed on the website `https://raisefunction.johannes-programming.online/ <https://raisefunction.johannes-programming.online/>`_.

{raisefunction-1.0.4 → raisefunction-1.1.0}/src/raisefunction.egg-info/SOURCES.txt

@@ -3,11 +3,17 @@ MANIFEST.in
 README.rst
 pyproject.toml
 setup.cfg
+docs/v1.0.rst
+docs/v1.1.rst
 src/raisefunction/__init__.py
+src/raisefunction/py.typed
 src/raisefunction.egg-info/PKG-INFO
 src/raisefunction.egg-info/SOURCES.txt
 src/raisefunction.egg-info/dependency_links.txt
 src/raisefunction.egg-info/top_level.txt
 src/raisefunction/core/__init__.py
 src/raisefunction/tests/__init__.py
-src/raisefunction/tests/test_0.py
+src/raisefunction/tests/test_0.py
+src/raisefunction/tests/test_1.py
+src/raisefunction/tests/test_2.py
+src/raisefunction/tests/test_3.py

raisefunction-1.0.4/README.rst

@@ -1,5 +0,0 @@
-=============
-raisefunction
-=============
-
-Visit the website `https://raisefunction.johannes-programming.online/ <https://raisefunction.johannes-programming.online/>`_ for more information.

raisefunction-1.0.4/src/raisefunction/__init__.py

@@ -1,5 +0,0 @@
-from raisefunction.core import *
-from raisefunction.tests import *
-
-if __name__ == "__main__":
-    main()

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

@@ -1,22 +0,0 @@
-from typing import *
-
-__all__ = ["raisefunction"]
-
-DEFAULT = object()
-
-
-@overload
-def raisefunction(exc: BaseException) -> None: ...
-@overload
-def raisefunction(exc: BaseException, cause: Optional[BaseException]) -> None: ...
-
-
-def raisefunction(
-    exc: BaseException,
-    cause: Optional[BaseException] | object = DEFAULT,
-) -> Never:
-    "This function raises the given exception."
-    if cause is DEFAULT:
-        raise exc
-    else:
-        raise exc from cause