python entrypoints return (success: bool, message: str)

Author: jcschaff

libvcell/__init__.py

@@ -0,0 +1,6 @@
+from libvcell.solver_utils import vcml_to_finite_volume_input, sbml_to_finite_volume_input
+
+__all__ = [
+    "vcml_to_finite_volume_input",
+    "sbml_to_finite_volume_input"
+]

libvcell/libvcell.py

@@ -0,0 +1,14 @@
+from pathlib import Path
+
+from libvcell._internal.native_calls import ReturnValue, VCellNativeCalls
+
+
+def vcml_to_finite_volume_input(vcml_content: str, simulation_name: str, output_dir_path: Path) -> (bool, str):
+    native = VCellNativeCalls()
+    return_value: ReturnValue = native.vcml_to_finite_volume_input(vcml_content, simulation_name, output_dir_path)
+    return return_value.success, return_value.message
+
+def sbml_to_finite_volume_input(sbml_content: str, output_dir_path: Path) -> (bool, str):
+    native = VCellNativeCalls()
+    return_value: ReturnValue = native.sbml_to_finite_volume_input(sbml_content, output_dir_path)
+    return return_value.success, return_value.message

libvcell/solver_utils.py

@@ -1,17 +1,21 @@
 from pathlib import Path
 
-from libvcell.libvcell import libvcell
+from libvcell import vcml_to_finite_volume_input, sbml_to_finite_volume_input
 
 
 def test_vcml_to_finite_volume_input(temp_output_dir: Path, vcml_file_path: Path, vcml_sim_name: str) -> None:
     vcml_content = vcml_file_path.read_text()
-    libvcell.vcml_to_finite_volume_input(
+    success, msg = vcml_to_finite_volume_input(
         vcml_content=vcml_content, simulation_name=vcml_sim_name, output_dir_path=temp_output_dir
     )
     assert len(list(temp_output_dir.iterdir())) > 0
+    assert success is True
+    assert msg == "Success"
 
 
 def test_sbml_to_finite_volume_input(temp_output_dir: Path, sbml_file_path: Path, vcml_sim_name: str) -> None:
     sbml_content = sbml_file_path.read_text()
-    libvcell.sbml_to_finite_volume_input(sbml_content=sbml_content, output_dir_path=temp_output_dir)
+    success, msg = sbml_to_finite_volume_input(sbml_content=sbml_content, output_dir_path=temp_output_dir)
     assert len(list(temp_output_dir.iterdir())) > 0
+    assert success is True
+    assert msg == "Success"