ansys-fluent-core 0.33.dev0__py3-none-any.whl → 0.34.dev0__py3-none-any.whl

ansys/fluent/core/solver/flobject.py

@@ -80,6 +80,7 @@ from ansys.fluent.core.variable_strategies import (
 import ansys.units
 
 from . import _docstrings
+from ..pyfluent_warnings import warning_for_fluent_dev_version
 from .error_message import allowed_name_error_message, allowed_values_error
 from .flunits import UnhandledQuantity, get_si_unit_for_fluent_quantity
 from .settings_external import expand_api_file_argument
@@ -97,7 +98,6 @@ class InactiveObjectError(RuntimeError):
 
 class _InlineConstants:
     is_active = "active?"
-    is_stable = "webui-release-active?"
     is_read_only = "read-only?"
     default_value = "default"
     min = "min"
@@ -195,7 +195,7 @@ _to_field_name_str = naming_strategy().to_string
 def _get_python_path_comps(obj):
     """Get python path components for traversing class hierarchy."""
     comps = []
-    while obj:
+    while obj is not None:
         python_name = obj.python_name
         obj = obj._parent
         if isinstance(obj, (NamedObject, ListObject)):
@@ -224,6 +224,24 @@ def _get_class_from_paths(root_cls, some_path: list[str], other_path: list[str])
     return cls, full_path
 
 
+def _is_deprecated(obj) -> bool | None:
+    """Whether the object is deprecated in a specific Fluent version."""
+    if FluentVersion(obj._version) >= FluentVersion.v252:
+        # "_deprecated_version" is part of generated data since 25R2
+        deprecated_version = getattr(obj, "_deprecated_version", None)
+    else:
+        deprecated_version = obj.get_attrs(["deprecated-version"])
+        if deprecated_version:
+            deprecated_version = deprecated_version.get("attrs", deprecated_version)
+        deprecated_version = (
+            deprecated_version.get("deprecated-version") if deprecated_version else None
+        )
+    return deprecated_version and (
+        FluentVersion(float(deprecated_version)) <= FluentVersion.v222
+        or FluentVersion(obj._version) >= FluentVersion(deprecated_version)
+    )
+
+
 class Base:
     """Provides the base class for settings and command objects.
 
@@ -286,12 +304,10 @@ class Base:
 
         Supports file upload and download.
         """
-        with warnings.catch_warnings():
-            warnings.filterwarnings(action="ignore", category=UnstableSettingWarning)
-            if self._file_transfer_service:
-                return self._file_transfer_service
-            elif self._parent:
-                return self._parent._file_transfer_handler
+        if self._file_transfer_service:
+            return self._file_transfer_service
+        elif self._parent:
+            return self._parent._file_transfer_handler
 
     _name = None
     fluent_name = None
@@ -403,38 +419,11 @@ class Base:
             return None
         return val
 
-    def _is_deprecated(self) -> bool:
-        """Whether the object is deprecated in a specific Fluent version.'"""
-        deprecated_version = self.get_attrs(["deprecated-version"])
-        if deprecated_version:
-            deprecated_version = deprecated_version.get("attrs", deprecated_version)
-        deprecated_version = (
-            deprecated_version.get("deprecated-version") if deprecated_version else None
-        )
-        return deprecated_version and (
-            float(deprecated_version) <= 22.2
-            or FluentVersion(self._version) >= FluentVersion(deprecated_version)
-        )
-
     def is_active(self) -> bool:
         """Whether the object is active."""
         attr = self.get_attr(_InlineConstants.is_active)
         return False if attr is False else True
 
-    def _check_stable(self) -> None:
-        """Whether the object is stable."""
-        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"It is not guaranteed that it is fully validated and "
-                f"there is no commitment to its backwards compatibility.",
-                UnstableSettingWarning,
-            )
-
     def is_read_only(self) -> bool:
         """Whether the object is read-only."""
         attr = self.get_attr(_InlineConstants.is_read_only)
