ansys-fluent-core 0.30.dev2__py3-none-any.whl → 0.30.dev4__py3-none-any.whl

ansys/fluent/core/solver/flobject.py

@@ -69,13 +69,13 @@ from typing import (
 import warnings
 import weakref
 
-import ansys.fluent.core as pyfluent
 from ansys.fluent.core.pyfluent_warnings import (
     PyFluentDeprecationWarning,
     PyFluentUserWarning,
 )
 from ansys.fluent.core.utils.fluent_version import FluentVersion
 
+from . import _docstrings
 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
@@ -200,10 +200,10 @@ def _get_python_path_comps(obj):
     """Get python path components for traversing class hierarchy."""
     comps = []
     while obj:
-        python_name = obj._python_name
+        python_name = obj.python_name
         obj = obj._parent
         if isinstance(obj, (NamedObject, ListObject)):
-            comps.append(obj._python_name)
+            comps.append(obj.python_name)
             obj = obj._parent
         else:
             comps.append(python_name)
@@ -407,9 +407,19 @@ 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"])
+        deprecated_version = (
+            deprecated_version.get("deprecated-version") if deprecated_version else None
+        )
+        return deprecated_version and FluentVersion(self.version) >= FluentVersion(
+            deprecated_version
+        )
+
     def is_active(self) -> bool:
         """Whether the object is active."""
-        attr = self.get_attr(_InlineConstants.is_active)
+        attr = self.get_attr(_InlineConstants.is_active) and not self._is_deprecated()
         return False if attr is False else True
 
     def _check_stable(self) -> None:
@@ -695,9 +705,14 @@ class _Alias:
 
 def _create_child(cls, name, parent: weakref.CallableProxyType, alias_path=None):
     if alias_path or isinstance(parent, _Alias):
+        bases = (cls,)
+        # True child of parent alias is already derived from _Alias.
+        # Avoiding duplicate derivation and mro resolution issue.
+        if _Alias not in cls.__mro__:
+            bases = (_Alias, cls)
         alias_cls = type(
             f"{cls.__name__}_alias",
-            (_Alias, cls),
+            bases,
             dict(cls.__dict__) | {"alias_path": alias_path},
         )
         return alias_cls(name, parent.__repr__.__self__)
@@ -945,6 +960,23 @@ def _command_query_name_filter(
     return ret
 
 
+def _get_type_for_completer_info(cls) -> str:
+    if issubclass(cls, (FileName, _InputFile)):
+        return "InputFilename"
+    elif issubclass(cls, (FileName, _OutputFile)):
+        return "OutputFilename"
+    elif issubclass(cls, (FileName, _InOutFile)):
+        return "InOutFilename"
+    elif issubclass(cls, (FilenameList, _InputFile)):
+        return "InputFilenameList"
+    elif issubclass(cls, (FilenameList, _OutputFile)):
+        return "OutputFilenameList"
+    elif issubclass(cls, (FilenameList, _InOutFile)):
+        return "InOutFilenameList"
+    else:
+        return cls.__bases__[0].__name__
+
+
 class Group(SettingsBase[DictStateType]):
     """A ``Group`` container object.
 
@@ -1056,6 +1088,16 @@ class Group(SettingsBase[DictStateType]):
                 ret.append(query)
         return ret
 
+    def __dir__(self):
+        dir_list = set(list(self.__dict__.keys()) + dir(type(self)))
+        return dir_list - set(
+            [
+                child
+                for child in self.child_names + self.command_names + self.query_names
+                if getattr(self, child)._is_deprecated()
+            ]
+        )
+
     def get_completer_info(self, prefix="", excluded=None) -> List[List[str]]:
         """Get completer info of all children.
 
@@ -1073,7 +1115,7 @@ class Group(SettingsBase[DictStateType]):
                     ret.append(
                         [
                             child_name,
-                            child.__class__.__bases__[0].__name__,
+                            _get_type_for_completer_info(child.__class__),
                             child.__doc__,
                         ]
                     )
@@ -1105,18 +1147,12 @@ class Group(SettingsBase[DictStateType]):
                 attr._check_stable()
             return attr
         except AttributeError as ex:
-            pyfluent.PRINT_SEARCH_RESULTS = False
-            search_results = pyfluent.utils.search(
-                search_string=name,
-                match_case=False,
-                match_whole_word=False,
-            )
-            pyfluent.PRINT_SEARCH_RESULTS = True
-            results = search_results if search_results else []
             error_msg = allowed_name_error_message(
                 trial_name=name,
                 message=ex.args[0],
-                search_results=results,
+                allowed_values=sorted(
+                    set(self.get_active_child_names() + self.command_names)
+                ),
             )
             ex.args = (error_msg,)
             raise
@@ -1391,7 +1427,7 @@ class NamedObject(SettingsBase[DictStateType], Generic[ChildTypeT]):
                 )
             raise KeyError(
                 allowed_name_error_message(
-                    context=self.__class__._python_name,
+                    context=self.python_name,
                     trial_name=name,
                     allowed_values=self.get_object_names(),
                 )
@@ -1608,6 +1644,16 @@ class Action(Base):
                 cls = self.__class__._child_classes[argument]
                 self._setattr(argument, _create_child(cls, None, self))
 
+    def __dir__(self):
+        dir_list = set(list(self.__dict__.keys()) + dir(type(self)))
+        return dir_list - set(
+            [
+                child
+                for child in self.argument_names
+                if getattr(self, child)._is_deprecated()
+            ]
+        )
+
     def get_completer_info(self, prefix="", excluded=None) -> List[List[str]]:
         """Get completer info of all arguments.
 
@@ -1625,7 +1671,7 @@ class Action(Base):
                     ret.append(
                         [
                             argument_name,
-                            argument.__class__.__bases__[0].__name__,
+                            _get_type_for_completer_info(argument.__class__),
                             argument.__doc__,
                         ]
                     )
@@ -1809,13 +1855,22 @@ _baseTypes = {
 
 
 def _clean_helpinfo(helpinfo):
-    helpinfo = helpinfo.strip("\n")
+    helpinfo = helpinfo.strip("\n").lstrip(" ")
     if not helpinfo.endswith("."):
         helpinfo += "."
     helpinfo = helpinfo[0].upper() + helpinfo[1:]
     return helpinfo
 
 
+def _fix_help_info(obj_type, helpinfo):
+    # The else clause is just picking "object" due to our current
+    # knowledge that the implementation only distinguishes between
+    # "method" and everything else. This is fragile.
+    api_item_type = "method" if obj_type in ("command", "query") else "object"
+    fix = _docstrings._fixed_doc_string(api_item_type, helpinfo)
+    return fix or helpinfo
+
+
 class _ChildNamedObjectAccessorMixin(collections.abc.MutableMapping):
     """A mixin class to provide a dictionary interface at a Group class level if the
     Group has multiple named objects of a similar type. For example, boundary conditions
@@ -1935,7 +1990,7 @@ class _NonCreatableNamedObjectMixin(
             else:
                 raise KeyError(
                     allowed_name_error_message(
-                        context=self.__class__._python_name,
+                        context=self.python_name,
                         trial_name=name,
                         allowed_values=self.get_object_names(),
                     )
@@ -1983,7 +2038,7 @@ def get_cls(name, info, parent=None, version=None, parent_taboo=None):
         dct = {"fluent_name": name, "version": version}
         helpinfo = info.get("help")
         if helpinfo:
-            dct["__doc__"] = _clean_helpinfo(helpinfo)
+            dct["__doc__"] = _fix_help_info(obj_type, _clean_helpinfo(helpinfo))
         else:
             if parent is None:
                 dct["__doc__"] = "'root' object."
@@ -2189,15 +2244,19 @@ def get_root(
     """
     from ansys.fluent.core import CODEGEN_OUTDIR, utils
 
-    try:
-        settings = utils.load_module(
-            f"settings_{version}",
-            CODEGEN_OUTDIR / "solver" / f"settings_{version}.py",
-        )
-        root_cls = settings.root
-    except FileNotFoundError:
+    if os.getenv("PYFLUENT_USE_RUNTIME_PYTHON_CLASSES") == "1":
         obj_info = flproxy.get_static_info()
         root_cls, _ = get_cls("", obj_info, version=version)
+    else:
+        try:
+            settings = utils.load_module(
+                f"settings_{version}",
+                CODEGEN_OUTDIR / "solver" / f"settings_{version}.py",
+            )
+            root_cls = settings.root
+        except FileNotFoundError:
+            obj_info = flproxy.get_static_info()
+            root_cls, _ = get_cls("", obj_info, version=version)
     root = root_cls()
     root.set_flproxy(flproxy)
     root._set_on_interrupt(interrupt)

ansys/fluent/core/utils/fluent_version.py

@@ -27,7 +27,6 @@ from functools import total_ordering
 import os
 
 import ansys.fluent.core as pyfluent
-from ansys.fluent.core._version import fluent_dev_version, fluent_release_version
 
 
 class AnsysVersionNotFound(RuntimeError):
@@ -131,7 +130,7 @@ class FluentVersion(Enum):
         FluentVersion
             FluentVersion member corresponding to the latest release.
         """
-        return cls(fluent_release_version)
+        return cls(pyfluent.FLUENT_RELEASE_VERSION)
 
     @classmethod
     def current_dev(cls):
@@ -142,7 +141,7 @@ class FluentVersion(Enum):
         FluentVersion
             FluentVersion member corresponding to the latest development version.
         """
-        return cls(fluent_dev_version)
+        return cls(pyfluent.FLUENT_DEV_VERSION)
 
     @property
     def awp_var(self):

ansys/fluent/core/utils/test_grpc_connection.py

@@ -0,0 +1,139 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Script to test viability of gRPC connection in the current machine."""
+
+
+from argparse import ArgumentParser
+import socket
+
+import grpc
+from grpc_health.v1 import health_pb2, health_pb2_grpc
+
+from ansys.fluent.core.utils.networking import _GrpcServer, get_free_port
+
+
+def _test_connection_using_specified_ip(ip: str, port: int | None = None) -> bool:
+    if not port:
+        port = get_free_port()
+    address = f"{ip}:{port}"
+    try:
+        with _GrpcServer(address):
+            with grpc.insecure_channel(address) as channel:
+                stub = health_pb2_grpc.HealthStub(channel)
+                return (
+                    stub.Check(
+                        health_pb2.HealthCheckRequest(),
+                        timeout=1,
+                    ).status
+                    == health_pb2.HealthCheckResponse.ServingStatus.SERVING
+                )
+    except Exception:
+        return False
+
+
+def _test_connection_using_all_available_ips(port: int | None = None) -> list[str]:
+    successful_ips = []
+    for addrinfo in socket.getaddrinfo(
+        "localhost",
+        0,
+        family=socket.AF_INET,
+        type=socket.SOCK_STREAM,
+        flags=socket.AI_PASSIVE,
+    ):
+        ip = addrinfo[-1][0]
+        if _test_connection_using_specified_ip(ip, port):
+            successful_ips.append(ip)
+    return successful_ips
+
+
+def test_connection(ip: str | None = None, port: int | None = None):
+    """
+    Test viability of gRPC connection in the current machine.
+    Parameters
+    ----------
+    ip : str, optional
+        IP address to test connection with. If not provided, will test using all available ips.
+    port : int, optional
+        Port to test connection with. If not provided, will test using random port.
+    """
+
+    if ip is not None and port is not None:
+        print(f"Testing gRPC connection using ip={ip} and port={port}.")
+        if _test_connection_using_specified_ip(ip, port):
+            print(f"gRPC connection can be established using ip={ip} and port={port}.")
+        else:
+            print(
+                f"gRPC connection cannot be established using ip={ip} and port={port}. "
+                "Try with a different ip and/or port. You can run the script again without "
+                "providing any ip to print all viable ips where gRPC connection can be established."
+            )
+    elif ip is not None and port is None:
+        print(f"Testing gRPC connection using ip={ip} and random port.")
+        if _test_connection_using_specified_ip(ip):
+            print(f"gRPC connection can be established using ip={ip}.")
+        else:
+            print(
+                f"gRPC connection cannot be established using ip={ip}. "
+                "Try with a different ip. You can run the script again without "
+                "providing any ip to print all viable ips where gRPC connection can be established."
+            )
+    elif ip is None and port is not None:
+        print(f"Testing gRPC connection using all available ips and port={port}.")
+        successful_ips = _test_connection_using_all_available_ips(port)
+        if successful_ips:
+            for ip in successful_ips:
+                print(
+                    f"gRPC connection can be established using ip={ip} and port={port}."
+                )
+        else:
+            print(
+                f"gRPC connection cannot be established using any ip and port={port}. "
+                "Try with a different port. You can run the script again without "
+                "providing any port to test using random port."
+            )
+    else:
+        print("Testing gRPC connection using all available ips and random port.")
+        successful_ips = _test_connection_using_all_available_ips()
+        if successful_ips:
+            for ip in successful_ips:
+                print(f"gRPC connection can be established using ip={ip}.")
+        else:
+            print("gRPC connection cannot be established using any ip.")
+
+
+if __name__ == "__main__":
+    parser = ArgumentParser(
+        description="Script to test viability of gRPC connection in the current machine."
+    )
+    parser.add_argument(
+        "-i",
+        "--ip",
+        help="IP address to test connection with. If not provided, will test using all available ips.",
+    )
+    parser.add_argument(
+        "-p",
+        "--port",
+        help="Port to test connection with. If not provided, will test using random port.",
+    )
+    args = parser.parse_args()
+    test_connection(args.ip, args.port)

ansys/fluent/core/workflow.py

@@ -1365,6 +1365,7 @@ class Workflow:
                     "service",
                     "task_object",
                     "workflow",
+                    "rename",
                 },
                 _fluent_version=fluent_version,
             )

{ansys_fluent_core-0.30.dev2.dist-info → ansys_fluent_core-0.30.dev4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ansys-fluent-core
-Version: 0.30.dev2
+Version: 0.30.dev4
 Summary: PyFluent provides Pythonic access to Ansys Fluent.
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -17,34 +17,34 @@ Requires-Dist: ansys-units>=0.3.3,<0.5
 Requires-Dist: docker>=7.1.0
 Requires-Dist: grpcio>=1.30.0
 Requires-Dist: grpcio-health-checking>=1.30.0
-Requires-Dist: grpcio-status>=1.30.0
+Requires-Dist: grpcio-status>=1.26.0
 Requires-Dist: lxml>=4.9.2
 Requires-Dist: nltk>=3.9.1
 Requires-Dist: numpy>=1.14.0,<3.0.0
 Requires-Dist: pandas>=1.1.0,<2.3
 Requires-Dist: pyansys-tools-report>=0.8.1
 Requires-Dist: pyyaml>=6.0
-Requires-Dist: Sphinx==7.4.7 ; extra == "docs"
+Requires-Dist: Sphinx==8.1.3 ; extra == "docs"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "docs"
 Requires-Dist: numpydoc==1.8.0 ; extra == "docs"
-Requires-Dist: matplotlib==3.10.0 ; extra == "docs"
-Requires-Dist: ansys-sphinx-theme==1.2.7 ; extra == "docs"
+Requires-Dist: matplotlib==3.10.1 ; extra == "docs"
+Requires-Dist: ansys-sphinx-theme==1.3.2 ; extra == "docs"
 Requires-Dist: pypandoc==1.15 ; extra == "docs"
 Requires-Dist: pytest-sphinx==0.6.3 ; extra == "docs"
 Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints==2.3.0 ; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints==3.0.1 ; extra == "docs"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "docs"
-Requires-Dist: sphinx-gallery==0.18.0 ; extra == "docs"
+Requires-Dist: sphinx-gallery==0.19.0 ; extra == "docs"
 Requires-Dist: sphinx-notfound-page==1.1.0 ; extra == "docs"
 Requires-Dist: sphinxcontrib-websupport==2.0.0 ; extra == "docs"
 Requires-Dist: sphinxemoji==0.3.1 ; extra == "docs"
-Requires-Dist: sphinx-toggleprompt==0.5.2 ; extra == "docs"
+Requires-Dist: sphinx-toggleprompt==0.6.0 ; extra == "docs"
 Requires-Dist: autodocsumm==0.2.14 ; extra == "docs"
-Requires-Dist: beautifulsoup4==4.13.1 ; extra == "docs"
+Requires-Dist: beautifulsoup4==4.13.3 ; extra == "docs"
 Requires-Dist: openpyxl>=3.1.5 ; extra == "docs"
 Requires-Dist: plotly>=5.22.0 ; extra == "docs"
 Requires-Dist: python-pptx>=0.6.23 ; extra == "docs"
-Requires-Dist: quarto-cli==1.6.39 ; extra == "docs"
+Requires-Dist: quarto-cli==1.6.42 ; extra == "docs"
 Requires-Dist: pdf2image==1.17.0 ; extra == "docs"
 Requires-Dist: seaborn>=0.13.2 ; extra == "docs"
 Requires-Dist: tensorflow>=2.17.0 ; extra == "docs"
@@ -114,8 +114,8 @@ In the upper right corner of the documentation's title bar, there is an option f
 viewing the documentation for the latest stable release to viewing the documentation for the
 development version or previously released versions.
 
-You can also `view <https://cheatsheets.docs.pyansys.com/pyfluent_cheat_sheet.png>`_ or
-`download <https://cheatsheets.docs.pyansys.com/pyfluent_cheat_sheet.pdf>`_ the
+You can also `view <https://fluent.docs.pyansys.com/version/stable/_static/cheat_sheet.pdf>`_ or
+`download <https://fluent.docs.pyansys.com/version/stable/_static/cheat_sheet.pdf>`_ the
 PyFluent cheat sheet. This one-page reference provides syntax rules and commands
 for using PyFluent.