ansys-mechanical-core 0.11.12__py3-none-any.whl → 0.11.13__py3-none-any.whl

ansys/mechanical/core/embedding/rpc/utils.py

@@ -0,0 +1,120 @@
+# Copyright (C) 2022 - 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.
+"""Utilities necessary for remote calls."""
+import typing
+
+
+class remote_method:
+    """Decorator for passing remote methods."""
+
+    def __init__(self, func):
+        """Initialize with the given function."""
+        self._func = func
+
+    def __call__(self, *args, **kwargs):
+        """Call the stored function with provided arguments."""
+        return self._func(*args, **kwargs)
+
+    def __call_method__(self, instance, *args, **kwargs):
+        """Call the stored function with the instance and provided arguments."""
+        return self._func(instance, *args, **kwargs)
+
+    def __get__(self, obj, objtype):
+        """Return a partially applied method."""
+        from functools import partial
+
+        func = partial(self.__call_method__, obj)
+        func._is_remote = True
+        func.__name__ = self._func.__name__
+        func._owner = obj
+        return func
+
+
+class MethodType:
+    """Enum for method or property types."""
+
+    METHOD = 0
+    PROP = 1
+
+
+def try_get_remote_method(methodname: str, obj: typing.Any) -> typing.Tuple[str, typing.Callable]:
+    """Try to get a remote method."""
+    method = getattr(obj, methodname)
+    if not callable(method):
+        return None
+    if hasattr(method, "_is_remote") and method._is_remote is True:
+        return (methodname, method)
+
+
+def try_get_remote_property(attrname: str, obj: typing.Any) -> typing.Tuple[str, property]:
+    """Try to get a remote property."""
+    objclass: typing.Type = obj.__class__
+    class_attribute = getattr(objclass, attrname)
+    getmethod = None
+    setmethod = None
+
+    if class_attribute.fget:
+        if isinstance(class_attribute.fget, remote_method):
+            getmethod = class_attribute.fget
+            getmethod._owner = obj
+    if class_attribute.fset:
+        if isinstance(class_attribute.fset, remote_method):
+            setmethod = class_attribute.fset
+            setmethod._owner = obj
+
+    return (attrname, property(getmethod, setmethod))
+
+
+def get_remote_methods(
+    obj,
+) -> typing.Generator[typing.Tuple[str, typing.Callable, MethodType], None, None]:
+    """Yield names and methods of an object's remote methods.
+
+    A remote method is identified by the presence of an attribute `_is_remote` set to `True`.
+
+    Parameters
+    ----------
+    obj: Any
+        The object to inspect for remote methods.
+
+    Yields
+    ------
+    Generator[Tuple[str, Callable], None, None]
+        A tuple containing the method name and the method itself
+        for each remote method found in the object
+    """
+    print(f"Getting remote methods on {obj}")
+    objclass = obj.__class__
+    for attrname in dir(obj):
+        if attrname.startswith("__"):
+            continue
+        print(attrname)
+        if hasattr(objclass, attrname):
+            class_attribute = getattr(objclass, attrname)
+            if isinstance(class_attribute, property):
+                attrname, prop = try_get_remote_property(attrname, obj)
+                yield attrname, prop, MethodType.PROP
+                continue
+        result = try_get_remote_method(attrname, obj)
+        if result != None:
+            attrname, method = result
+            yield attrname, method, MethodType.METHOD

ansys/mechanical/core/embedding/runtime.py

@@ -22,6 +22,7 @@
 
 """Runtime initialize for pythonnet in embedding."""
 
+from importlib.metadata import distribution
 import os
 
 from ansys.mechanical.core.embedding.logger import Logger
@@ -44,6 +45,25 @@ def __register_function_codec():
     Ansys.Mechanical.CPython.Codecs.FunctionCodec.Register()
 
 
