added get_log_basename to process API

moptipy/api/_process_base.py

@@ -311,6 +311,14 @@ def _after_init(self) -> None:
         if self.__timer is not None:
             self.__timer.start()
 
+    def get_log_basename(self) -> str | None:
+        lf: Final[str | None] = self.__log_file
+        if lf is None:
+            return None
+        lid = lf.rfind(".")
+        lis = lf.rfind("/")
+        return lf[:lid] if (lid > 0) and (lid > lis) else lf
+
     def get_random(self) -> Generator:
         return self.__random
 

moptipy/api/execution.py

@@ -397,5 +397,7 @@ def execute(self) -> Process:
             algorithm.solve(process)  # apply the algorithm
         except Exception as be:
             # noinspection PyProtectedMember
-            process._caught = be
+            if process._caught is None:
+                # noinspection PyProtectedMember
+                process._caught = be
         return process

moptipy/api/process.py

@@ -446,6 +446,24 @@ def add_log_section(self, title: str, text: str) -> None:
         :param text: the text to log
         """
 
+    def get_log_basename(self) -> str | None:
+        """
+        Get the basename of the log, if any.
+
+        If a log file is associated with this process, then this function
+        returns the name of the log file without the file suffix. If no log
+        file is associated with the process, then `None` is returned.
+
+        This can be used to store additional information during the run of
+        the optimization algorithm. However, treat this carefully, as some
+        files with the same base name may exist or be generated by other
+        modules.
+
+        :returns: the path to the log file without the file suffix if a log
+            file is associated with the process, or `None` otherwise
+        """
+        return None
+
     def initialize(self) -> None:
         """
         Raise an error because this method shall never be called.

moptipy/version.py

@@ -2,4 +2,4 @@
 from typing import Final
 
 #: the version string of `moptipy`
-__version__: Final[str] = "0.9.96"
+__version__: Final[str] = "0.9.97"

tests/api/test_mo_process_no_ss.py

@@ -51,6 +51,7 @@ def test_mo_process_no_ss_no_log() -> None:
             .set_algorithm(algorithm)\
             .set_max_fes(100)\
             .execute() as process:
+        assert process.get_log_basename() is None
         assert isinstance(process, MOProcess)
         assert type_name_of(process) \
                == "moptipy.api._mo_process_no_ss._MOProcessNoSS"
@@ -114,6 +115,7 @@ def test_mo_process_no_ss_log() -> None:
                 .set_log_file(tf)\
                 .execute() as process:
             assert isinstance(process, MOProcess)
+            assert process.get_log_basename() is not None
             assert type_name_of(process) \
                    == "moptipy.api._mo_process_no_ss._MOProcessNoSS"
             assert str(process) == "MOProcessWithoutSearchSpace"

tests/api/test_mo_process_no_ss_log.py

@@ -45,6 +45,10 @@ def test_mo_process_no_ss_log() -> None:
         assert exists(tf)
         assert isfile(tf)
 
+        lid = tf.rfind(".")
+        lis = tf.rfind("/")
+        tfn: str = tf[:lid] if (lid > 0) and (lid > lis) else tf
+
         archive_len: int
         with MOExecution() \
                 .set_solution_space(space) \
@@ -57,6 +61,7 @@ def test_mo_process_no_ss_log() -> None:
                 .set_log_file(tf)\
                 .set_log_improvements(True)\
                 .execute() as process:
+            assert process.get_log_basename() == tfn
             assert isinstance(process, MOProcess)
             assert type_name_of(process) \
                    == "moptipy.api._mo_process_no_ss_log._MOProcessNoSSLog"

tests/api/test_mo_process_ss.py

@@ -56,6 +56,7 @@ def test_mo_process_mo_ss_no_log() -> None:
             .set_max_fes(100)\
             .set_archive_max_size(ams)\
             .execute() as process:
+        assert process.get_log_basename() is None
         assert type_name_of(process) \
                == "moptipy.api._mo_process_ss._MOProcessSS"
         assert str(process) == "MOProcessWithSearchSpace"
@@ -121,6 +122,7 @@ def test_mo_process_ss_log() -> None:
                    + ((f1.upper_bound() + 1) * (1 + f0.upper_bound()))
             assert 0 < process.get_consumed_fes() <= 100
             assert process.has_log()
