implement logger in convert_script (#717)

* Added convert logger

* Added test unit

* Removed unused package.

* Apply suggestions from code review

Co-authored-by: Alex Kaszynski <[email protected]>

* Update test logger.

* Update tests/test_convert.py

Co-authored-by: Alex Kaszynski <[email protected]>

Co-authored-by: Alex Kaszynski <[email protected]>

Author: germa89

ansys/mapdl/core/convert.py

@@ -1,5 +1,6 @@
 import os
 from warnings import warn
+from logging import Logger, StreamHandler
 
 from ansys.mapdl.core import __version__
 from ansys.mapdl.core.misc import is_float
@@ -21,6 +22,7 @@ def convert_script(
     exec_file=None,
     macros_as_functions=True,
     use_function_names=True,
+    show_log = False
 ):
     """Converts an ANSYS input file to a python PyMAPDL script.
 
@@ -51,6 +53,10 @@ def convert_script(
         converted to ``mapdl.k``.  When ``False``, it will be
         converted to ``mapdl.run('k')``.
 
+    show_log : bool, optional
+        Print the converted commands using a logger (from ``logging``
+        Python module).
+
     Returns
     -------
     list
@@ -71,21 +77,22 @@ def convert_script(
                                 line_ending=line_ending,
                                 exec_file=exec_file,
                                 macros_as_functions=macros_as_functions,
-                                use_function_names=use_function_names
+                                use_function_names=use_function_names,
+                                show_log=show_log
                           )
 
     translator.save(filename_out)
     return translator.lines
 
 
 def convert_apdl_block(apdl_strings,
-    loglevel="WARNING",
-    auto_exit=True,
-    line_ending=None,
-    exec_file=None,
-    macros_as_functions=True,
-    use_function_names=True,
-                       ):
+        loglevel="WARNING",
+        auto_exit=True,
+        line_ending=None,
+        exec_file=None,
+        macros_as_functions=True,
+        use_function_names=True,
+        show_log=False):
     """Converts an ANSYS input string to a python PyMAPDL string.
 
     Parameters
@@ -115,6 +122,10 @@ def convert_apdl_block(apdl_strings,
         converted to ``mapdl.k``.  When ``False``, it will be
         converted to ``mapdl.run('k')``.
 
+    show_log : bool, optional
+        Print the converted commands using a logger (from ``logging``
+        Python module).
+
     Returns
     -------
     list
@@ -128,7 +139,8 @@ def convert_apdl_block(apdl_strings,
     line_ending=line_ending,
     exec_file=exec_file,
     macros_as_functions=macros_as_functions,
-    use_function_names=use_function_names)
+    use_function_names=use_function_names,
+    show_log=show_log)
 
     if isinstance(apdl_strings, str):
         return translator.line_ending.join(translator.lines)
@@ -142,6 +154,7 @@ def _convert(apdl_strings,
     exec_file=None,
     macros_as_functions=True,
     use_function_names=True,
+    show_log=False
              ):
 
     translator = FileTranslator(
@@ -150,6 +163,7 @@ def _convert(apdl_strings,
         exec_file=exec_file,
         macros_as_functions=macros_as_functions,
         use_function_names=use_function_names,
+        show_log=show_log
     )
 
     if isinstance(apdl_strings, str):
@@ -163,6 +177,27 @@ def _convert(apdl_strings,
     return translator
 
 
+class Lines(list):
+    def __init__(self, mute):
+        self._log = Logger('convert_logger')
+        self._setup_logger()
+        self._mute = mute
+        super().__init__()
+
+    def append(self, item, mute=True):
+        # append the item to itself (the list)
+        if not self._mute:
+            self._log.info(msg=f"Converted: '{item}'")
+        super(Lines, self).append(item)
+
+    def _setup_logger(self):
+        stdhdl = StreamHandler()
+        stdhdl.setLevel(10)
+        stdhdl.set_name('stdout')
+        self._log.addHandler(stdhdl)
+        self._log.propagate = True
+
+
 class FileTranslator:
     obj_name = "mapdl"
     indent = ""
@@ -175,9 +210,10 @@ def __init__(
         exec_file=None,
         macros_as_functions=True,
         use_function_names=True,
+        show_log=False
     ):
         self._non_interactive_level = 0
-        self.lines = []
+        self.lines = Lines(mute=not show_log)
         self._functions = []
         if line_ending:
             self.line_ending = line_ending

tests/test_convert.py

@@ -1,8 +1,9 @@
 import os
 import pytest
+
 from ansys.mapdl import core as pymapdl
 from ansys.mapdl.core import examples
-from ansys.mapdl.core.convert import convert_apdl_block
+from ansys.mapdl.core.convert import convert_apdl_block, FileTranslator
 
 nblock = """nblock,3,,326253
 (1i9,3e20.9e3)
@@ -94,3 +95,16 @@ def test_convert_block_commands(tmpdir, cmd):
     pyblock = convert_apdl_block(apdl_strings=apdl_block.split('\n'))
     pyblock = '\n'.join(pyblock)
     assert pymapdl_output[cmd] in pyblock
+
+
+def test_logger(capsys):
+
+    apdl_ = """FINISH
+    /PREP7
+    """.split('\n')
+
+    translator = FileTranslator(line_ending='\n', show_log=True)
+    for line in apdl_:
+        translator.translate_line(line)
+    std = capsys.readouterr()
+    assert all(['Converted' in each for each in std.err.split('\n')[:-1]]) # last one is an empty line.