Passing before error bubble-up

Author: mzecc

Makefile

@@ -53,7 +53,7 @@ test:  ## run the tests (re-installs the package every time so you might want to
 	uv run --no-sync python -c 'from pathlib import Path; import example_fgen_basic' || ( echo "Run make virtual-environment first" && false )
 	COV_DIR=$$(uv run --no-sync python -c 'from pathlib import Path; import example_fgen_basic; print(Path(example_fgen_basic.__file__).parent)'); \
 		uv run --no-editable --reinstall-package example-fgen-basic pytest -s -r a -v tests src --doctest-modules --doctest-report ndiff --cov=$$COV_DIR
-		# uv run --no-editable --reinstall-package example-fgen-basic pytest -s -r a -v tests/unit/test_get_square_root.py src --doctest-modules --doctest-report ndiff --cov=$$COV_DIR
+	# uv run --no-editable --reinstall-package example-fgen-basic pytest -s -r a -v tests/unit/test_get_square_root.py src --doctest-modules --doctest-report ndiff --cov=$$COV_DIR
 
 # Note on code coverage and testing:
 # You must specify cov=src.

fortitude.toml

@@ -5,5 +5,6 @@
 select = [ "C", "E", "S", "PORT" ]
 #Ignoring:
 # C003:	'implicit none' missing 'external'  [f2py does not recognize the syntax implicit none(type, external)]
-ignore = ["C003","C072","S221"]
+# ignore = ["C003","C072","S221"]
+ignore = ["C003"]
 line-length = 120

src/example_fgen_basic/error_v/error_v.f90

@@ -30,8 +30,8 @@ module m_error_v
         ! (means you can stop but also unwind errors and traceback along the way)
 
         ! TODO: think about adding trace (might be simpler than compiling with traceback)
-!         class(ErrorV), allocatable :: cause
-        type(ErrorV), pointer :: cause => null()
+!        class(ErrorV), allocatable :: cause
+         type(ErrorV), pointer :: cause => null()
 
     contains
 
@@ -141,6 +141,41 @@ subroutine build(self, code, message, cause)
         end if
 
     end subroutine build
+!    subroutine build(self, code, message, cause)
+!        !! Build instance
+!
+!        class(ErrorV), intent(out) :: self
+!        ! Hopefully can leave without docstring (like Python)
+!
+!        integer, intent(in) :: code
+!        !! Error code
+!        !!
+!        !! Use [TODO: figure out xref] `NO_ERROR_CODE` if there is no error
+!
+!        character(len=*), optional, intent(in) :: message
+!        !! Error message
+!        type(ErrorV), target, optional, intent(in) :: cause
+!
+!        self % code = code
+!
+!        if (present(cause)) then
+! !            self % cause => cause
+! !            allocate(self % cause)
+! !            call self%cause%build(cause%code, cause%message, cause%cause)
+! !            self%cause = cause
+!            if (present(message)) then
+!                self % message = adjustl(trim(message)) // " --> Cause: " // cause % message
+!            else
+!                self % message = " --> Cause: " // cause % message
+!            end if
+!
+!        else
+!            if (present(message)) then
+!                self % message = adjustl(trim(message))
+!            end if
+!        end if
+!
+!    end subroutine build
 
     subroutine finalise(self)
         !! Finalise the instance (i.e. free/deallocate)
@@ -153,7 +188,8 @@ subroutine finalise(self)
         if (allocated(self%message)) deallocate(self%message)
         ! MZ when the object is finalized or goes out of scope, its pointer components are destroyed.
         ! Hopefully no shared ownership??
-        if (associated(self%cause)) nullify(self%cause)
+         if (associated(self%cause)) nullify(self%cause)
+!        if (allocated(self%cause)) deallocate(self%cause)
 
     end subroutine finalise
 

src/example_fgen_basic/get_square_root.f90

@@ -17,6 +17,8 @@ function get_square_root(inv) result(res)
 
         real(kind=dp), intent(in) :: inv
         !! Frequency
+        character(len=:), allocatable :: msg
+        character(len=10) :: input_char
 
         type(ResultGen) :: res
         !! Result
