fix: removing io error when logging to closed streams (#3273)

* fix: avoid logging to closed streams

* chore: update gitignore to avoid any .venv* and venv* directory

* chore: adding changelog file 3273.fixed.md

* refactor: moved code to a function and added test.

* fix: call method

* fix: calling empty attributes.

* test: early exit

* fix: test

* fix: test

* fix: test 3

* fix: test 4

---------

Co-authored-by: pyansys-ci-bot <[email protected]>

.gitignore

@@ -84,9 +84,9 @@ docker/mapdl/*.sh
 tmp.out
 
 # virtual environment
-venv/
+venv*
 .venv/
-.venv
+.venv*
 
 # Visual studio code local settings
 .vscode/

doc/changelog.d/3273.fixed.md

@@ -0,0 +1 @@
+fix: removing io error when logging to closed streams

src/ansys/mapdl/core/mapdl_core.py

@@ -283,7 +283,7 @@ def __init__(
         self.check_parameter_names = start_parm.get("check_parameter_names", True)
 
         # Setting up loggers
-        self._log: logging.Logger = logger.add_instance_logger(
+        self._log: logger = logger.add_instance_logger(
             self.name, self, level=loglevel
         )  # instance logger
         # adding a file handler to the logger
@@ -2260,6 +2260,10 @@ def exit(self):  # pragma: no cover
     def __del__(self):
         """Clean up when complete"""
         if self._cleanup:
+            # removing logging handlers if they are closed to avoid I/O errors
+            # when exiting after the logger file has been closed.
+            self._cleanup_loggers()
+
             try:
                 self.exit()
             except Exception as e:
@@ -2269,6 +2273,27 @@ def __del__(self):
                 except Exception:
                     pass
 
+    def _cleanup_loggers(self):
+        """Clean up all the loggers"""
+        # Detached from ``__del__`` for easier testing
+        if not hasattr(self, "_log"):
+            return  # Early exit if logger has been already cleaned.
+
+        logger = self._log
+
+        if logger.hasHandlers():
+            for each_handler in logger.logger.handlers:
+                if each_handler.stream and not each_handler.stream.closed:
+                    logger.logger.removeHandler(each_handler)
+
+        if logger.file_handler:
+            logger.file_handler.close()
+            logger.file_handler = None
+
+        if logger.std_out_handler:
+            logger.std_out_handler.close()
+            logger.std_out_handler = None
+
     def _get_plot_name(self, text: str) -> str:
         """Obtain the plot filename."""
         self._log.debug(text)

tests/test_mapdl.py

@@ -2453,3 +2453,15 @@ def test_not_correct_et_element(mapdl):
 def test_ctrl(mapdl):
     mapdl._ctrl("set_verb", 5)  # Setting verbosity on the server
     mapdl._ctrl("set_verb", 0)  # Returning to non-verbose
+
+
+def test_cleanup_loggers(mapdl):
+    assert mapdl.logger is not None
+    assert mapdl.logger.hasHandlers()
+    assert mapdl.logger.logger.handlers
+
+    mapdl._cleanup_loggers()
+
+    assert mapdl.logger is not None
+    assert mapdl.logger.std_out_handler is None
+    assert mapdl.logger.file_handler is None