feat: Unstable settings warning (#2590)

* feat: Unstable settings warning

* test: fix

* feat: runtime query

* feat: runtime query

Author: mkundu1

codegen/settingsgen.py

@@ -455,13 +455,13 @@ def _populate_classes(parent_dir):
                 f.write(f"{istr1}child_object_type of {cls_name}.")
                 f.write(f'\n{istr1}"""\n')
                 if stubf:
-                    stubf.write(f"{istr1}{child_object_type} = ...\n")
+                    stubf.write(f"{istr1}child_object_type = ...\n")
 
             return_type = getattr(cls, "return_type", None)
             if return_type:
                 f.write(f'{istr1}return_type = "{return_type}"\n')
                 if stubf:
-                    stubf.write(f"{istr1}{return_type} = ...\n")
+                    stubf.write(f"{istr1}return_type = ...\n")
 
 
 def _populate_init(parent_dir, sinfo):

src/ansys/fluent/core/session_solver.py

@@ -60,7 +60,7 @@ def _import_settings_root(root):
         api_keys = root.child_names
 
     for root_item in api_keys:
-        _class_dict[root_item] = getattr(root, root_item)
+        _class_dict[root_item] = root.__dict__[root_item]
 
     settings_api_root = type("SettingsRoot", (object,), _class_dict)
     return settings_api_root()

src/ansys/fluent/core/solver/flobject.py

@@ -329,20 +329,19 @@ def is_active(self) -> bool:
         attr = self.get_attr(_InlineConstants.is_active)
         return False if attr is False else True
 
-    def _is_stable(self) -> bool:
+    def _check_stable(self) -> None:
         """Whether the object is stable."""
-        if self.is_active():
-            attr = self.get_attr(_InlineConstants.is_stable)
-        else:
-            attr = True
-        attr = False if attr is False else True
-        if attr is False:
+        if not self.is_active():
+            return
+        attr = self.get_attr(_InlineConstants.is_stable)
+        attr = True if attr is None else attr
+        if not attr:
             warnings.warn(
-                f"The API feature at {self.path} is not stable. "
+                f"The API feature at '{self.path}' is not stable. "
                 f"It is not guaranteed that it is fully validated and "
-                f"there is no commitment to its backwards compatibility."
+                f"there is no commitment to its backwards compatibility.",
+                UnstableSettingWarning,
             )
-        return attr
 
     def is_read_only(self) -> bool:
         """Whether the object is read-only."""
@@ -520,6 +519,12 @@ class DeprecatedSettingWarning(FutureWarning):
     pass
 
 
+class UnstableSettingWarning(UserWarning):
+    """Provides unstable settings warning."""
+
+    pass
+
+
 _show_warning_orig = warnings.showwarning
 
 
@@ -991,24 +996,26 @@ def get_completer_info(self, prefix="", excluded=None) -> List[List[str]]:
         return ret
 
     def _get_parent_of_active_child_names(self, name):
-        parents = ""
-        path_list = []
-        for parent in self.get_active_child_names():
-            try:
-                if hasattr(getattr(self, parent), str(name)):
-                    path_list.append(f"    {self.python_path}.{parent}.{str(name)}")
-                    if len(parents) != 0:
-                        parents += ", " + parent
-                    else:
-                        parents += parent
-            except AttributeError:
-                pass
-        if len(path_list):
-            print(f"\n {str(name)} can be accessed from the following paths: \n")
-            for path in path_list:
-                print(path)
-        if len(parents):
-            return f"\n {name} is a child of {parents} \n"
+        with warnings.catch_warnings():
+            warnings.filterwarnings(action="ignore", category=UnstableSettingWarning)
+            parents = ""
+            path_list = []
+            for parent in self.get_active_child_names():
+                try:
+                    if hasattr(getattr(self, parent), str(name)):
+                        path_list.append(f"    {self.python_path}.{parent}.{str(name)}")
+                        if len(parents) != 0:
+                            parents += ", " + parent
+                        else:
+                            parents += parent
+                except AttributeError:
+                    pass
+            if len(path_list):
+                print(f"\n {str(name)} can be accessed from the following paths: \n")
+                for path in path_list:
+                    print(path)
+            if len(parents):
+                return f"\n {name} is a child of {parents} \n"
 
     def __getattribute__(self, name):
         if name in super().__getattribute__("child_names"):
@@ -1024,7 +1031,10 @@ def __getattribute__(self, name):
                 )
             return alias_obj
         try:
-            return super().__getattribute__(name)
+            attr = super().__getattribute__(name)
+            if name in super().__getattribute__("_child_classes"):
+                attr._check_stable()
+            return attr
         except AttributeError as ex:
             self._get_parent_of_active_child_names(name)
             error_msg = allowed_name_error_message(

tests/test_flobject.py

@@ -38,6 +38,7 @@ def get_attrs(self, attrs):
 
     attrs = {
         "active?": lambda self: True,
+        "webui-release-active?": lambda self: True,
     }
 
 
@@ -294,6 +295,7 @@ class S1(String):
             attrs = {
                 "active?": lambda self: not self.parent.objs["b-3"].get_state(),
                 "allowed-values": lambda self: ["foo", "bar"],
+                "webui-release-active?": lambda self: True,
             }
 
         children = {
@@ -365,7 +367,10 @@ def get_obj(self, path):
             return self.r
         obj = self.r
         for c in path.split("/"):
-            obj = obj.get_child(c)
+            try:
+                obj = obj.get_child(c)
+            except KeyError:
+                obj = obj.get_command(c)
         return obj
 
     def get_var(self, path):

tests/test_settings_api.py

@@ -2,7 +2,11 @@
 from util.solver_workflow import new_solver_session  # noqa: F401
 
 from ansys.fluent.core.examples import download_file
-from ansys.fluent.core.solver.flobject import DeprecatedSettingWarning, _Alias
+from ansys.fluent.core.solver.flobject import (
+    DeprecatedSettingWarning,
+    UnstableSettingWarning,
+    _Alias,
+)
 from ansys.fluent.core.utils.fluent_version import FluentVersion
 
 
@@ -275,3 +279,19 @@ def test_command_return_type(new_solver_session):
     )
     ret = solver.solution.report_definitions.compute(report_defs=["surface-1"])
     assert ret is not None
+
+
+@pytest.mark.fluent_version(">=24.2")
+def test_unstable_settings_warning(new_solver_session, recwarn):
+    solver = new_solver_session
+    solver.file.export
+    assert len(recwarn) == 1
+    assert recwarn.pop().category == UnstableSettingWarning
+    try:
+        solver.file.exp
+    except AttributeError:
+        pass
+    assert len(recwarn) == 0
+    solver.file.export
+    assert len(recwarn) == 1
+    assert recwarn.pop().category == UnstableSettingWarning