@@ -25,10 +27,12 @@ function get_square_root(inv) result(res)
         !! Error otherwise.
 
         if (inv >= 0) then
-            res = ResultGen(tag=T_DP,data_dp=sqrt(inv))
+            call res % build(tag=T_DP,data_dp=sqrt(inv))
         else
-            ! TODO: include input value in the message
-            res = ResultGen(tag=T_ERR,error_v=ErrorV(code=1, message="Input value was negative"))
+            write(input_char, "(F9.3)") inv
+            msg = adjustl(trim("Error: Negative Input -> "// adjustl(trim(input_char))))
+
+            call res % build(tag=T_ERR,error_v=ErrorV(code=1, message=msg))
         end if
 
     end function get_square_root

src/example_fgen_basic/get_square_root.py

@@ -47,12 +47,11 @@ def get_square_root(inv: float) -> float:
         TODO: use a more specific error
     """
     result_instance_index: int = m_get_square_root_w.get_square_root(inv)
-
     result = ResultGen.from_instance_index(result_instance_index)
 
     if result.error_v is not None:
         # TODO: be more specific
-        m_result_w.finalise_instance(result_instance_index)
+        # m_result_w.finalise_instance(result_instance_index)
         raise FortranError(result.error_v.message)
         # raise LessThanZeroError(result.error_v.message)
 

src/example_fgen_basic/get_square_root_wrapper.f90

@@ -1,7 +1,7 @@
 !> Wrapper for interfacing `m_get_square_root` with python
 module m_get_square_root_w
 
-    use m_result_gen, only: ResultGen
+    use m_result_gen, only: ResultGen,T_ERR
 
     use m_get_square_root, only: o_get_square_root => get_square_root
 
@@ -50,6 +50,12 @@ function get_square_root(inv) result(res_instance_index)
         ! ready for its attributes to be retrieved from Python.
         ! MZ it would be probably good to check "res_chk" for errors
         ! res_chk = result_dp_manager_set_instance_index_to(res_instance_index, res)
+        if (res%tag == T_ERR) then
+            call result_manager_set_instance_index_to(instance_index=res_instance_index,&
+                 error_v=res%error_v, res_check = res_chk)
+            return
+        end if
+
         call result_manager_set_instance_index_to(instance_index=res_instance_index,&
                  data_dp=res%data_dp, res_check = res_chk)
 

src/example_fgen_basic/result/result_gen.py

@@ -29,36 +29,39 @@ class ResultGen:
     error_v: ErrorV | None
     """Error"""
 
+    """
+    Parameters:
+    """
+    __fs_int = m_result_w.s_int
+    __fs_dp = m_result_w.s_dp
+    __fs_err = m_result_w.s_err
+
     @classmethod
     def from_instance_index(cls, instance_index: int) -> ResultGen:
         """
         Initialise from an instance index received from Fortran
 
         Parameters
         ----------
-        intance_index
+        instance_index
            Instance index received form Fortran
 
         Returns
         -------
         :
            Initalised index
         """
-        T_INT = 1
-        T_DP = 2
-        T_ERR = 3
-
         tag = m_result_w.get_instance_tag(instance_index)
 
-        if tag == T_INT:
+        if tag == cls.__fs_int:
             data_v: int | None = m_result_w.get_data_int(instance_index)
             error_v = None
 
-        elif tag == T_DP:
+        elif tag == cls.__fs_dp:
             data_v: float | None = m_result_w.get_data_dp(instance_index)
             error_v = None
 
-        elif tag == T_ERR:
+        elif tag == cls.__fs_err:
             data_v = None
             error_tuple: tuple[int | None, str | None] = m_result_w.get_error(
                 instance_index

src/example_fgen_basic/result/result_manager.f90

@@ -16,7 +16,7 @@ module m_result_manager
 
 contains
 
-  subroutine build_instance(tag, data_int, data_dp, error_v, instance_index,res_check)
+  subroutine build_instance(tag, data_int, data_dp, error_v, instance_index, res_check)
 
     integer, intent(in) :: tag
     integer(kind=i8),optional, intent(in) :: data_int

src/example_fgen_basic/result/result_wrapper.f90

@@ -24,8 +24,10 @@ module m_result_w
   private
 
   public :: build_instance_int, build_instance_dp, build_instance_err,&
-            get_instance_tag, get_data_int, get_data_dp, &
-            finalise_instance, finalise_instances
+            finalise_instance, finalise_instances, &
+            get_instance_tag, get_data_int, get_data_dp, get_error
+
+  integer, parameter, public :: s_claimed=T_CLAIM, s_none=T_NONE, s_int=T_INT, s_dp=T_DP, s_err=T_ERR
 
 contains
 
@@ -94,6 +96,9 @@ function build_instance_err(error_v_instance_index) result(instance_index)
 
     type(ErrorV) :: error_v
     type(ResultGen) :: res_check
+!    integer :: code
+!    character(len=10) :: int2char
+!    character(len=:), allocatable :: message
 
     if (error_v_instance_index > 0) then
 
@@ -109,8 +114,13 @@ function build_instance_err(error_v_instance_index) result(instance_index)
 
     else
 
-      ! maybe generate an error
-      print *, "Provided code does NOT match any ERROR type"
+      call error_v % build(code = 1, message = "Provided code does NOT match any ERROR type")
+      call result_manager_build_instance(&
+        tag = T_ERR, &
+        error_v = error_v, &
+        instance_index= instance_index,&
+        res_check = res_check &
+        )
 
     end if
 
@@ -150,12 +160,6 @@ function get_data_int(instance_index) result(data_int)
 
     res_stored = result_manager_get_instance(instance_index)
 
-    if(res_stored % tag /= T_INT) then
-      ! ERROR in a smarter way
-      print *, "TAG type does not match the expected type"
-      return
-    end if
-
     data_int = res_stored % data_int
 
   end function get_data_int
@@ -170,14 +174,7 @@ function get_data_dp(instance_index) result(data_dp)
 
     res_stored = result_manager_get_instance(instance_index)
 
-    ! Think if it is worth checking
-    if(res_stored % tag /= T_DP) then
-      ! ERROR in a smarter way
-      print *, "TAG type does not match the expected type"
-      return
-    end if
-
-    data_dp = res_stored% data_dp
+    data_dp = res_stored % data_dp
 
   end function get_data_dp
 
@@ -186,15 +183,21 @@ subroutine get_error(instance_index,code,message)
 
     integer, intent(in) :: instance_index
     integer, intent(out) :: code
-    character(len=*), intent(out) :: message
+    ! MZ: How to avoid long fixed length??
+    character(len=1000), intent(out) :: message
+    character(len=10) :: int2char
     type(ResultGen) :: res_stored
 
     res_stored = result_manager_get_instance(instance_index)
 
-    ! Think if it is worth checking
+    ! Think if it is worth checking as the Python side should already deal with it. Should be built an error?
     if(res_stored % tag /= T_ERR) then
-      ! ERROR in a smarter way
-      print *, "TAG type does not match the expected type"
+      ! ERROR in a smarter way?
+      code = 1
+      write(int2char,"(I0)") instance_index
+      message = "TAG mismatch! Expected -> ERROR but index: " // adjustl(trim(int2char))
+      write(int2char,"(I0)") res_stored % tag
+      message = adjustl(trim(message)) // " has TAG = " // adjustl(trim(int2char))
       return
     end if
 

tests/unit/test_get_square_root.py

@@ -5,13 +5,20 @@
 import pytest
 
 from example_fgen_basic.get_square_root import get_square_root
+from example_fgen_basic.pyfgen_runtime.exceptions import (
+    FortranError,
+)
 
 
 @pytest.mark.parametrize(
     "inv, exp, exp_error",
     [
         (4.0, 2.0, None),
-        # (-4.0, None, pytest.raises(FortranError, match="Input value was negative")),
+        (
+            -4.0,
+            None,
+            pytest.raises(FortranError, match="Error: Negative Input -> -4.000"),
+        ),
     ],
 )
 def test_basic(inv, exp, exp_error):