+def _bind_assembly_for_explicit_interface(assembly_name: str):
+    """Bind the assembly for explicit interface implementation."""
+    # if pythonnet is not installed, we can't bind the assembly
+    try:
+        distribution("pythonnet")
+        return
+    except ModuleNotFoundError:
+        pass
+
+    import clr
+
+    assembly = clr.AddReference(assembly_name)
+    from Python.Runtime import BindingManager, BindingOptions
+
+    binding_options = BindingOptions()
+    binding_options.AllowExplicitInterfaceImplementation = True
+    BindingManager.SetBindingOptions(assembly, binding_options)
+
+
 def initialize(version: int) -> None:
     """Initialize the runtime.
 
@@ -59,3 +79,5 @@ def initialize(version: int) -> None:
         # function codec is distributed with pymechanical on linux only
         # at version 242 or later
         __register_function_codec()
+
+    _bind_assembly_for_explicit_interface("Ansys.ACT.WB1")

ansys/mechanical/core/feature_flags.py

@@ -31,6 +31,7 @@ class FeatureFlags:
 
     ThermalShells = "Mechanical.ThermalShells"
     MultistageHarmonic = "Mechanical.MultistageHarmonic"
+    CPython = "Mechanical.CPython.Capability"
 
 
 def get_feature_flag_names() -> typing.List[str]:

ansys/mechanical/core/ide_config.py

@@ -1,212 +1,212 @@
-# Copyright (C) 2022 - 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.
-
-"""Convenience CLI to run mechanical."""
-
-import json
-import os
-from pathlib import Path
-import re
-import site
-import sys
-
-import ansys.tools.path as atp
-import click
-
-
-def get_stubs_location():
-    """Find the ansys-mechanical-stubs installation location in site-packages.
-
-    Returns
-    -------
-    pathlib.Path
-        The path to the ansys-mechanical-stubs installation in site-packages.
-    """
-    site_packages = site.getsitepackages()
-    prefix_path = sys.prefix.replace("\\", "\\\\")
-    site_packages_regex = re.compile(f"{prefix_path}.*site-packages$")
-    site_packages_paths = list(filter(site_packages_regex.match, site_packages))
-
-    if len(site_packages_paths) == 1:
-        # Get the stubs location
-        stubs_location = Path(site_packages_paths[0]) / "ansys" / "mechanical" / "stubs"
-        return stubs_location
-
-    raise Exception("Could not retrieve the location of the ansys-mechanical-stubs package.")
-
-
-def get_stubs_versions(stubs_location: Path):
-    """Retrieve the revision numbers in ansys-mechanical-stubs.
-
-    Parameters
-    ----------
-    pathlib.Path
-        The path to the ansys-mechanical-stubs installation in site-packages.
-
-    Returns
-    -------
-    list
-        The list containing minimum and maximum versions in the ansys-mechanical-stubs package.
-    """
-    # Get revision numbers in stubs folder
-    revns = [
-        int(revision[1:])
-        for revision in os.listdir(stubs_location)
-        if os.path.isdir(os.path.join(stubs_location, revision)) and revision.startswith("v")
-    ]
-    return revns
-
-
-def _vscode_impl(
-    target: str = "user",
-    revision: int = None,
-):
-    """Get the IDE configuration for autocomplete in VS Code.
-
-    Parameters
-    ----------
-    target: str
-        The type of settings to update. Either "user" or "workspace" in VS Code.
-        By default, it's ``user``.
-    revision: int
-        The Mechanical revision number. For example, "251".
-        If unspecified, it finds the default Mechanical version from ansys-tools-path.
-    """
-    # Update the user or workspace settings
-    if target == "user":
-        # Get the path to the user's settings.json file depending on the platform
-        if "win" in sys.platform:
-            settings_json = (
-                Path(os.environ.get("APPDATA")) / "Code" / "User" / "settings.json"
-            )  # pragma: no cover
-        elif "lin" in sys.platform:
-            settings_json = (
-                Path(os.environ.get("HOME")) / ".config" / "Code" / "User" / "settings.json"
-            )
-    elif target == "workspace":
-        # Get the current working directory
-        current_dir = Path.cwd()
-        # Get the path to the settings.json file based on the git root & .vscode folder
-        settings_json = current_dir / ".vscode" / "settings.json"
-
-    # Location where the stubs are installed -> .venv/Lib/site-packages, for example
-    stubs_location = get_stubs_location() / f"v{revision}"
-
-    # The settings to add to settings.json for autocomplete to work
-    settings_json_data = {
-        "python.autoComplete.extraPaths": [str(stubs_location)],
-        "python.analysis.extraPaths": [str(stubs_location)],
-    }
-    # Pretty print dictionary
-    pretty_dict = json.dumps(settings_json_data, indent=4)
-
-    print(f"Update {settings_json} with the following information:\n")
-
-    if target == "workspace":
-        print(
-            "Note: Please ensure the .vscode folder is in the root of your project or repository.\n"
-        )
-
-    print(pretty_dict)
-
-
-def _cli_impl(
-    ide: str = "vscode",
-    target: str = "user",
-    revision: int = None,
-):
-    """Provide the user with the path to the settings.json file and IDE settings.
-
-    Parameters
-    ----------
-    ide: str
-        The IDE to set up autocomplete settings. By default, it's ``vscode``.
-    target: str
-        The type of settings to update. Either "user" or "workspace" in VS Code.
-        By default, it's ``user``.
-    revision: int
-        The Mechanical revision number. For example, "251".
-        If unspecified, it finds the default Mechanical version from ansys-tools-path.
-    """
-    # Get the ansys-mechanical-stubs install location
-    stubs_location = get_stubs_location()
-    # Get all revision numbers available in ansys-mechanical-stubs
-    revns = get_stubs_versions(stubs_location)
-    # Check the IDE and raise an exception if it's not VS Code
-    if revision < min(revns) or revision > max(revns):
-        raise Exception(f"PyMechanical Stubs are not available for {revision}")
-    elif ide != "vscode":
-        raise Exception(f"{ide} is not supported at the moment.")
-    else:
-        return _vscode_impl(target, revision)
-
-
-@click.command()
-@click.help_option("--help", "-h")
-@click.option(
-    "--ide",
-    default="vscode",
-    type=str,
-    help="The IDE being used. By default, it's ``vscode``.",
-)
-@click.option(
-    "--target",
-    default="user",
-    type=str,
-    help="The type of settings to update - either ``user`` or ``workspace`` settings in VS Code.",
-)
-@click.option(
-    "--revision",
-    default=None,
-    type=int,
-    help='The Mechanical revision number, e.g. "251" or "242". If unspecified,\
-it finds and uses the default version from ansys-tools-path.',
-)
-def cli(ide: str, target: str, revision: int) -> None:
-    """CLI tool to update settings.json files for autocomplete with ansys-mechanical-stubs.
-
-    Parameters
-    ----------
-    ide: str
-        The IDE to set up autocomplete settings. By default, it's ``vscode``.
-    target: str
-        The type of settings to update. Either "user" or "workspace" in VS Code.
-        By default, it's ``user``.
-    revision: int
-        The Mechanical revision number. For example, "251".
-        If unspecified, it finds the default Mechanical version from ansys-tools-path.
-
-    Usage
-    -----
-    The following example demonstrates the main use of this tool:
-
-        $ ansys-mechanical-ideconfig --ide vscode --target user --revision 251
-
-    """
-    exe = atp.get_mechanical_path(allow_input=False, version=revision)
-    version = atp.version_from_path("mechanical", exe)
-
-    return _cli_impl(
-        ide,
-        target,
-        version,
-    )
+# Copyright (C) 2022 - 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.
+
+"""Convenience CLI to run mechanical."""
+
+import json
+import os
+from pathlib import Path
+import re
+import site
+import sys
+
+import ansys.tools.path as atp
+import click
+
+
+def get_stubs_location():
+    """Find the ansys-mechanical-stubs installation location in site-packages.
+
+    Returns
+    -------
+    pathlib.Path
+        The path to the ansys-mechanical-stubs installation in site-packages.
+    """
+    site_packages = site.getsitepackages()
+    prefix_path = sys.prefix.replace("\\", "\\\\")
+    site_packages_regex = re.compile(f"{prefix_path}.*site-packages$")
+    site_packages_paths = list(filter(site_packages_regex.match, site_packages))
+
+    if len(site_packages_paths) == 1:
+        # Get the stubs location
+        stubs_location = Path(site_packages_paths[0]) / "ansys" / "mechanical" / "stubs"
+        return stubs_location
+
+    raise Exception("Could not retrieve the location of the ansys-mechanical-stubs package.")
+
+
+def get_stubs_versions(stubs_location: Path):
+    """Retrieve the revision numbers in ansys-mechanical-stubs.
+
+    Parameters
+    ----------
+    pathlib.Path
+        The path to the ansys-mechanical-stubs installation in site-packages.
+
+    Returns
+    -------
+    list
+        The list containing minimum and maximum versions in the ansys-mechanical-stubs package.
+    """
+    # Get revision numbers in stubs folder
+    revns = [
+        int(revision[1:])
+        for revision in os.listdir(stubs_location)
+        if os.path.isdir(os.path.join(stubs_location, revision)) and revision.startswith("v")
+    ]
+    return revns
+
+
+def _vscode_impl(
+    target: str = "user",
+    revision: int = None,
+):
+    """Get the IDE configuration for autocomplete in VS Code.
+
+    Parameters
+    ----------
+    target: str
+        The type of settings to update. Either "user" or "workspace" in VS Code.
+        By default, it's ``user``.
+    revision: int
+        The Mechanical revision number. For example, "251".
+        If unspecified, it finds the default Mechanical version from ansys-tools-path.
+    """
+    # Update the user or workspace settings
+    if target == "user":
+        # Get the path to the user's settings.json file depending on the platform
+        if "win" in sys.platform:
+            settings_json = (
+                Path(os.environ.get("APPDATA")) / "Code" / "User" / "settings.json"
+            )  # pragma: no cover
+        elif "lin" in sys.platform:
+            settings_json = (
+                Path(os.environ.get("HOME")) / ".config" / "Code" / "User" / "settings.json"
+            )
+    elif target == "workspace":
+        # Get the current working directory
+        current_dir = Path.cwd()
+        # Get the path to the settings.json file based on the git root & .vscode folder
+        settings_json = current_dir / ".vscode" / "settings.json"
+
+    # Location where the stubs are installed -> .venv/Lib/site-packages, for example
+    stubs_location = get_stubs_location() / f"v{revision}"
+
+    # The settings to add to settings.json for autocomplete to work
+    settings_json_data = {
+        "python.autoComplete.extraPaths": [str(stubs_location)],
+        "python.analysis.extraPaths": [str(stubs_location)],
+    }
+    # Pretty print dictionary
+    pretty_dict = json.dumps(settings_json_data, indent=4)
+
+    print(f"Update {settings_json} with the following information:\n")
+
+    if target == "workspace":
+        print(
+            "Note: Please ensure the .vscode folder is in the root of your project or repository.\n"
+        )
+
+    print(pretty_dict)
+
+
+def _cli_impl(
+    ide: str = "vscode",
+    target: str = "user",
+    revision: int = None,
+):
+    """Provide the user with the path to the settings.json file and IDE settings.
+
+    Parameters
+    ----------
+    ide: str
+        The IDE to set up autocomplete settings. By default, it's ``vscode``.
+    target: str
+        The type of settings to update. Either "user" or "workspace" in VS Code.
+        By default, it's ``user``.
+    revision: int
+        The Mechanical revision number. For example, "251".
+        If unspecified, it finds the default Mechanical version from ansys-tools-path.
+    """
+    # Get the ansys-mechanical-stubs install location
+    stubs_location = get_stubs_location()
+    # Get all revision numbers available in ansys-mechanical-stubs
+    revns = get_stubs_versions(stubs_location)
+    # Check the IDE and raise an exception if it's not VS Code
+    if revision < min(revns) or revision > max(revns):
+        raise Exception(f"PyMechanical Stubs are not available for {revision}")
+    elif ide != "vscode":
+        raise Exception(f"{ide} is not supported at the moment.")
+    else:
+        return _vscode_impl(target, revision)
+
+
+@click.command()
+@click.help_option("--help", "-h")
+@click.option(
+    "--ide",
+    default="vscode",
+    type=str,
+    help="The IDE being used. By default, it's ``vscode``.",
+)
+@click.option(
+    "--target",
+    default="user",
+    type=str,
+    help="The type of settings to update - either ``user`` or ``workspace`` settings in VS Code.",
+)
+@click.option(
+    "--revision",
+    default=None,
+    type=int,
+    help='The Mechanical revision number, e.g. "251" or "242". If unspecified,\
+it finds and uses the default version from ansys-tools-path.',
+)
+def cli(ide: str, target: str, revision: int) -> None:
+    """CLI tool to update settings.json files for autocomplete with ansys-mechanical-stubs.
+
+    Parameters
+    ----------
+    ide: str
+        The IDE to set up autocomplete settings. By default, it's ``vscode``.
+    target: str
+        The type of settings to update. Either "user" or "workspace" in VS Code.
+        By default, it's ``user``.
+    revision: int
+        The Mechanical revision number. For example, "251".
+        If unspecified, it finds the default Mechanical version from ansys-tools-path.
+
+    Usage
+    -----
+    The following example demonstrates the main use of this tool:
+
+        $ ansys-mechanical-ideconfig --ide vscode --target user --revision 251
+
+    """
+    exe = atp.get_mechanical_path(allow_input=False, version=revision)
+    version = atp.version_from_path("mechanical", exe)
+
+    return _cli_impl(
+        ide,
+        target,
+        version,
+    )