ansys-speos-core 0.6.3__tar.gz → 0.7.0__tar.gz

{ansys_speos_core-0.6.3 → ansys_speos_core-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansys-speos-core
-Version: 0.6.3
+Version: 0.7.0
 Summary: A Python wrapper for Ansys Speos
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -21,28 +21,25 @@ Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 License-File: LICENSE
 Requires-Dist: protobuf>=3.20,<7
-Requires-Dist: grpcio>=1.50.0,<1.75
+Requires-Dist: grpcio>=1.50.0,<1.77
 Requires-Dist: grpcio-health-checking>=1.45.0,<1.68
 Requires-Dist: ansys-api-speos==0.15.3
-Requires-Dist: ansys-tools-path>=0.3.1
+Requires-Dist: ansys-tools-common>=0.3.1
 Requires-Dist: numpy>=1.20.3,<3
 Requires-Dist: comtypes>=1.4,<1.5; platform_system=='Windows'
-Requires-Dist: ansys-sphinx-theme==1.6.0 ; extra == "doc"
-Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
+Requires-Dist: ansys-sphinx-theme[autoapi]==1.6.3 ; extra == "doc"
+Requires-Dist: ansys-tools-visualization-interface>=0.8.3 ; extra == "doc"
+Requires-Dist: numpydoc==1.10.0 ; extra == "doc"
 Requires-Dist: Sphinx==8.1.3 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
-Requires-Dist: sphinx-autoapi==3.6.0 ; extra == "doc"
-Requires-Dist: sphinx_design==0.6.1 ; extra == "doc"
-Requires-Dist: sphinx-jinja==2.0.2 ; extra == "doc"
-Requires-Dist: sphinxcontrib-mermaid==1.0.0 ; extra == "doc"
+Requires-Dist: sphinxcontrib-mermaid==1.2.3 ; extra == "doc"
 Requires-Dist: myst-parser==4.0.1 ; extra == "doc"
-Requires-Dist: nbsphinx==0.9.7 ; extra == "doc"
-Requires-Dist: jupytext==1.17.3 ; extra == "doc"
-Requires-Dist: jupyterlab==4.4.7 ; extra == "doc"
+Requires-Dist: nbsphinx==0.9.8 ; extra == "doc"
+Requires-Dist: jupytext==1.18.1 ; extra == "doc"
+Requires-Dist: jupyterlab==4.5.0 ; extra == "doc"
 Requires-Dist: jupyter-server==2.17.0 ; extra == "doc"
 Requires-Dist: nbconvert==7.16.6 ; extra == "doc"
 Requires-Dist: pyvista[jupyter]>=0.43,<0.47 ; extra == "doc"
-Requires-Dist: ansys-tools-visualization-interface>=0.8.3 ; extra == "doc"
 Requires-Dist: pyvista>=0.40.0,<0.47 ; extra == "graphics"
 Requires-Dist: ansys-tools-visualization-interface>=0.8.3 ; extra == "graphics"
 Requires-Dist: matplotlib ; extra == "jupyter"
@@ -50,13 +47,13 @@ Requires-Dist: jupyterlab>=3 ; extra == "jupyter"
 Requires-Dist: ipywidgets ; extra == "jupyter"
 Requires-Dist: pyvista[jupyter]>=0.43,<0.47 ; extra == "jupyter"
 Requires-Dist: ansys-tools-visualization-interface>=0.8.3 ; extra == "jupyter"
-Requires-Dist: notebook==7.4.5 ; extra == "jupyter"
-Requires-Dist: psutil==7.0.0 ; extra == "tests"
-Requires-Dist: pytest==8.4.2 ; extra == "tests"
+Requires-Dist: notebook==7.5.0 ; extra == "jupyter"
+Requires-Dist: psutil==7.1.3 ; extra == "tests"
+Requires-Dist: pytest==9.0.1 ; extra == "tests"
 Requires-Dist: pyvista>=0.40.0,<0.47 ; extra == "tests"
 Requires-Dist: ansys-tools-visualization-interface>=0.8.3 ; extra == "tests"
 Requires-Dist: ansys-platform-instancemanagement>=1.0.3 ; extra == "tests"
-Requires-Dist: pytest-cov==6.3.0 ; extra == "tests"
+Requires-Dist: pytest-cov==7.0.0 ; extra == "tests"
 Project-URL: Changelog, https://github.com/ansys/pyspeos/blob/main/doc/source/changelog.rst
 Project-URL: Discussions, https://github.com/ansys/pyspeos/discussions
 Project-URL: Documentation, https://speos.docs.pyansys.com/
@@ -143,7 +140,7 @@ All sources are located in `<src/>`_ folder.
 
    from ansys.speos.core.speos import Speos
 
-   speos = Speos(host="localhost", port=50098)
+   speos = Speos()
 
 Documentation and issues
 ------------------------
@@ -213,11 +210,11 @@ Then, to launch SpeosRPC server with product version 2025.1, you can run:
 
    cat GH_TOKEN.txt | docker login ghcr.io -u "$GH_USERNAME" --password-stdin
    docker pull ghcr.io/ansys/speos-rpc:252
-   docker run --detach --name speos-rpc -p 127.0.0.1:50098:50098 -e ANSYSLMD_LICENSE_FILE=$LICENSE_SERVER --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:252 --host 0.0.0.0
+   docker run --detach --name speos-rpc -p 127.0.0.1:50098:50098 -e ANSYSLMD_LICENSE_FILE=$LICENSE_SERVER --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:252 --transport_insecure --host 0.0.0.0
 
 .. note::
 
-   To use the latest image in development, you can use `ghcr.io/ansys/speos-rpc:252`.
+   To use the latest image in development, you can use `ghcr.io/ansys/speos-rpc:dev`.
 
 On the other hand, the SpeosRPC server can be started locally.
 

{ansys_speos_core-0.6.3 → ansys_speos_core-0.7.0}/README.rst

@@ -73,7 +73,7 @@ All sources are located in `<src/>`_ folder.
 
    from ansys.speos.core.speos import Speos
 
-   speos = Speos(host="localhost", port=50098)
+   speos = Speos()
 
 Documentation and issues
 ------------------------
@@ -143,11 +143,11 @@ Then, to launch SpeosRPC server with product version 2025.1, you can run:
 
    cat GH_TOKEN.txt | docker login ghcr.io -u "$GH_USERNAME" --password-stdin
    docker pull ghcr.io/ansys/speos-rpc:252
-   docker run --detach --name speos-rpc -p 127.0.0.1:50098:50098 -e ANSYSLMD_LICENSE_FILE=$LICENSE_SERVER --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:252 --host 0.0.0.0
+   docker run --detach --name speos-rpc -p 127.0.0.1:50098:50098 -e ANSYSLMD_LICENSE_FILE=$LICENSE_SERVER --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:252 --transport_insecure --host 0.0.0.0
 
 .. note::
 
-   To use the latest image in development, you can use `ghcr.io/ansys/speos-rpc:252`.
+   To use the latest image in development, you can use `ghcr.io/ansys/speos-rpc:dev`.
 
 On the other hand, the SpeosRPC server can be started locally.
 

{ansys_speos_core-0.6.3 → ansys_speos_core-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "ansys-speos-core"
-version = "0.6.3"
+version = "0.7.0"
 description = "A Python wrapper for Ansys Speos"
 readme = "README.rst"
 requires-python = ">=3.10"
@@ -28,10 +28,10 @@ classifiers=[
 ]
 dependencies=[
     "protobuf>=3.20,<7",
-    "grpcio>=1.50.0,<1.75",
+    "grpcio>=1.50.0,<1.77",
     "grpcio-health-checking>=1.45.0,<1.68",
     "ansys-api-speos==0.15.3",
-    "ansys-tools-path>=0.3.1",
+    "ansys-tools-common>=0.3.1",
     "numpy>=1.20.3,<3",
     "comtypes>=1.4,<1.5; platform_system=='Windows'",
 ]
@@ -42,12 +42,12 @@ graphics = [
     "ansys-tools-visualization-interface>=0.8.3",
 ]
 tests = [
-    "psutil==7.0.0",
-    "pytest==8.4.2",
+    "psutil==7.1.3",
+    "pytest==9.0.1",
     "pyvista>=0.40.0,<0.47",
     "ansys-tools-visualization-interface>=0.8.3",
     "ansys-platform-instancemanagement>=1.0.3",
-    "pytest-cov==6.3.0",
+    "pytest-cov==7.0.0",
 ]
 jupyter = [
     "matplotlib",
@@ -55,25 +55,22 @@ jupyter = [
     "ipywidgets",
     "pyvista[jupyter]>=0.43,<0.47",
     "ansys-tools-visualization-interface>=0.8.3",
-    "notebook==7.4.5",
+    "notebook==7.5.0",
 ]
 doc = [
-    "ansys-sphinx-theme==1.6.0",
-    "numpydoc==1.8.0",
+    "ansys-sphinx-theme[autoapi]==1.6.3",
+    "ansys-tools-visualization-interface>=0.8.3",
+    "numpydoc==1.10.0",
     "Sphinx==8.1.3",
     "sphinx-copybutton==0.5.2",
-    "sphinx-autoapi==3.6.0",
-    "sphinx_design==0.6.1",
-    "sphinx-jinja==2.0.2",
-    "sphinxcontrib-mermaid==1.0.0",
+    "sphinxcontrib-mermaid==1.2.3",
     "myst-parser==4.0.1",
-    "nbsphinx==0.9.7",
-    "jupytext==1.17.3",
-    "jupyterlab==4.4.7",
+    "nbsphinx==0.9.8",
+    "jupytext==1.18.1",
+    "jupyterlab==4.5.0",
     "jupyter-server==2.17.0",
     "nbconvert==7.16.6",
     "pyvista[jupyter]>=0.43,<0.47",
-    "ansys-tools-visualization-interface>=0.8.3",
 ]
 
 [project.urls]
@@ -147,6 +144,10 @@ show_missing = true
 minversion = "7.1"
 addopts = "-vvv --color=yes -ra --durations=25 --cov=ansys.speos --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term"
 testpaths = ["tests"]
+markers = [
+    "all_speos_versions: Supported on all Speos versions.",
+    "supported_speos_versions(min, max): Feature only supported from minimal to maximal Speos versions."
+]
 
 [tool.mypy]
 python_version = "3.10"

{ansys_speos_core-0.6.3 → ansys_speos_core-0.7.0}/src/ansys/speos/core/generic/general_methods.py

@@ -34,10 +34,10 @@ from pathlib import Path
 from typing import List, Optional, Union, cast
 import warnings
 
+from ansys.tools.common.path import get_available_ansys_installations
 import numpy as np
 
 from ansys.speos.core.generic.constants import DEFAULT_VERSION
-from ansys.tools.path import get_available_ansys_installations
 
 _GRAPHICS_AVAILABLE = None
 
@@ -90,9 +90,8 @@ def run_if_graphics_required(warning=False):
     global _GRAPHICS_AVAILABLE
     if _GRAPHICS_AVAILABLE is None:
         try:
-            import pyvista as pv  # noqa: F401
-
             from ansys.tools.visualization_interface import Plotter  # noqa: F401
+            import pyvista as pv  # noqa: F401
 
             _GRAPHICS_AVAILABLE = True
         except ImportError:  # pragma: no cover
@@ -179,11 +178,8 @@ def error_no_install(install_path: Union[Path, str], version: Union[int, str]):
     version : Union[int, str]
         Version
     """
-    install_loc_msg = ""
-    if install_path:
-        install_loc_msg = f"at {Path(install_path).parent}"
     raise FileNotFoundError(
-        f"Ansys Speos RPC server installation not found{install_loc_msg}. "
+        f"Ansys Speos RPC server installation not found at {install_path}. "
         f"Please define AWP_ROOT{version} environment variable"
     )
 

{ansys_speos_core-0.6.3 → ansys_speos_core-0.7.0}/src/ansys/speos/core/kernel/body.py

@@ -28,6 +28,7 @@ from ansys.api.speos.part.v1 import (
     body_pb2 as messages,
     body_pb2_grpc as service,
 )
+
 from ansys.speos.core.kernel.crud import CrudItem, CrudStub
 from ansys.speos.core.kernel.proto_message_utils import protobuf_message_to_str
 
@@ -94,7 +95,7 @@ class BodyStub(CrudStub):
     Like in the following example:
 
     >>> from ansys.speos.core.speos import Speos
-    >>> speos = Speos(host="localhost", port=50098)
+    >>> speos = Speos()
     >>> body_db = speos.client.bodies()
 
     """

{ansys_speos_core-0.6.3 → ansys_speos_core-0.7.0}/src/ansys/speos/core/kernel/client.py

@@ -25,14 +25,15 @@
 import logging
 import os
 from pathlib import Path
-import subprocess
+import subprocess  # nosec
+import tempfile
 import time
 from typing import TYPE_CHECKING, List, Optional, Union
 
+from ansys.api.speos.part.v1 import body_pb2, face_pb2, part_pb2
 import grpc
 from grpc._channel import _InactiveRpcError
 
-from ansys.api.speos.part.v1 import body_pb2, face_pb2, part_pb2
 from ansys.speos.core.generic.constants import (
     DEFAULT_HOST,
     DEFAULT_PORT,
@@ -42,6 +43,13 @@ from ansys.speos.core.generic.constants import (
 from ansys.speos.core.generic.general_methods import retrieve_speos_install_dir
 from ansys.speos.core.kernel.body import BodyLink, BodyStub
 from ansys.speos.core.kernel.face import FaceLink, FaceStub
+from ansys.speos.core.kernel.grpc.transport_options import (
+    InsecureOptions,
+    TransportMode,
+    TransportOptions,
+    UDSOptions,
+    WNUAOptions,
+)
 from ansys.speos.core.kernel.intensity_template import (
     IntensityTemplateLink,
     IntensityTemplateStub,
@@ -82,7 +90,7 @@ def wait_until_healthy(channel: grpc.Channel, timeout: float):
 
     Parameters
     ----------
-    channel : ~grpc.Channel
+    channel : grpc.Channel
         Channel to wait until established and healthy.
     timeout : float
         Timeout in seconds. One attempt will be made each 100 milliseconds
@@ -107,24 +115,45 @@ def wait_until_healthy(channel: grpc.Channel, timeout: float):
         )
 
 
+def default_docker_channel(
+    host: Optional[str] = DEFAULT_HOST,
+    port: Union[str, int] = DEFAULT_PORT,
+    message_size: int = MAX_CLIENT_MESSAGE_SIZE,
+) -> grpc.Channel:
+    """Create default transport options for docker on CI."""
+    return TransportOptions(
+        mode=TransportMode.INSECURE,
+        options=InsecureOptions(host=host, port=port, allow_remote_host=True),
+    ).create_channel(grpc_options=[("grpc.max_receive_message_length", message_size)])
+
+
+def default_local_channel(
+    port: Union[str, int] = DEFAULT_PORT, message_size: int = MAX_CLIENT_MESSAGE_SIZE
+) -> grpc.Channel:
+    """Create default transport options, WNUA on Windows, UDS on Linux."""
+    if os.name == "nt":
+        transport = TransportOptions(
+            mode=TransportMode.WNUA, options=WNUAOptions(host=DEFAULT_HOST, port=port)
+        )
+    else:
+        sock_file = Path(tempfile.gettempdir()) / f"speosrpc_sock_{port}"
+        transport = TransportOptions(
+            mode=TransportMode.UDS, options=UDSOptions(uds_fullpath=str(sock_file))
+        )
+    return transport.create_channel(
+        grpc_options=[("grpc.max_receive_message_length", message_size)]
+    )
+
+
 class SpeosClient:
     """
     Wraps a speos gRPC connection.
 
     Parameters
     ----------
-    host : str, optional
-        Host where the server is running.
-        By default, ``DEFAULT_HOST``.
-    port : Union[str, int], optional
-        Port number where the server is running.
-        By default, ``DEFAULT_PORT``.
-    channel : ~grpc.Channel, optional
+    channel : grpc.Channel, optional
         gRPC channel for server communication.
         By default, ``None``.
-    message_size: int
-        Maximum Message size of a newly generated channel
-        By default, ``MAX_CLIENT_MESSAGE_SIZE``.
     remote_instance : ansys.platform.instancemanagement.Instance
         The corresponding remote instance when the Speos Service
         is launched through PyPIM. This instance will be deleted when calling
@@ -143,11 +172,8 @@ class SpeosClient:
 
     def __init__(
         self,
-        host: Optional[str] = DEFAULT_HOST,
-        port: Union[str, int] = DEFAULT_PORT,
         version: str = DEFAULT_VERSION,
         channel: Optional[grpc.Channel] = None,
-        message_size: int = MAX_CLIENT_MESSAGE_SIZE,
         remote_instance: Optional["Instance"] = None,
         timeout: Optional[int] = 60,
         logging_level: Optional[int] = logging.INFO,
@@ -170,23 +196,17 @@ class SpeosClient:
         else:
             self._version = version
         if channel:
-            # Used for PyPIM when directly providing a channel
+            # grpc channel is provided by caller, used by PyPIM or Docker server
             self._channel = channel
-            self._target = str(channel)
         else:
-            self._host = host
-            self._port = port
-            self._target = f"{host}:{port}"
-            self._channel = grpc.insecure_channel(
-                self._target,
-                options=[("grpc.max_receive_message_length", message_size)],
-            )
+            self._channel = default_local_channel()
+
         # do not finish initialization until channel is healthy
         wait_until_healthy(self._channel, timeout)
 
         # once connection with the client is established, create a logger
         self._log = LOGGER.add_instance_logger(
-            name=self._target, client_instance=self, level=logging_level
+            name=self.target(), client_instance=self, level=logging_level
         )
         if logging_file:
             if isinstance(logging_file, Path):
@@ -492,7 +512,7 @@ List[ansys.speos.core.kernel.face.FaceLink]]
         """Represent the client as a string."""
         lines = []
         lines.append(f"Ansys Speos client ({hex(id(self))})")
-        lines.append(f"  Target:     {self._target}")
+        lines.append(f"  Target:     {self.target()}")
         if self._closed:
             lines.append("  Connection: Closed")
         elif self.healthy:
@@ -504,6 +524,11 @@ List[ansys.speos.core.kernel.face.FaceLink]]
     def close(self):
         """Close the channel.
 
+        .. warning::
+
+            Do not execute this function with untrusted environment variables.
+            See the :ref:`security guide<ref_security_consideration>` for details.
+
         Returns
         -------
         bool
@@ -517,7 +542,7 @@ List[ansys.speos.core.kernel.face.FaceLink]]
         wait_time = 0
         if self._remote_instance:
             self._remote_instance.delete()
-        elif self._host in ["localhost", "0.0.0.0", "127.0.0.1"] and self.__speos_exec:
+        elif self.__speos_exec:
             self.__close_local_speos_rpc_server()
             while self.healthy and wait_time < 15:
                 time.sleep(1)
@@ -543,5 +568,30 @@ List[ansys.speos.core.kernel.face.FaceLink]]
             return self._closed
 
     def __close_local_speos_rpc_server(self):
-        command = [self.__speos_exec, "-s{}".format(self._port)]
-        subprocess.run(command, check=True)
+        """Close a locally started Speos RPC server.
+
+        .. warning::
+            Do not execute this function after modifying protected or private
+            attributes of the SpeosClient class or in a context with untrusted
+            environment variables.
+            See the :ref:`security guide<ref_security_consideration>` for details.
+
+        """
+        try:
+            # Extract port number at end of target string
+            target = self.target()
+            if ":" in target:
+                port = target.split(":")[-1]
+            else:
+                port = target.split("_")[-1]
+            int(port)
+        except ValueError:
+            raise RuntimeError("The port of the local server is not a valid integer.")
+        if (
+            not Path(self.__speos_exec).is_file()
+            or Path(self.__speos_exec).stem != "SpeosRPC_Server"
+        ):
+            raise RuntimeError("Unexpected executable path for Speos rpc executable.")
+
+        command = [self.__speos_exec, f"-s{port}"]
+        subprocess.run(command, check=True)  # nosec

{ansys_speos_core-0.6.3 → ansys_speos_core-0.7.0}/src/ansys/speos/core/kernel/face.py

@@ -24,12 +24,12 @@
 
 from typing import Iterator, List
 
-from grpc import RpcError
-
 from ansys.api.speos.part.v1 import (
     face_pb2 as messages,
     face_pb2_grpc as service,
 )
+from grpc import RpcError
+
 from ansys.speos.core.generic.general_methods import min_speos_version
 from ansys.speos.core.kernel.crud import CrudItem, CrudStub
 from ansys.speos.core.kernel.proto_message_utils import protobuf_message_to_str
@@ -97,7 +97,7 @@ class FaceStub(CrudStub):
     Like in the following example:
 
     >>> from ansys.speos.core.speos import Speos
-    >>> speos = Speos(host="localhost", port=50098)
+    >>> speos = Speos()
     >>> face_db = speos.client.faces()
 
     """

ansys_speos_core-0.7.0/src/ansys/speos/core/kernel/grpc/transport_options.py

@@ -0,0 +1,171 @@
+# 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.
+
+"""Define supported transport options for the FileTransfer Tool client.
+
+This module provides classes and enumerations to configure and manage
+different transport modes (UDS, mTLS, Insecure) for the FileTransfer Tool.
+"""
+
+from dataclasses import dataclass
+import enum
+from pathlib import Path
+
+from ansys.tools.common.cyberchannel import create_channel
+
+
+class TransportMode(enum.Enum):
+    """Enumeration of transport modes supported by the FileTransfer Tool."""
+
+    UDS = "uds"
+    MTLS = "mtls"
+    INSECURE = "insecure"
+    WNUA = "wnua"
+
+
+@dataclass(kw_only=True)
+class UDSOptions:
+    """Options for UDS transport mode."""
+
+    uds_service: str | None = None
+    uds_dir: str | Path | None = None
+    uds_id: str | None = None
+    uds_fullpath: str | Path | None = None
+
+    def _to_cyberchannel_kwargs(self):
+        return {
+            "uds_service": self.uds_service,
+            "uds_dir": self.uds_dir,
+            "uds_id": self.uds_id,
+            "uds_fullpath": self.uds_fullpath,
+        }
+
+
+@dataclass(kw_only=True)
+class MTLSOptions:
+    """Options for mTLS transport mode."""
+
+    certs_dir: str | Path | None = None
+    host: str = "localhost"
+    port: int
+    allow_remote_host: bool = False
+
+    def _to_cyberchannel_kwargs(self):
+        if not self.allow_remote_host:
+            if self.host not in ("localhost", "127.0.0.1"):
+                raise ValueError(
+                    f"Remote host '{self.host}' is not allowed when "
+                    "'allow_remote_host' is set to False."
+                )
+        return {
+            "certs_dir": self.certs_dir,
+            "host": self.host,
+            "port": self.port,
+        }
+
+
+@dataclass(kw_only=True)
+class InsecureOptions:
+    """Options for insecure transport mode."""
+
+    host: str = "localhost"
+    port: int
+    allow_remote_host: bool = False
+
+    def _to_cyberchannel_kwargs(self):
+        if not self.allow_remote_host:
+            if self.host not in ("localhost", "127.0.0.1"):
+                raise ValueError(
+                    f"Remote host '{self.host}' is not allowed when "
+                    "'allow_remote_host' is set to False."
+                )
+        return {
+            "host": self.host,
+            "port": self.port,
+        }
+
+
+@dataclass(kw_only=True)
+class WNUAOptions:
+    """Options for Windows Named User Authentication transport mode."""
+
+    host: str = "localhost"
+    port: int
+
+    def _to_cyberchannel_kwargs(self):
+        return {
+            "host": self.host,
+            "port": self.port,
+        }
+
+
+@dataclass(kw_only=True)
+class TransportOptions:
+    """Transport options for the FileTransfer Tool client."""
+
+    mode: TransportMode
+    options: UDSOptions | MTLSOptions | InsecureOptions | WNUAOptions
+
+    def __init__(
+        self,
+        mode: TransportMode | str = "uds",
+        options: UDSOptions | MTLSOptions | InsecureOptions | WNUAOptions | None = None,
+    ):
+        if isinstance(mode, str):
+            mode = TransportMode(mode)
+        if options is None:
+            if mode != TransportMode.UDS:
+                raise RuntimeError("TransportOptions must be provided for modes other than UDS.")
+            # The default cannot be set in the constructor signature
+            # since '_get_uds_dir_default' may raise.
+            options = UDSOptions()
+
+        if mode == TransportMode.UDS:
+            if not isinstance(options, UDSOptions):
+                raise TypeError("For UDS transport mode, options must be of type UDSOptions.")
+        elif mode == TransportMode.MTLS:
+            if not isinstance(options, MTLSOptions):
+                raise TypeError("For mTLS transport mode, options must be of type MTLSOptions.")
+        elif mode == TransportMode.INSECURE:
+            if not isinstance(options, InsecureOptions):
+                raise TypeError(
+                    "For Insecure transport mode, options must be of type InsecureOptions."
+                )
+        elif mode == TransportMode.WNUA:
+            if not isinstance(options, WNUAOptions):
+                raise TypeError("For WNUA transport mode, options must be of type WNUAOptions.")
+        else:
+            raise ValueError(f"Unsupported transport mode: {mode}")
+
+        self.mode = mode
+        self.options = options
+
+    def _to_cyberchannel_kwargs(self):
+        """Convert transport options to cyberchannel kwargs."""
+        return {
+            "transport_mode": self.mode.value,
+            **self.options._to_cyberchannel_kwargs(),
+        }
+
+    def create_channel(self, grpc_options):
+        """Create a gRPC channel based on the transport options."""
+        return create_channel(**self._to_cyberchannel_kwargs(), grpc_options=grpc_options)

{ansys_speos_core-0.6.3 → ansys_speos_core-0.7.0}/src/ansys/speos/core/kernel/intensity_template.py

@@ -28,6 +28,7 @@ from ansys.api.speos.intensity.v1 import (
     intensity_pb2 as messages,
     intensity_pb2_grpc as service,
 )
+
 from ansys.speos.core.kernel.crud import CrudItem, CrudStub
 from ansys.speos.core.kernel.proto_message_utils import protobuf_message_to_str
 
@@ -55,7 +56,7 @@ class IntensityTemplateLink(CrudItem):
     >>> from ansys.speos.core.kernel.intensity_template import (
     ...     ProtoIntensityTemplate,
     ... )
-    >>> speos = Speos(host="localhost", port=50098)
+    >>> speos = Speos()
     >>> int_t_db = speos.client.intensity_templates()
     >>> int_t_message = ProtoIntensityTemplate(name="Cos_3_170")
     >>> int_t_message.cos.N = 3.0
@@ -126,7 +127,7 @@ class IntensityTemplateStub(CrudStub):
     intensity_templates() method. Like in the following example:
 
     >>> from ansys.speos.core.speos import Speos
-    >>> speos = Speos(host="localhost", port=50098)
+    >>> speos = Speos()
     >>> int_t_db = speos.client.intensity_templates()
 
     """