added pythonnet check with warning output

.github/workflows/ci_cd.yml

@@ -158,6 +158,7 @@ jobs:
           apt update
           apt install -y lsb-release
           apt install -y python3-pip
+          apt install -y python3.8-venv
           pip3 install --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org pip setuptools
           pip3 install --upgrade pip flit
       - name: Install packages for testing
@@ -221,6 +222,7 @@ jobs:
           apt update
           apt install -y lsb-release
           apt install -y python3-pip
+          apt install -y python3.8-venv
           pip3 install --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org pip setuptools
           pip3 install --upgrade pip flit
       - name: Install packages for testing

CHANGELOG.md

@@ -12,6 +12,7 @@ This document follows the conventions laid out in [Keep a CHANGELOG](https://kee
 -   changelog (#222)
 -   add link to embedding examples (#228)
 -   Add `close()` method to `Ansys.Mechanical.Embedding.Application`. See (#229)
+-   Add check if pythonnet exists in the user environment (#235)
 
 ### Changed
 

src/ansys/mechanical/core/embedding/initializer.py

@@ -1,7 +1,9 @@
 """Initializer for Mechanical embedding. Sets up paths and resolvers."""
+from importlib.metadata import distribution
 import os
 from pathlib import Path
 import sys
+import warnings
 
 from ansys.mechanical.core.embedding.loader import load_clr
 from ansys.mechanical.core.embedding.resolver import resolve
@@ -38,6 +40,18 @@ def initialize(version):
     # need to add system path in order to import the assembly with the resolver
     __add_sys_path(version)
 
+    # Check if 'pythonnet' is installed... and if so, throw warning
+    try:
+        distribution("pythonnet")
+        warnings.warn(
+            "The pythonnet package was found in your environment "
+            "which interferes with the ansys-pythonnet package. "
+            "Some APIs may not work due to pythonnet being installed.",
+            stacklevel=2,
+        )
+    except ModuleNotFoundError:
+        pass
+
     # load the CLR with mono that is shipped with the unified ansys installer
     load_clr(os.environ[f"AWP_ROOT{version}"])
 

tests/embedding/test_app.py

@@ -1,6 +1,8 @@
 """Miscellaneous embedding tests"""
 import os
 import shutil
+import subprocess
+import sys
 import tempfile
 
 import pytest
@@ -52,3 +54,60 @@ def test_app_version(embedded_app):
     version = embedded_app.version
     assert type(version) is int
     assert version >= 231
+
+
+@pytest.mark.embedding
+def test_warning_message():
+    """Test pythonnet warning of the embedded instance."""
+    venv_name = "pythonnetvenv"
+    base = os.getcwd()
+
+    if "win" in sys.platform:
+        exe_dir = "Scripts"
+    else:
+        exe_dir = "bin"
+
+    venv_bin = os.path.join(base, "." + venv_name, exe_dir)
+
+    # Set up path to use the virtual environment
+    original_path = os.environ["PATH"]
+    os.environ["PATH"] = venv_bin + os.pathsep + os.environ.get("PATH", "")
+
+    # Create virtual environment
+    subprocess.run([sys.executable, "-m", "venv", "." + venv_name])
+
+    # Upgrade pip
+    upgrade_pip = subprocess.Popen(
+        [os.path.join(venv_bin, "python"), "-m", "pip", "install", "-U", "pip"]
+    )
+    upgrade_pip.wait()
+
+    # Install tests
+    install_tests = subprocess.Popen([os.path.join(venv_bin, "pip"), "install", "-e", ".[tests]"])
+    install_tests.wait()
+
+    # Install pythonnet
+    install_pythonnet = subprocess.Popen([os.path.join(venv_bin, "pip"), "install", "pythonnet"])
+    install_pythonnet.wait()
+
+    # Run embedded instance in virtual env with pythonnet installed
+    embedded_py = os.path.join(base, "tests", "scripts", "run_embedded_app.py")
+    check_warning = subprocess.Popen(
+        [os.path.join(venv_bin, "python"), embedded_py], stderr=subprocess.PIPE
+    )
+    check_warning.wait()
+    stderr_output = check_warning.stderr.read().decode()
+
+    # If UserWarning & pythonnet are in the stderr output, set warning to True.
+    # Otherwise, set warning to False
+    warning = True if "UserWarning" and "pythonnet" in stderr_output else False
+
+    # Assert warning message appears for embedded app
+    assert warning
+
+    # Remove virtual environment
+    venv_dir = os.path.join(base, "." + venv_name)
+    shutil.rmtree(venv_dir)
+
+    # Set PATH back to what it was originally
+    os.environ["PATH"] = original_path

tests/scripts/run_embedded_app.py

@@ -0,0 +1,5 @@
+"""Launch embedded instance."""
+import ansys.mechanical.core as pymechanical
+
+# Launch embedded instance of app
+app = pymechanical.App()

tests/scripts/run_remote_session.py

@@ -0,0 +1,5 @@
+"""Launch remote session."""
+import ansys.mechanical.core as pymechanical
+
+# Launch remote session
+pymechanical.launch_mechanical()

tests/test_mechanical.py

@@ -2,6 +2,9 @@
 import os
 import pathlib
 import re
+import shutil
+import subprocess
+import sys
 
 import grpc
 import pytest
@@ -510,6 +513,82 @@ def test_launch_grpc_not_supported_version():
         pymechanical.mechanical.launch_grpc(exec_file=exec_file)
 
 
+@pytest.mark.remote_session_launch
+def test_warning_message_pythonnet():
+    """Test pythonnet warning of the remote session in virtual env."""
+    venv_name = "pythonnetvenv"
+    base = os.getcwd()
+
+    if "win" in sys.platform:
+        exe_dir = "Scripts"
+    else:
+        exe_dir = "bin"
+
+    venv_bin = os.path.join(base, "." + venv_name, exe_dir)
+
+    # Set up path to use the virtual environment
+    original_path = os.environ["PATH"]
+    os.environ["PATH"] = venv_bin + os.pathsep + os.environ.get("PATH", "")
+
+    # Create virtual environment
+    subprocess.run([sys.executable, "-m", "venv", "." + venv_name])
+
+    # Upgrade pip
+    upgrade_pip = subprocess.Popen(
+        [os.path.join(venv_bin, "python"), "-m", "pip", "install", "-U", "pip"]
+    )
+    upgrade_pip.wait()
+
+    # Install tests
+    install_tests = subprocess.Popen([os.path.join(venv_bin, "pip"), "install", "-e", ".[tests]"])
+    install_tests.wait()
+
+    # Install pythonnet
+    install_pythonnet = subprocess.Popen([os.path.join(venv_bin, "pip"), "install", "pythonnet"])
+    install_pythonnet.wait()
+
+    # Run remote session in virtual env with pythonnet installed
+    remote_py = os.path.join(base, "tests", "scripts", "run_remote_session.py")
+    check_warning = subprocess.Popen(
+        [os.path.join(venv_bin, "python"), remote_py], stderr=subprocess.PIPE
+    )
+    check_warning.wait()
+    stderr_output = check_warning.stderr.read().decode()
+
+    # If UserWarning & pythonnet are in the stderr output, set warning to True.
+    # Otherwise, set warning to False
+    warning = True if "UserWarning" and "pythonnet" in stderr_output else False
+
+    # Assert the warning message did not appear for the remote session
+    assert not warning
+
+    # Remove virtual environment
+    venv_dir = os.path.join(base, "." + venv_name)
+    shutil.rmtree(venv_dir)
+
+    # Set PATH back to what it was originally
+    os.environ["PATH"] = original_path
+
+
+@pytest.mark.remote_session_launch
+def test_warning_message_default():
+    """Test pythonnet warning of the remote session in default env."""
+    base = os.getcwd()
+
+    # Run remote session
+    remote_py = os.path.join(base, "tests", "scripts", "run_remote_session.py")
+    check_warning = subprocess.Popen([sys.executable, remote_py], stderr=subprocess.PIPE)
+    check_warning.wait()
+    stderr_output = check_warning.stderr.read().decode()
+
+    # If UserWarning & pythonnet are in the stderr output, set warning to True.
+    # Otherwise, set warning to False
+    warning = True if "UserWarning" and "pythonnet" in stderr_output else False
+
+    # Assert the warning message did not appear for the remote session
+    assert not warning
+
+
 # def test_call_before_launch_or_connect():
 #     import ansys.mechanical.core as pymechanical
 #     from ansys.mechanical.core.errors import MechanicalExitedError