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

ansys/fluent/core/__init__.py

@@ -32,7 +32,6 @@ from ansys.fluent.core.logging import set_console_logging_level  # noqa: F401
 
 # isort: on
 
-from ansys.fluent.core._version import __version__  # noqa: F401
 from ansys.fluent.core.get_build_details import (  # noqa: F401
     get_build_version,
     get_build_version_string,
@@ -63,8 +62,13 @@ from ansys.fluent.core.utils import fldoc, get_examples_download_dir
 from ansys.fluent.core.utils.fluent_version import FluentVersion  # noqa: F401
 from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401
 
-_VERSION_INFO = "Build date: February 20, 2025 11:49 UTC ShaID: 1b0f023"
-"""Global variable indicating the version of the PyFluent package - Empty by default"""
+__version__ = "0.30.dev4"
+
+_VERSION_INFO = "Build date: March 10, 2025 16:38 UTC ShaID: 58d9ae8"
+"""
+Global variable indicating the version info of the PyFluent package.
+Build timestamp and commit hash are added to this variable during packaging.
+"""
 
 _THIS_DIRNAME = os.path.dirname(__file__)
 _README_FILE = os.path.normpath(os.path.join(_THIS_DIRNAME, "docs", "README.rst"))
@@ -89,6 +93,13 @@ def version_info() -> str:
     return _VERSION_INFO if _VERSION_INFO is not None else __version__
 
 
+# Latest released Fluent version
+FLUENT_RELEASE_VERSION = "25.1.0"
+
+# Current dev Fluent version
+FLUENT_DEV_VERSION = "25.2.0"
+
+# Path to the example input/data files are downloaded
 EXAMPLES_PATH = str(get_examples_download_dir())
 
 # Host path which is mounted to the container

ansys/fluent/core/codegen/datamodelgen.py

@@ -144,6 +144,18 @@ def _build_command_query_docstring(name: str, info: Any, indent: str, is_command
     return doc
 
 
+meshing_rule_file_names = {
+    "workflow": "workflow",
+    "meshing": "meshing",
+    "PartManagement": "part_management",
+    "PMFileManagement": "pm_file_management",
+    "preferences": "preferences",
+    "MeshingUtilities": "meshing_utilities",
+    "flicing": "flicing",
+    "solverworkflow": "solver_workflow",
+}
+
+
 class DataModelStaticInfo:
     """Stores datamodel static information."""
 
@@ -165,9 +177,11 @@ class DataModelStaticInfo:
             rules_save_name = rules
         datamodel_dir = (pyfluent.CODEGEN_OUTDIR / f"datamodel_{version}").resolve()
         datamodel_dir.mkdir(exist_ok=True)
-        self.file_name = (datamodel_dir / f"{rules_save_name}.py").resolve()
+        self.file_name = (
+            datamodel_dir / f"{meshing_rule_file_names[rules_save_name]}.py"
+        ).resolve()
         if rules == "MeshingUtilities":
-            self.stub_file = (datamodel_dir / "MeshingUtilities.pyi").resolve()
+            self.stub_file = (datamodel_dir / "meshing_utilities.pyi").resolve()
         if len(modes) > 1:
             for mode in modes[1:]:
                 DataModelStaticInfo._noindices.append(f"{mode}.datamodel.{rules}")
@@ -372,7 +386,7 @@ class DataModelGenerator:
             f.write(f'{indent}        """\n')
             f.write(f"{indent}        pass\n\n")
             api_tree[k] = "Parameter"
-        if "MeshingUtilities" in f.name:
+        if "meshing_utilities" in f.name:
             stub_file = self._static_info["MeshingUtilities"].stub_file
             stub_file.unlink(missing_ok=True)
             with open(stub_file, "w", encoding="utf8") as file:

ansys/fluent/core/codegen/settingsgen.py

@@ -32,7 +32,8 @@ from typing import IO
 
 import ansys.fluent.core as pyfluent
 from ansys.fluent.core import launch_fluent
-from ansys.fluent.core.codegen import StaticInfoType
+from ansys.fluent.core.codegen import StaticInfoType, walk_api
+from ansys.fluent.core.solver import _docstrings
 from ansys.fluent.core.solver.flobject import (
     ListObject,
     NamedObject,
@@ -185,7 +186,7 @@ _arg_type_strings = {
     "Filename": "str",
     "BooleanList": "list[bool]",
     "IntegerList": "list[int]",
-    "RealVector": "tuple[float | str, float | str, float | str",
+    "RealVector": "tuple[float | str, float | str, float | str]",
     "RealList": "list[float | str]",
     "StringList": "list[str]",
     "FilenameList": "list[str]",
@@ -195,8 +196,9 @@ _arg_type_strings = {
 def _write_function_stub(name, data, s_stub):
     s_stub.write(f"    def {name}(self")
     for arg_name in data["argument_names"]:
-        arg_type = _arg_type_strings[data["child_classes"][arg_name]["bases"][0]]
-        s_stub.write(f", {arg_name}: {arg_type}")
+        arg_type = data["child_classes"][arg_name]["bases"][0]
+        py_arg_type = _arg_type_strings.get(arg_type, "Any")
+        s_stub.write(f", {arg_name}: {py_arg_type}")
     s_stub.write("):\n")
     # TODO: add return type
     doc = data["doc"]
@@ -311,6 +313,24 @@ def _write_data(cls_name: str, python_name: str, data: dict, f: IO, f_stub: IO |
         f_stub.write(s_stub.getvalue())
 
 
+def _check_written_docstrings(version, output_file, verbose):
+    settings = pyfluent.utils.load_module(
+        f"settings_{version}",
+        output_file,
+    )
+    analysis = _docstrings._DocStringAnalysis()
+    walk_api.walk_api(getattr(settings, "root"), analysis.analyse, "")
+    dubious = analysis.dubious
+    if dubious:
+        print(
+            f"Some docstrings appear to be dubious in the solver settings generated classes: {dubious}."
+        )
+    elif verbose:
+        print(
+            "The solver settings generated classes contain no reported docstring issues."
+        )
+
+
 def generate(version: str, static_infos: dict, verbose: bool = False) -> None:
     """Generate the classes corresponding to the Fluent settings API."""
     start_time = time.time()
@@ -348,6 +368,7 @@ def generate(version: str, static_infos: dict, verbose: bool = False) -> None:
         header.write(")\n\n")
         f.write(header.getvalue())
         f_stub.write(header.getvalue())
+        f_stub.write("from typing import Any\n\n")
         f.write(f'SHASH = "{shash}"\n\n')
         name = data["name"]
         _NAME_BY_HASH[_gethash(data)] = name
@@ -359,6 +380,7 @@ def generate(version: str, static_infos: dict, verbose: bool = False) -> None:
     )
     print(f"{output_file.name} size: {file_size:.2f} MB")
     print(f"{output_stub_file.name} size: {file_size_stub:.2f} MB")
+    _check_written_docstrings(version, output_file, verbose)
     return {"<solver_session>": api_tree}
 
 

ansys/fluent/core/codegen/walk_api.py

@@ -37,6 +37,8 @@ Example
 from inspect import signature
 from typing import List
 
+import ansys.fluent.core.solver.flobject as flobject
+
 
 def walk_api(
     api_cls, on_each_path, current_path: str | List[str] = "", api_item_type: str = ""
@@ -53,7 +55,9 @@ def walk_api(
     """
     # Skip the root path
     if current_path:
-        if len(signature(on_each_path).parameters) == 2:
+        if len(signature(on_each_path).parameters) == 3:
+            on_each_path(current_path, api_item_type, api_cls)
+        elif len(signature(on_each_path).parameters) == 2:
             on_each_path(current_path, api_item_type)
         else:
             on_each_path(current_path)
@@ -71,6 +75,12 @@ def walk_api(
                     f"{current_path}.{child_name}" if current_path else child_name
                 )
             # Recursively walk the child
+            if not api_item_type:
+                api_item_type = (
+                    "parameter"
+                    if isinstance(child_cls, flobject.Property)
+                    else "object"
+                )
             walk_api(child_cls, on_each_path, new_path, api_item_type)
 
             # Delegate directly to any child_object_type (relevant for named objects)

ansys/fluent/core/exceptions.py

@@ -22,7 +22,7 @@
 
 """Custom common higher level exceptions."""
 
-from typing import Any
+from typing import Any, Iterable
 
 from ansys.fluent.core.solver.error_message import allowed_name_error_message
 
@@ -32,14 +32,17 @@ class DisallowedValuesError(ValueError):
 
     def __init__(
         self,
-        context: Any | None = None,
+        context: str | None = None,
         name: Any | None = None,
-        allowed_values: Any | None = None,
+        allowed_values: Iterable[Any] | None = None,
     ):
         """Initialize DisallowedValuesError."""
         super().__init__(
             allowed_name_error_message(
-                context=context, trial_name=name, allowed_values=allowed_values
+                context=context,
+                trial_name=name,
+                allowed_values=allowed_values,
+                message=f"{name} is not an allowed {context}",
             )
         )