@@ -639,6 +628,7 @@ class DeprecatedSettingWarning(PyFluentDeprecationWarning):
     pass
 
 
+# TODO: Delete this after updating PyConsole code when next PyFluent version is pushed.
 class UnstableSettingWarning(PyFluentUserWarning):
     """Provides unstable settings warning."""
 
@@ -965,7 +955,7 @@ def _command_query_name_filter(
     for name in names:
         if name not in excluded and name.startswith(prefix):
             child = getattr(parent, name)
-            if child.is_active() and not child._is_deprecated():
+            if child.is_active() and not _is_deprecated(child):
                 ret.append([name, child.__class__.__bases__[0].__name__, child.__doc__])
     return ret
 
@@ -1079,7 +1069,7 @@ class Group(SettingsBase[DictStateType]):
         ret = []
         for child_name in self.child_names:
             child = getattr(self, child_name)
-            if child.is_active() and not child._is_deprecated():
+            if child.is_active() and not _is_deprecated(child):
                 ret.append(child_name)
         return ret
 
@@ -1088,7 +1078,7 @@ class Group(SettingsBase[DictStateType]):
         ret = []
         for command_name in self.command_names:
             command = getattr(self, command_name)
-            if command.is_active() and not command._is_deprecated():
+            if command.is_active() and not _is_deprecated(command):
                 ret.append(command_name)
         return ret
 
@@ -1097,7 +1087,7 @@ class Group(SettingsBase[DictStateType]):
         ret = []
         for query_name in self.query_names:
             query = getattr(self, query_name)
-            if query.is_active() and not query._is_deprecated():
+            if query.is_active() and not _is_deprecated(query):
                 ret.append(query_name)
         return ret
 
@@ -1107,7 +1097,8 @@ class Group(SettingsBase[DictStateType]):
             [
                 child
                 for child in self.child_names + self.command_names + self.query_names
-                if getattr(self, child)._is_deprecated()
+                if getattr(self, child).is_active()
+                and _is_deprecated(getattr(self, child))
             ]
         )
 
@@ -1124,7 +1115,7 @@ class Group(SettingsBase[DictStateType]):
         for child_name in self.child_names:
             if child_name not in excluded and child_name.startswith(prefix):
                 child = getattr(self, child_name)