+            assert process.get_log_basename() is not None
             archive: list[MORecord] = process.get_archive()
             for rec in archive:
                 assert f0.lower_bound() <= rec.fs[0] <= f0.upper_bound()

tests/api/test_mo_process_ss_log.py

@@ -162,6 +162,9 @@ def test_process_ss_log_all() -> None:
     with TempFile.create(suffix=FILE_SUFFIX) as tf:
         assert exists(tf)
         assert isfile(tf)
+        lid = tf.rfind(".")
+        lis = tf.rfind("/")
+        tfn: str = tf[:lid] if (lid > 0) and (lid > lis) else tf
         archive_len: int
         with MOExecution()\
                 .set_search_space(search_space)\
@@ -173,6 +176,7 @@ def test_process_ss_log_all() -> None:
                 .set_log_file(tf)\
                 .set_log_all_fes(True)\
                 .execute() as process:
+            assert process.get_log_basename() == tfn
             assert type_name_of(process) \
                    == "moptipy.api._mo_process_ss_log._MOProcessSSLog"
             assert str(process) == "MOLoggingProcessWithSearchSpace"

tests/api/test_process_no_ss.py

@@ -38,6 +38,7 @@ def test_process_no_ss_no_log() -> None:
             .set_algorithm(algorithm)\
             .set_max_fes(100)\
             .execute() as process:
+        assert process.get_log_basename() is None
         assert type_name_of(process) \
                == "moptipy.api._process_no_ss._ProcessNoSS"
         assert str(process) == "ProcessWithoutSearchSpace"
@@ -73,6 +74,7 @@ def test_process_no_ss_log() -> None:
                 .set_max_time_millis(20)\
                 .set_log_file(tf)\
                 .execute() as process:
+            assert process.get_log_basename() is not None
             assert type_name_of(process) \
                    == "moptipy.api._process_no_ss._ProcessNoSS"
             assert str(process) == "ProcessWithoutSearchSpace"

tests/api/test_process_no_ss_log.py

@@ -35,6 +35,10 @@ def test_process_no_ss_log_log() -> None:
         assert exists(tf)
         assert isfile(tf)
 
+        lid = tf.rfind(".")
+        lis = tf.rfind("/")
+        tfn: str = tf[:lid] if (lid > 0) and (lid > lis) else tf
+
         with Execution()\
                 .set_solution_space(space)\
                 .set_objective(objective)\
@@ -45,6 +49,7 @@ def test_process_no_ss_log_log() -> None:
                 .set_log_file(tf)\
                 .set_log_improvements(True) \
                 .execute() as process:
+            assert process.get_log_basename() == tfn
             assert type_name_of(process) \
                    == "moptipy.api._process_no_ss_log._ProcessNoSSLog"
             assert str(process) == "LoggingProcessWithoutSearchSpace"

tests/api/test_process_ss.py

@@ -46,6 +46,7 @@ def test_process_ss_no_log() -> None:
                == "moptipy.api._process_ss._ProcessSS"
         assert str(process) == "ProcessWithSearchSpace"
         assert process.has_best()
+        assert process.get_log_basename() is None
         assert not process.has_log()
         assert process.get_max_fes() == 100
         assert process.get_max_time_millis() is None

tests/api/test_process_ss_log.py

@@ -46,6 +46,10 @@ def test_process_ss_log_log() -> None:
     with TempFile.create() as tf:
         assert exists(tf)
         assert isfile(tf)
+        lid = tf.rfind(".")
+        lis = tf.rfind("/")
+        tfn: str = tf[:lid] if (lid > 0) and (lid > lis) else tf
+
         with Execution()\
                 .set_search_space(search_space)\
                 .set_solution_space(solution_space)\
@@ -57,6 +61,7 @@ def test_process_ss_log_log() -> None:
                 .set_log_file(tf)\
                 .set_log_improvements(True)\
                 .execute() as process:
+            assert process.get_log_basename() == tfn
             assert type_name_of(process) \
                    == "moptipy.api._process_ss_log._ProcessSSLog"
             assert str(process) == "LoggingProcessWithSearchSpace"