refactor: scheme_eval. (#4042)

scheme_eval.scheme_eval -> scheme.eval
scheme_eval.eval -> scheme._eval
scheme_eval.string_eval -> scheme.string_eval

"scheme_eval" from session level and "scheme_eval" from the service
level is deprecated.

Tests and docs have been updated as per these updates.

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Harshal Pohekar <[email protected]>

Author: 3 people

doc/changelog.d/4042.miscellaneous.md

@@ -0,0 +1 @@
+scheme_eval.

doc/deprecated_pyfluent_apis.py

@@ -3,6 +3,16 @@
 PYFLUENT_DEPRECATED_DATA = [
     # Target, Deprecated, Alternatives
     # methods
+    (
+        ":py:meth:`ansys.fluent.core.services.scheme_eval.SchemeEval.scheme_eval <ansys.fluent.core.services.scheme_eval.SchemeEval.scheme_eval>`",
+        "0.32",
+        ":py:meth:`ansys.fluent.core.services.scheme_eval.SchemeEval.eval <ansys.fluent.core.services.scheme_eval.SchemeEval.eval>`",
+    ),
+    (
+        ":py:meth:`ansys.fluent.core.session.BaseSession.scheme_eval <ansys.fluent.core.session.BaseSession.scheme_eval>`",
+        "0.32",
+        ":py:meth:`ansys.fluent.core.session.BaseSession.scheme <ansys.fluent.core.session.BaseSession.scheme>`",
+    ),
     (
         ":py:meth:`ansys.fluent.core.fluent_connection.FluentConnection.health_check <ansys.fluent.core.fluent_connection.FluentConnection.health_check>`",
         "0.32",

doc/source/cheatsheet/cheat_sheet.qmd

@@ -1095,13 +1095,8 @@ solver = pyfluent.launch_fluent(
 
 ```{python}
 import ansys.fluent.core as pyfluent
-S = pyfluent.services.scheme_eval.Symbol
-session.scheme_eval.eval([S('+'), 2, 3])
-session.scheme_eval.eval([S('rpgetvar'), [S('string->symbol'), "mom/relax"]])
-session.scheme_eval.exec(('(ti-menu-load-string "/report/system/proc-stats")',))
+session.scheme.exec(('(ti-menu-load-string "/report/system/proc-stats")',))
 # Returns TUI output string
-session.scheme_eval.string_eval("(+ 2 3)")
-session.scheme_eval.string_eval("(rpgetvar 'mom/relax)")
-session.scheme_eval.scheme_eval("(+ 2 3)")
-session.scheme_eval.scheme_eval("(rpgetvar 'mom/relax)")
+session.scheme.eval("(+ 2 3)")
+session.scheme.eval("(rpgetvar 'mom/relax)")
 ```

doc/source/user_guide/legacy/scheme.rst

@@ -13,18 +13,11 @@ Examples
 
 .. code-block:: python
 
-   >>> from ansys.fluent.core.services.scheme_eval import Symbol as S
-   >>> session.scheme_eval.eval([S('+'), 2, 3])
-   5
-   >>> session.scheme_eval.eval([S('rpgetvar'), [S('string->symbol'), "mom/relax"]])
-   0.7
-   >>> session.scheme_eval.exec(('(ti-menu-load-string "/report/system/proc-stats")',))
+   >>> session.scheme.exec(('(ti-menu-load-string "/report/system/proc-stats")',))
    >>> # Returns TUI output string
-   >>> session.scheme_eval.string_eval("(+ 2 3)")
-   '5'
-   >>> session.scheme_eval.string_eval("(rpgetvar 'mom/relax)")
+   >>> session.scheme.eval("(rpgetvar 'mom/relax)")
    '0.7'
-   >>> session.scheme_eval.scheme_eval("(+ 2 3)")
+   >>> session.scheme.eval("(+ 2 3)")
    5
-   >>> session.scheme_eval.scheme_eval("(rpgetvar 'mom/relax)")
+   >>> session.scheme.eval("(rpgetvar 'mom/relax)")
    0.7

examples/00-fluent/DOE_ML.py

@@ -127,7 +127,7 @@
         solver.settings.solution.initialization.standard_initialize()
         solver.settings.solution.run_calculation.iterate(iter_count=200)
 
-        res_tui = solver.scheme_eval.exec(
+        res_tui = solver.scheme.exec(
             (
                 "(ti-menu-load-string "
                 '"/report/surface-integrals/mass-weighted-avg outlet () '

examples/00-fluent/conjugate_heat_transfer.py

@@ -703,13 +703,13 @@
 # Post-Processing Mass Balance Report
 # ===================================
 
-inlet_mfr = solver.scheme_eval.exec(
+inlet_mfr = solver.scheme.exec(
     ('(ti-menu-load-string "/report/fluxes/mass-flow no inlet () no")',)
 ).split(" ")[-1]
-outlet_mfr = solver.scheme_eval.exec(
+outlet_mfr = solver.scheme.exec(
     ('(ti-menu-load-string "/report/fluxes/mass-flow no outlet () no")',)
 ).split(" ")[-1]
-net_mfr = solver.scheme_eval.exec(
+net_mfr = solver.scheme.exec(
     ('(ti-menu-load-string "/report/fluxes/mass-flow no inlet outlet () no")',)
 ).split(" ")[-1]
 print("Mass Balance Report\n")
@@ -721,7 +721,7 @@
 # Heat Balance Report
 # ===================
 
-htr = solver.scheme_eval.exec(
+htr = solver.scheme.exec(
     ('(ti-menu-load-string "/report/fluxes/heat-transfer yes no")',)
 ).split(" ")[-1]
 print("Heat Balance Report\n")

src/ansys/fluent/core/post_objects/post_helper.py

@@ -155,7 +155,7 @@ def get_vector_fields(self):
     def get_field_unit(self, field):
         """Returns the unit of the field."""
         session = self.obj.get_root().session
-        if FluentVersion(session.scheme_eval.version) < FluentVersion.v252:
+        if FluentVersion(session.scheme.version) < FluentVersion.v252:
             quantity = self._field_unit_quantity(field)
             if quantity == "*null*":
                 return ""

src/ansys/fluent/core/services/app_utilities.py

@@ -155,18 +155,18 @@ class AppUtilitiesOld:
 
     def __init__(self, scheme_eval):
         """__init__ method of AppUtilitiesOld class."""
-        self.scheme_eval = scheme_eval
+        self.scheme = scheme_eval
 
     def get_product_version(self) -> str:
         """Get product version."""
-        return self.scheme_eval.version
+        return self.scheme.version
 
     def get_build_info(self) -> dict:
         """Get build info."""
-        build_time = self.scheme_eval.scheme_eval("(inquire-build-time)")
-        build_id = self.scheme_eval.scheme_eval("(inquire-build-id)")
-        vcs_revision = self.scheme_eval.scheme_eval("(inquire-src-vcs-id)")
-        vcs_branch = self.scheme_eval.scheme_eval("(inquire-src-vcs-branch)")
+        build_time = self.scheme.eval("(inquire-build-time)")
+        build_id = self.scheme.eval("(inquire-build-id)")
+        vcs_revision = self.scheme.eval("(inquire-src-vcs-id)")
+        vcs_branch = self.scheme.eval("(inquire-src-vcs-branch)")
         return {
             "build_time": build_time,
             "build_id": build_id,
@@ -176,9 +176,9 @@ def get_build_info(self) -> dict:
 
     def get_controller_process_info(self) -> dict:
         """Get controller process info."""
-        cortex_host = self.scheme_eval.scheme_eval("(cx-cortex-host)")
-        cortex_pid = self.scheme_eval.scheme_eval("(cx-cortex-id)")
-        cortex_pwd = self.scheme_eval.scheme_eval("(cortex-pwd)")
+        cortex_host = self.scheme.eval("(cx-cortex-host)")
+        cortex_pid = self.scheme.eval("(cx-cortex-id)")
+        cortex_pwd = self.scheme.eval("(cortex-pwd)")
         return {
             "hostname": cortex_host,
             "process_id": cortex_pid,
@@ -187,9 +187,9 @@ def get_controller_process_info(self) -> dict:
 
     def get_solver_process_info(self) -> dict:
         """Get solver process info."""
-        fluent_host = self.scheme_eval.scheme_eval("(cx-client-host)")
-        fluent_pid = self.scheme_eval.scheme_eval("(cx-client-id)")
-        fluent_pwd = self.scheme_eval.scheme_eval("(cx-send '(cx-client-pwd))")
+        fluent_host = self.scheme.eval("(cx-client-host)")
+        fluent_pid = self.scheme.eval("(cx-client-id)")
+        fluent_pwd = self.scheme.eval("(cx-send '(cx-client-pwd))")
         return {
             "hostname": fluent_host,
             "process_id": fluent_pid,
@@ -200,8 +200,8 @@ def get_app_mode(self) -> Enum:
         """Get app mode."""
         from ansys.fluent.core import FluentMode
 
-        if self.scheme_eval.scheme_eval("(cx-solver-mode?)"):
-            mode_str = self.scheme_eval.scheme_eval('(getenv "PRJAPP_APP")')
+        if self.scheme.eval("(cx-solver-mode?)"):
+            mode_str = self.scheme.eval('(getenv "PRJAPP_APP")')
             if mode_str == "flaero_server":
                 return FluentMode.SOLVER_AERO
             elif mode_str == "flicing":
@@ -214,44 +214,38 @@ def get_app_mode(self) -> Enum:
     def start_python_journal(self, journal_name: str | None = None) -> int:
         """Start python journal."""
         if journal_name:
-            self.scheme_eval.exec([f'(api-start-python-journal "{journal_name}")'])
+            self.scheme.exec([f'(api-start-python-journal "{journal_name}")'])
         else:
-            self.scheme_eval.scheme_eval(
-                "(define pyfluent-journal-str-port (open-output-string))"
-            )
-            self.scheme_eval.scheme_eval(
-                "(api-echo-python-port pyfluent-journal-str-port)"
-            )
+            self.scheme.eval("(define pyfluent-journal-str-port (open-output-string))")
+            self.scheme.eval("(api-echo-python-port pyfluent-journal-str-port)")
             return "1"
 
     def stop_python_journal(self, journal_id: str | None = None) -> str:
         """Stop python journal."""
         if journal_id:
-            self.scheme_eval.scheme_eval(
-                "(api-unecho-python-port pyfluent-journal-str-port)"
-            )
-            journal_str = self.scheme_eval.scheme_eval(
+            self.scheme.eval("(api-unecho-python-port pyfluent-journal-str-port)")
+            journal_str = self.scheme.eval(
                 "(close-output-port pyfluent-journal-str-port)"
             )
             return journal_str
         else:
-            self.scheme_eval.exec(["(api-stop-python-journal)"])
+            self.scheme.exec(["(api-stop-python-journal)"])
 
     def is_beta_enabled(self) -> bool:
         """Is beta enabled."""
-        return self.scheme_eval.scheme_eval("(is-beta-feature-available?)")
+        return self.scheme.eval("(is-beta-feature-available?)")
 
     def is_wildcard(self, input: str | None = None) -> bool:
         """Is wildcard."""
-        return self.scheme_eval.scheme_eval(f'(has-fnmatch-wild-card? "{input}")')
+        return self.scheme.eval(f'(has-fnmatch-wild-card? "{input}")')
 
     def is_solution_data_available(self) -> bool:
         """Is solution data available."""
-        return self.scheme_eval.scheme_eval("(data-valid?)")
+        return self.scheme.eval("(data-valid?)")
 
     def register_pause_on_solution_events(self, solution_event: SolverEvent) -> int:
         """Register pause on solution events."""
-        unique_id: int = self.scheme_eval.scheme_eval(
+        unique_id: int = self.scheme.eval(
             f"""
             (let
                 ((ids
@@ -284,23 +278,21 @@ def register_pause_on_solution_events(self, solution_event: SolverEvent) -> int:
 
     def resume_on_solution_event(self, registration_id: int) -> None:
         """Resume on solution event."""
-        self.scheme_eval.scheme_eval(
+        self.scheme.eval(
             f"(grpcserver/auto-resume (is-server-running?) 'pyfluent-{registration_id})"
         )
 
     def unregister_pause_on_solution_events(self, registration_id: int) -> None:
         """Unregister pause on solution events."""
-        self.scheme_eval.scheme_eval(
-            f"(cancel-solution-monitor 'pyfluent-{registration_id})"
-        )
+        self.scheme.eval(f"(cancel-solution-monitor 'pyfluent-{registration_id})")
 
     def exit(self) -> None:
         """Exit."""
-        self.scheme_eval.exec(("(exit-server)",))
+        self.scheme.exec(("(exit-server)",))
 
     def set_working_directory(self, path: str) -> None:
         """Change client cortex dir."""
-        self.scheme_eval.scheme_eval(f'(syncdir "{path}")')
+        self.scheme.eval(f'(syncdir "{path}")')
 
 
 class AppUtilities:

src/ansys/fluent/core/services/field_data.py

@@ -1266,7 +1266,7 @@ def __init__(
         self._service = service
         self._field_info = field_info
         self.is_data_valid = is_data_valid
-        self.scheme_eval = scheme_eval
+        self.scheme = scheme_eval
 
         self.get_zones_info = lambda: get_zones_info()()
 
@@ -1400,7 +1400,7 @@ def _get_vector_field_data(
             kwargs.get("field_name")
         )
         for surface_id in surface_ids:
-            self.scheme_eval.string_eval(f"(surface? {surface_id})")
+            self.scheme.string_eval(f"(surface? {surface_id})")
         fields_request = get_fields_request()
         fields_request.vectorFieldRequest.extend(
             self._fetched_data._vector_data(
@@ -1602,7 +1602,7 @@ def get_mesh(self, zone: str | int) -> Mesh:
             domain_id=ROOT_DOMAIN_ID, thread_id=zone_info._id
         )
         # TODO: Add precision query in AppUtilities service
-        is_double_precision = self.scheme_eval.scheme_eval("(rp-double?)")
+        is_double_precision = self.scheme.eval("(rp-double?)")
         if is_double_precision:
             nested_nodes = self._service.get_solver_mesh_nodes_double(nodes_request)
         else:

src/ansys/fluent/core/services/scheme_eval.py

@@ -24,25 +24,17 @@
 
 Example
 -------
->>> from ansys.fluent.core.services.scheme_eval import Symbol as S
->>> session.scheme_eval.eval([S('+'), 2, 3])
-5
->>> session.scheme_eval.eval([S('rpgetvar'), [S('string->symbol'), "mom/relax"]])
-0.7
->>> session.scheme_eval.exec(('(ti-menu-load-string "/report/system/proc-stats")',))
+>>> session.scheme.exec(('(ti-menu-load-string "/report/system/proc-stats")',))
 >>> # Returns TUI output string
->>> session.scheme_eval.string_eval("(+ 2 3)")
-'5'
->>> session.scheme_eval.string_eval("(rpgetvar 'mom/relax)")
-'0.7'
->>> session.scheme_eval.scheme_eval("(+ 2 3)")
+>>> session.scheme.eval("(+ 2 3)")
 5
->>> session.scheme_eval.scheme_eval("(rpgetvar 'mom/relax)")
+>>> session.scheme.eval("(rpgetvar 'mom/relax)")
 0.7
 """
 
 from typing import Any, Sequence
 
+from deprecated.sphinx import deprecated
 import grpc
 
 from ansys.api.fluent.v0 import scheme_eval_pb2 as SchemeEvalProtoModule
@@ -255,14 +247,10 @@ class SchemeEval:
 
     Methods
     -------
-    eval(val)
-        Evaluates a scheme expression, returns Python value
     exec(commands, wait, silent)
         Executes a sequence of scheme commands, returns TUI output
         string
-    string_eval(input)
-        Evaluates a scheme expression in string format, returns string
-    scheme_eval(input)
+    eval(input)
         Evaluates a scheme expression in string format, returns Python
         value
     """
@@ -276,7 +264,7 @@ def __init__(self, service: SchemeEvalService) -> None:
         except Exception:  # for pypim launch
             self.version = FluentVersion.v231.value
 
-    def eval(self, val: Any, suppress_prompts: bool = True) -> Any:
+    def _eval(self, val: Any, suppress_prompts: bool = True) -> Any:
         """Evaluates a scheme expression.
 
         Parameters
@@ -354,12 +342,17 @@ def string_eval(self, input: str) -> str:
         response = self.service.string_eval(request)
         return response.output
 
-    def scheme_eval(self, input: str, suppress_prompts: bool = True) -> Any:
+    @deprecated(version="0.32", reason="Use ``session.scheme``.")
+    def scheme_eval(self, scm_input: str, suppress_prompts: bool = True) -> Any:
+        """Evaluates a scheme expression in string format."""
+        return self.eval(scm_input, suppress_prompts)
+
+    def eval(self, scm_input: str, suppress_prompts: bool = True) -> Any:
         """Evaluates a scheme expression in string format.
 
         Parameters
         ----------
-        input : str
+        scm_input : str
             Input scheme expression in string format
 
         suppress_prompts : bool, optional
@@ -373,10 +366,10 @@ def scheme_eval(self, input: str, suppress_prompts: bool = True) -> Any:
         S = Symbol  # noqa N806
         val = (
             S("eval"),
-            (S("with-input-from-string"), input, S("read")),
+            (S("with-input-from-string"), scm_input, S("read")),
             S("user-initial-environment"),
         )
-        return self.eval(val, suppress_prompts)
+        return self._eval(val, suppress_prompts)
 
     def is_defined(self, symbol: str) -> bool:
         """Check if a symbol is defined in the scheme environment.
@@ -391,6 +384,6 @@ def is_defined(self, symbol: str) -> bool:
         bool
             True if symbol is defined, False otherwise
         """
-        return not self.scheme_eval(
+        return not self.eval(
             f"(lexical-unreferenceable? user-initial-environment '{symbol})"
         )