FEAT: Add oDesktop logging to installer and automation tab functions (#6821)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>

Author: 3 people

doc/changelog.d/6821.added.md

@@ -0,0 +1 @@
+Add oDesktop logging to installer and automation tab functions

doc/source/Resources/pyaedt_installer_from_aedt.py

@@ -172,15 +172,15 @@ def run_pyinstaller_from_c_python(oDesktop):
         if version <= "231":
             f.write("from pyaedt.extensions.installer.pyaedt_installer import add_pyaedt_to_aedt\n")
             f.write(
-                'add_pyaedt_to_aedt(aedt_version="{}", personallib=r"{}")\n'.format(
-                    oDesktop.GetVersion()[:6], oDesktop.GetPersonalLibDirectory()
+                'add_pyaedt_to_aedt(aedt_version="{}", personallib=r"{}", odesktop={})\n'.format(
+                    oDesktop.GetVersion()[:6], oDesktop.GetPersonalLibDirectory(), oDesktop
                 )
             )
         else:
             f.write("from ansys.aedt.core.extensions.installer.pyaedt_installer import add_pyaedt_to_aedt\n")
             f.write(
-                'add_pyaedt_to_aedt(aedt_version="{}", personal_lib=r"{}")\n'.format(
-                    oDesktop.GetVersion()[:6], oDesktop.GetPersonalLibDirectory()
+                'add_pyaedt_to_aedt(aedt_version="{}", personal_lib=r"{}", odesktop={})\n'.format(
+                    oDesktop.GetVersion()[:6], oDesktop.GetPersonalLibDirectory(), oDesktop
                 )
             )
 

src/ansys/aedt/core/extensions/customize_automation_tab.py

@@ -70,6 +70,7 @@ def add_automation_tab(
     overwrite=False,
     panel="Panel_PyAEDT_Extensions",
     is_custom=False,  # new argument for custom flag
+    odesktop=None,
 ):
     """Add an automation tab in AEDT.
 
@@ -90,6 +91,10 @@ def add_automation_tab(
         which case is adding new tabs to the existing ones.
     panel : str, optional
         Panel name. The default is ``"Panel_PyAEDT_Extensions"``.
+    is_custom : bool, optional
+        Whether the automation tab is for custom extensions. The default is ``False``.
+    odesktop : oDesktop, optional
+        Desktop session. The default is ``None``.
 
     Returns
     -------
@@ -154,6 +159,10 @@ def add_automation_tab(
                     logging.getLogger("Global").warning(
                         f"Could not create symlink from {images_source} to {images_target}"
                     )
+                    if odesktop:
+                        odesktop.AddMessage(
+                            "", "", 0, str(f"Could not create symlink from {images_source} to {images_target}")
+                        )
             icon_relative = f"images/{icon_file.name}"
             button_kwargs = dict(
                 label=name,
@@ -313,6 +322,7 @@ def add_script_to_menu(
     personal_lib=None,
     aedt_version="",
     is_custom=False,
+    odesktop=None,
 ):
     """Add a script to the ribbon menu.
 
@@ -344,6 +354,7 @@ def add_script_to_menu(
     personal_lib : str, optional
     aedt_version : str, optional
     is_custom : bool, optional
+    odesktop : oDesktop, optional
 
     Returns
     -------
@@ -437,8 +448,11 @@ def add_script_to_menu(
         template=template_file,
         panel=panel,
         is_custom=is_custom,
+        odesktop=odesktop,
     )
     logger.info(f"{name} installed")
+    if odesktop:
+        odesktop.AddMessage("", "", 0, str(f"{name} installed"))
     return True
 
 

src/ansys/aedt/core/extensions/installer/pyaedt_installer.py

@@ -34,6 +34,7 @@ def add_pyaedt_to_aedt(
     aedt_version,
     personal_lib,
     skip_version_manager=False,
+    odesktop=None,
 ):
     """Add PyAEDT tabs in AEDT.
 
@@ -45,6 +46,8 @@ def add_pyaedt_to_aedt(
         AEDT personal library folder.
     skip_version_manager : bool, optional
         Skip the version manager tab. The default is ``False``.
+    odesktop : oDesktop, optional
+        Desktop session. The default is ``None``.
     """
     logger = logging.getLogger("Global")
     if not personal_lib or not aedt_version:
@@ -60,10 +63,10 @@ def add_pyaedt_to_aedt(
     extensions_dir = os.path.join(personal_lib, "Toolkits")
     os.makedirs(extensions_dir, exist_ok=True)
 
-    __add_pyaedt_tabs(personal_lib, aedt_version, skip_version_manager)
+    __add_pyaedt_tabs(personal_lib, aedt_version, skip_version_manager, odesktop)
 
 
-def __add_pyaedt_tabs(personal_lib, aedt_version, skip_version_manager):
+def __add_pyaedt_tabs(personal_lib, aedt_version, skip_version_manager, odesktop=None):
     """Add PyAEDT tabs in AEDT."""
     if skip_version_manager:
         pyaedt_tabs = ["Console", "Jupyter", "Run_Script", "ExtensionManager"]
@@ -94,4 +97,5 @@ def __add_pyaedt_tabs(personal_lib, aedt_version, skip_version_manager):
                 panel="Panel_PyAEDT_Installer",
                 personal_lib=personal_lib,
                 aedt_version=aedt_version,
+                odesktop=odesktop,
             )

tests/unit/extensions/test_customize_automation_tab.py

@@ -355,6 +355,7 @@ def test_add_script_to_menu_success(
         template="run_pyaedt_toolkit_script",
         panel="Panel_PyAEDT_Extensions",
         is_custom=False,
+        odesktop=None,
     )
 
     # Verify the generated script content
@@ -416,4 +417,5 @@ def test_add_script_to_menu_is_custom(mock_copy, mock_add_automation_tab, mock_d
         template="run_pyaedt_toolkit_script",
         panel="Panel_PyAEDT_Extensions",
         is_custom=True,
+        odesktop=None,
     )