-                if child.is_active() and not child._is_deprecated():
+                if child.is_active() and not _is_deprecated(child):
                     ret.append(
                         [
                             child_name,
@@ -1141,25 +1132,24 @@ class Group(SettingsBase[DictStateType]):
         return ret
 
     def __getattribute__(self, name):
-        if name in super().__getattribute__("child_names"):
-            if self.is_active() is False:
-                raise InactiveObjectError(self.python_path)
-        alias = super().__getattribute__("_child_aliases").get(name)
-        if alias:
-            alias = alias[0]
-            alias_obj = self._child_alias_objs.get(name)
-            if alias_obj is None:
-                obj = self.find_object(alias)
-                alias_obj = self._child_alias_objs[name] = _create_child(
-                    obj.__class__, None, obj.parent, alias
-                )
-            return alias_obj
+        if (
+            name in super().__getattribute__("child_names")
+            and self.is_active() is False
+        ):
+            raise InactiveObjectError(self.python_path)
         try:
-            attr = super().__getattribute__(name)
-            if name in super().__getattribute__("_child_classes"):
-                attr._check_stable()
-            return attr
+            return super().__getattribute__(name)
         except AttributeError as ex:
+            alias = self._child_aliases.get(name)
+            if alias is not None:
+                alias = alias[0]
+                alias_obj = self._child_alias_objs.get(name)
+                if alias_obj is None:
+                    obj = self.find_object(alias)
+                    alias_obj = self._child_alias_objs[name] = _create_child(
+                        obj.__class__, None, obj.parent, alias
+                    )
+                return alias_obj
             error_msg = allowed_name_error_message(
                 trial_name=name,
                 message=ex.args[0],
@@ -1667,7 +1657,8 @@ class Action(Base):
             [
                 child
                 for child in self.argument_names
-                if getattr(self, child)._is_deprecated()
+                if getattr(self, child).is_active()
+                and _is_deprecated(getattr(self, child))
             ]
         )
 
@@ -1684,7 +1675,7 @@ class Action(Base):
         for argument_name in self.argument_names:
             if argument_name not in excluded and argument_name.startswith(prefix):
                 argument = getattr(self, argument_name)
-                if argument.is_active() and not argument._is_deprecated():
+                if argument.is_active() and not _is_deprecated(argument):
                     ret.append(
                         [
                             argument_name,
@@ -1791,10 +1782,16 @@ def _fix_parameter_list_return(val):
                 # Symbols are not stripped in the command return in PyConsole.
                 # Following code will work in both PyConsole and PyFluent.
                 unit = units[0].lstrip("'")
-                unit_labels = _fix_parameter_list_return.scheme_eval(
-                    f"(units/inquire-available-label-strings-for-quantity '{unit})"
-                )
-                unit_label = unit_labels[0] if len(unit_labels) > 0 else ""
+                if unit != "*null*":
+                    try:
+                        unit_labels = _fix_parameter_list_return.scheme_eval(
+                            f"(units/inquire-available-label-strings-for-quantity '{unit})"
+                        )
+                    except RuntimeError:
+                        unit_labels = []
+                    unit_label = unit_labels[0] if len(unit_labels) > 0 else ""
+                else:
+                    unit_label = ""
             else:
                 unit_label = ""
             new_val[name] = [value, unit_label]
@@ -2274,6 +2271,7 @@ def get_root(
                 CODEGEN_OUTDIR / "solver" / f"settings_{version}.py",
             )
             root_cls = settings.root
+            warning_for_fluent_dev_version(version)
         except FileNotFoundError:
             obj_info = flproxy.get_static_info()
             root_cls, _ = get_cls("", obj_info, version=version)

ansys/fluent/core/solver/settings_builtin_bases.py

@@ -55,14 +55,18 @@ def _get_settings_obj(settings_root, builtin_settings_obj):
     builtin_cls_name = builtin_settings_obj.__class__.__name__
     obj = settings_root
     path = DATA[builtin_cls_name][1]
+    found_path = None
     if isinstance(path, dict):
         version = FluentVersion(obj._version)
-        path = path.get(version)
-        if path is None:
-            raise RuntimeError(
-                f"{builtin_cls_name} is not supported in Fluent version {version}."
-            )
-    comps = path.split(".")
+        for version_set, p in path.items():
+            if version in version_set:
+                found_path = p
+                break
+        if found_path is None:
+            raise RuntimeError(f"{builtin_cls_name} is not supported in {version}.")
+    elif isinstance(path, str):
+        found_path = path
+    comps = found_path.split(".")
     for i, comp in enumerate(comps):
         obj = SettingsBase.__getattribute__(obj, comp)  # bypass InactiveObjectError
         if i < len(comps) - 1 and isinstance(obj, NamedObject):
@@ -81,7 +85,7 @@ def _initialize_settings(instance, defaults: dict, settings_source=None, **kwarg
 
 
 class _SingletonSetting:
-    # Covers both groups and named-object containers
+    # Covers groups, named-object containers and commands.
     def __init__(self, settings_source: SettingsBase | Solver | None = None, **kwargs):
         _initialize_settings(self, {"settings_source": None}, settings_source, **kwargs)
 
@@ -152,3 +156,6 @@ class _CreatableNamedObjectSetting:
             self.__dict__.update(obj.__dict__ | dict(settings_source=settings_root))
         else:
             super().__setattr__(name, value)
+
+
+_CommandSetting = _SingletonSetting