refactor: change raised() method to raises()

Author: ScottBoyce

ResultContainer/ResultContainer.py

@@ -24,7 +24,7 @@
 
 Error Handling:
     - The `ResultErr` class captures error messages, codes, and optional traceback information.
-    - Errors only raise an exception when requested (`expect` or `raised` methods).
+    - Errors only raise an exception when requested (`expect` or `raises` methods).
 
 Constructors:
     Result(value, success=True, error_msg="", error_code=1, error_code_group=1):
@@ -185,7 +185,7 @@
     "Err_msg",
     "Err_code",
     "Err_traceback",
-    "raised",
+    "raises",
     "expect",
     "expect_Err",
     "unwrap",
@@ -427,7 +427,7 @@ class ResultErr(Exception):
         error                     (bool): Returns true if in error status (ie, size > 0).
 
     Methods:
-        raised(note=""):
+        raises(note=""):
             Raise a ResultErr exception if error messages exist
             and optionally add the note to the end of exception.
 
@@ -469,23 +469,23 @@ class ResultErr(Exception):
         >>> err = ResultErr()              # empty error
         >>> print(err.error)
         False
-        >>> err.raised()                   # Nothing happens
+        >>> err.raises()                   # Nothing happens
         >>>
         >>> err.append("bad input")
-        >>> err.raised()                   # program terminates
+        >>> err.raises()                   # program terminates
         ResultErr: bad input
 
         >>> err = ResultErr("bad input")   # Initialized with an error
         >>> print(err.error)
         True
-        >>> err.raised()                   # program terminals
+        >>> err.raises()                   # program terminals
         ResultErr: bad input
 
         >>> err = ResultErr("bad input 1") # Initialized with an error
         >>> err.append("bad input 2")      # Second error message
         >>> print(err.error)
         True
-        >>> err.raised()                   # program terminates
+        >>> err.raises()                   # program terminates
         ResultErr:
         bad input 1
         bad input 2
@@ -618,7 +618,7 @@ def error_code_description(self, description=None, error_code_group=None):
             return self.__class__._error_codes[g]
         return self.__class__._error_codes[g][description]
 
-    def raised(self, note=""):
+    def raises(self, note=""):
         """
         Raise a ResultErr exception if there are error messages.
 
@@ -631,7 +631,7 @@ def raised(self, note=""):
             raise self
 
     def expect(self, error_msg=""):
-        self.raised(error_msg)
+        self.raises(error_msg)
         return ResultErr()
 
     def unwrap(self, *args, **kwargs):
@@ -858,7 +858,7 @@ class Result:
             If  Ok variant, then raise ResultErr(ok_msg);
             If Err variant, then returns error in Err(error), which is type ResultErr.
 
-        raised(error_msg="", exception=None):
+        raises(error_msg="", exception=None):
             If  Ok variant, then returns Ok(value);
             If Err variant, then raise Err and optionally include `from exception`.
             Useful for check during chained operations
@@ -1075,7 +1075,7 @@ def expect_Err(self, ok_msg="", error_code=5):  # 5 -> ResultErr.error_code("Exp
         err.append(ok_msg, add_traceback=False)
         raise ResultErr(err)
 
-    def raised(self, error_msg="", exception: Exception = None):
+    def raises(self, error_msg="", exception: Exception = None):
         self._empty_error()
         if not self._success:
             if error_msg != "":
@@ -1371,14 +1371,14 @@ def method(*args, **kwargs):
                         res = attr(*args, **kwargs)
                         return Result(res) if res is not None else None
                     except Exception as e:
-                        return Result.Err(f"VAR.{name}() raised {e}", self.error_code("Method"), self._g)
+                        return Result.Err(f"VAR.{name}() raises {e}", self.error_code("Method"), self._g)
 
                 return method
             if isinstance(attr, Result):
                 return attr
             return Result(attr)
         except AttributeError:
-            self.add_Err_msg(f"VAR.{name} raised an AttributeError", self.error_code("Attribute"))
+            self.add_Err_msg(f"VAR.{name} raises an AttributeError", self.error_code("Attribute"))
             return self
 
     def __iter__(self):

tests/test_advanced.py

@@ -24,7 +24,7 @@ def test_result_err_initialization():
         result.expect()
 
     with pytest.raises(ResultErr):
-        result.raised()
+        result.raises()
 
 
 # Edge Case Initialization
@@ -33,7 +33,7 @@ def test_result_ok_with_none():
     assert result.is_Ok is True
     assert result.unwrap() is None
     assert result.expect() is None
-    assert result.raised() == Ok(None)
+    assert result.raises() == Ok(None)
 
 
 def test_result_err_with_empty_string():
@@ -44,7 +44,7 @@ def test_result_err_with_empty_string():
         result.expect()
 
     with pytest.raises(ResultErr):
-        result.raised()
+        result.raises()
 
 
 # Iter Tests
@@ -111,12 +111,12 @@ def test_result_apply():
         error_result.expect()
 
     with pytest.raises(ResultErr):
-        error_result.raised()
+        error_result.raises()
 
     with pytest.raises(ResultErr):
         # apply returns Err for bad function
         mapped_result = Ok(0).apply(lambda x: 10 / x)
-        mapped_result.raised()
+        mapped_result.raises()
 
 
 def test_result_map():
@@ -132,7 +132,7 @@ def test_result_map():
         error_result.expect()
 
     with pytest.raises(ResultErr):
-        error_result.raised()
+        error_result.raises()
 
     with pytest.raises(ZeroDivisionError):
         # map raises exception for bad function
@@ -205,7 +205,7 @@ def test_result_apply_chain():
             .apply(lambda x: Result.Ok(x * 0))  # Ok(40)
             .apply(lambda x: Result.Ok(10 / x))  # Raises ZeroDiv Error
             .apply(lambda x: Result.Ok(x + 1))  # Appends to error message
-            .raised()  # Raises Exception if in Err state
+            .raises()  # Raises Exception if in Err state
         )
 
 
@@ -255,7 +255,7 @@ def test_division_by_zero():
     zero_result = Ok(0)
     with pytest.raises(ResultErr):
         ans = result / zero_result
-        ans.raised()
+        ans.raises()
 
 
 def test_modulo():
@@ -299,7 +299,7 @@ def test_error_message_integrity():
     result = Err(error_message)
     assert result.Err_msg == ["Critical Error"]
     with pytest.raises(ResultErr):
-        result.raised()
+        result.raises()
 
 
 def test_error_chaining_integrity():

tests/test_basic.py

@@ -81,10 +81,10 @@ def test_resulterr_append():
 
 
 # Test for ResultErr raised
-def test_resulterr_raised():
-    err = ResultErr("This is a raised error", code=500)
+def test_resulterr_raises():
+    err = ResultErr("This is a raises error", code=500)
     with pytest.raises(ResultErr):
-        err.raised()
+        err.raises()
 
 
 # Test for expect() with Ok result