iris-pex-embedded-python 3.4.1b8__tar.gz → 3.4.1b10__tar.gz

{iris_pex_embedded_python-3.4.1b8/src/iris_pex_embedded_python.egg-info → iris_pex_embedded_python-3.4.1b10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iris_pex_embedded_python
-Version: 3.4.1b8
+Version: 3.4.1b10
 Summary: Iris Interoperability based on Embedded Python
 Author-email: grongier <guillaume.rongier@intersystems.com>
 License: MIT License
@@ -49,6 +49,7 @@ Requires-Dist: xmltodict>=0.12.0
 Requires-Dist: iris-embedded-python-wrapper>=0.0.6
 Requires-Dist: setuptools>=40.8.0
 Requires-Dist: jsonpath-ng>=1.7.0
+Requires-Dist: debugpy>=1.8.0
 Dynamic: license-file
 
 # IoP (Interoperability On Python)

{iris_pex_embedded_python-3.4.1b8 → iris_pex_embedded_python-3.4.1b10}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools", "wheel"]
 
 [project]
 name = "iris_pex_embedded_python"
-version = "3.4.1b8"
+version = "3.4.1b10"
 description = "Iris Interoperability based on Embedded Python"
 readme = "README.md"
 authors = [
@@ -31,7 +31,8 @@ dependencies = [
     "xmltodict>=0.12.0",
     "iris-embedded-python-wrapper>=0.0.6",
     "setuptools>=40.8.0",
-    "jsonpath-ng>=1.7.0"
+    "jsonpath-ng>=1.7.0",
+    "debugpy>=1.8.0",
 ]
 
 license = { file = "LICENSE" }

{iris_pex_embedded_python-3.4.1b8 → iris_pex_embedded_python-3.4.1b10}/src/iop/_business_service.py

@@ -16,6 +16,12 @@ class _BusinessService(_BusinessHost):
     Adapter = adapter = None
     _wait_for_next_call_interval = False
 
+    def _dispatch_on_init(self, host_object) -> None:
+        """For internal use only."""
+        self.on_init()
+
+        return
+
     def on_process_input(self, message_input):
         """ Receives the message from the inbond adapter via the PRocessInput method and is responsible for forwarding it to target business processes or operations.
         If the business service does not specify an adapter, then the default adapter calls this method with no message 

{iris_pex_embedded_python-3.4.1b8 → iris_pex_embedded_python-3.4.1b10}/src/iop/_common.py

@@ -1,12 +1,15 @@
 import abc
 import inspect
 import traceback
+
 from typing import Any, ClassVar, List, Optional, Tuple
 
 from . import _iris
 
 from iop._log_manager import LogManager, logging
 
+from iop._debugpy import debugpython
+
 class _Common(metaclass=abc.ABCMeta):
     """Base class that defines common methods for all component types.
     
@@ -57,6 +60,7 @@ class _Common(metaclass=abc.ABCMeta):
         self.on_connected()
 
     def _dispatch_on_init(self, host_object: Any) -> None:
+        """Initialize component when started."""
         self.on_init()
 
     def _dispatch_on_tear_down(self, host_object: Any) -> None:
@@ -66,6 +70,11 @@ class _Common(metaclass=abc.ABCMeta):
         """Internal method to set IRIS handles."""
         pass
 
+    def _debugpy(self, host) -> None:
+        """Set up debugpy for debugging."""
+        if debugpython is not None:
+            debugpython(self=self, host_object=host)
+
     # Component information methods
     @classmethod
     def _get_info(cls) -> List[str]:

iris_pex_embedded_python-3.4.1b10/src/iop/_debugpy.py

@@ -0,0 +1,145 @@
+
+import threading
+import time
+import contextlib
+import socket
+import os
+import sys
+from contextlib import closing
+from typing import Optional, cast, Any, Dict
+
+def find_free_port(start: Optional[int] = None, end: Optional[int] = None) -> int:
+    port = start
+    if port is None:
+        port = 0
+    if end is None:
+        end = port
+
+    try:
+        with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
+            with contextlib.suppress(Exception):
+                s.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, 0)
+
+            s.bind(("0.0.0.0", port))
+
+            s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+            return cast(int, s.getsockname()[1])
+    except (SystemExit, KeyboardInterrupt):
+        raise
+    except BaseException:
+        if port and end > port:
+            return find_free_port(port + 1, end)
+        if start and start > 0:
+            return find_free_port(None)
+        raise
+
+def is_debugpy_installed() -> bool:
+    try:
+        __import__("debugpy")
+        return True
+    except ImportError:
+        return False
+
+def _get_python_interpreter_path(install_dir: Optional[str]) -> Optional[str]:
+    """Get the path to the Python interpreter."""
+    if not install_dir:
+        return None
+        
+    python_exe = 'irispython.exe' if sys.platform == 'win32' else 'irispython'
+    python_path = os.path.join(install_dir, 'bin', python_exe)
+    
+    return python_path if os.path.exists(python_path) else None
+
+def _get_debugpy_config(python_path: str) -> Dict[str, str]:
+    """Get the debugpy configuration."""
+    return {"python": python_path}
+
+def configure_debugpy(self, python_path: Optional[str] = None) -> bool:
+    """Configure debugpy with the appropriate Python interpreter."""
+    import debugpy
+
+    if not python_path:
+        install_dir = os.environ.get('IRISINSTALLDIR') or os.environ.get('ISC_PACKAGE_INSTALLDIR')
+        python_path = _get_python_interpreter_path(install_dir)
+        
+    if not python_path:
+        self.log_alert("Could not determine Python interpreter path")
+        return False
+
+    try:
+        debugpy.configure(_get_debugpy_config(python_path))
+        self.log_info(f"Debugpy configured with Python interpreter: {python_path}")
+        return True
+    except Exception as e:
+        self.log_alert(f"Failed to configure debugpy: {e}")
+        return False
+
+def wait_for_debugpy_connected(timeout: float = 30, port: int = 0) -> bool:
+    """Wait for debugpy client to connect."""
+    import debugpy
+
+    if not is_debugpy_installed():
+        return False
+
+    def timeout_handler():
+        time.sleep(timeout)
+        debugpy.wait_for_client.cancel()
+
+    threading.Thread(target=timeout_handler, daemon=True).start()
+    
+    try:
+        debugpy.wait_for_client()
+        return debugpy.is_client_connected()
+    except Exception:
+        import pydevd # type: ignore
+        pydevd.stoptrace()
+        return False
+
+def enable_debugpy(port: int, address: str = "0.0.0.0") -> None:
+    """Enable debugpy server on specified port and address."""
+    import debugpy
+    debugpy.listen((address, port))
+
+def debugpython(self, host_object: Any) -> None:
+    """Enable and configure debugpy for debugging purposes."""
+    # hack to set __file__ for os module in debugpy
+    # This is a workaround for the issue where debugpy cannot find the __file__ attribute of the os module.
+    if not hasattr(os, '__file__'):
+        setattr(os, '__file__', __file__)
+
+
+    if host_object is None:
+        self.log_alert("No host object found, cannot enable debugpy.")
+        return
+
+    if host_object.enable != 1:
+        self.log_info("Debugpy is not enabled.")
+        return
+
+    if not is_debugpy_installed():
+        self.log_alert("Debugpy is not installed.")
+        return
+
+    # Configure Python interpreter
+    if host_object.PythonInterpreterPath != '':
+        success = configure_debugpy(self, host_object.PythonInterpreterPath)
+    else:
+        success = configure_debugpy(self)
+
+    if not success:
+        return
+
+    # Setup debugging server
+    port = host_object.port if host_object.port and host_object.port > 0 else find_free_port()
+    
+    try:
+        enable_debugpy(port=port)
+        self.log_info(f"Debugpy enabled on port {port}")
+        
+        self.trace(f"Waiting {host_object.timeout} seconds for debugpy connection...")
+        if wait_for_debugpy_connected(timeout=host_object.timeout, port=port):
+            self.log_info("Debugpy connected successfully")
+        else:
+            self.log_alert(f"Debugpy connection timed out after {host_object.timeout} seconds")
+    except Exception as e:
+        self.log_alert(f"Error enabling debugpy: {e}")

{iris_pex_embedded_python-3.4.1b8 → iris_pex_embedded_python-3.4.1b10}/src/iop/cls/IOP/Common.cls

@@ -40,7 +40,9 @@ Method GetModule() As %String
 Method %OnNew(pConfigName As %String) As %Status
 {
     $$$ThrowOnError(..Connect())
-	Quit $method($this,"initConfig",.pConfigName) ; call subclass
+	$$$ThrowOnError($method($this,"initConfig",.pConfigName)) ; call subclass
+    do ..%class."_debugpy"($this)
+    Quit $$$OK
 }
 
 Method OnInit() As %Status

{iris_pex_embedded_python-3.4.1b8 → iris_pex_embedded_python-3.4.1b10}/src/iop/cls/IOP/Utils.cls

@@ -61,7 +61,7 @@ ClassMethod DeleteComponentProxy(pClassname As %String = "") As %Status
 {
 	#dim tSC As %Status = $$$OK
 	#dim ex As %Exception.AbstractException
-	#dim tIsPEX As %Boolean = 0
+	#dim tIsIOP As %Boolean = 0
 	#dim tClass As %Dictionary.CompiledClass
 	
 	Quit:(""=pClassname) $$$ERROR($$$EnsErrGeneral,"Remote class name must be specified.")
@@ -79,16 +79,16 @@ ClassMethod DeleteComponentProxy(pClassname As %String = "") As %Status
 				Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Proxy class for remote class '%1' could not be opened.",pClassname))
 				Quit
 			}
-			Set tIsPEX = ("IOP.Utils" = tClass.GeneratedBy)
+			Set tIsIOP = ("IOP.Utils" = tClass.GeneratedBy)
 		}
-		If tIsPEX {
+		If tIsIOP {
 			Set tSC = ##class(%Dictionary.ClassDefinition).%DeleteId(pClassname)
 			If $$$ISERR(tSC) {
 				Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Unable to delete proxy class for remote class '%1' : '%2'.",pClassname,$System.Status.GetErrorText(tSC)))
 				Quit
 			}
 		} Else {
-			Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot delete class '%1' because it is not a PEX proxy class.",pClassname))
+			Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot delete class '%1' because it is not a IOP proxy class.",pClassname))
 			Quit
 		}
 		
@@ -179,23 +179,23 @@ ClassMethod GenerateProxyClass(
 				Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Proxy class '%1' already exists.",pClassname))
 				Quit
 			} Else {
-				#dim tIsPEX As %Boolean = 0
+				#dim tIsIOP As %Boolean = 0
 				If $classmethod(pClassname,"%Extends","IOP.Common") {
 					#dim tClass As %Dictionary.CompiledClass = ##class(%Dictionary.CompiledClass).%OpenId(pClassname)
 					If '$IsObject(tClass) {
 						Set tSC = $$$ERROR($$$EnsErrGeneral,"Class not found")
 						Quit
 					}
-					Set tIsPEX = ("IOP.Utils" = tClass.GeneratedBy)
+					Set tIsIOP = ("IOP.Utils" = tClass.GeneratedBy)
 				}
-				If tIsPEX {
+				If tIsIOP {
 					Set tSC = ##class(%Dictionary.ClassDefinition).%DeleteId(pClassname)
 					If $$$ISERR(tSC) {
 						Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Unable to delete existing proxy class '%1' : '%2'.",pClassname,$System.Status.GetErrorText(tSC)))
 						Quit
 					}
 				} Else {
-					Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot overwrite class '%1' because it is not a PEX proxy class.",pClassname))
+					Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot overwrite class '%1' because it is not a IOP proxy class.",pClassname))
 					Quit
 				}
 			}
@@ -208,7 +208,7 @@ ClassMethod GenerateProxyClass(
 
 		#dim tSuperClass As %String = pClassDetails."__getitem__"(0)
 		If (""=tSuperClass) {
-			Set tSC = $$$ERROR($$$EnsErrGeneral,"No PEX superclass found.")
+			Set tSC = $$$ERROR($$$EnsErrGeneral,"No IOP superclass found.")
 			Quit
 		}
 		If '$Case($P(tSuperClass,".",*),"DuplexProcess":1,"DuplexService":1,"DuplexOperation":1,"InboundAdapter":1,"OutboundAdapter":1,"BusinessService":1,"BusinessProcess":1,"BusinessOperation":1,:0) {
@@ -323,6 +323,56 @@ ClassMethod GenerateProxyClass(
 		}
 		Quit:$$$ISERR(tSC)
 
+		#; Add debug settings, three settings are always available debug a boolean, port an integer and a timeout an integer
+		Set tPropCat = "Python Debug"
+		#; Debug property
+		Set tPropDebug = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropDebug.Name = "enable"
+		Set tPropDebug.Type = "%Boolean"
+		Set tPropDebug.InitialExpression = $$$quote(0)
+		Set tPropDebug.Description = "Enable or disable debug"
+		
+		Set tSC = tCOSClass.Properties.Insert(tPropDebug)
+		Quit:$$$ISERR(tSC)
+
+		#; Add the settings parameter
+		Set tSETTINGSParamValue = tSETTINGSParamValue_",enable:"_tPropCat
+
+		#; Port property
+		Set tPropPort = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropPort.Name = "port"
+		Set tPropPort.Type = "%Integer"
+		Set tPropPort.InitialExpression = $$$quote(0)
+		Set tPropPort.Description = "Port to use for the debug connection, if 0 an random port will be used"
+		Set tSC = tCOSClass.Properties.Insert(tPropPort)
+		Quit:$$$ISERR(tSC)
+
+		#; Add the settings parameter
+		Set tSETTINGSParamValue = tSETTINGSParamValue_",port:"_tPropCat
+
+		#; Timeout property
+		Set tPropTimeout = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropTimeout.Name = "timeout"
+		Set tPropTimeout.Type = "%Integer"
+		Set tPropTimeout.InitialExpression = $$$quote(30)
+		Set tSC = tCOSClass.Properties.Insert(tPropTimeout)
+		Quit:$$$ISERR(tSC)
+
+		#; Add the settings parameter
+		Set tSETTINGSParamValue = tSETTINGSParamValue_",timeout:"_tPropCat
+
+		#; PythonInterpreterPath property
+		Set tPropInterpre = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropInterpre.Name = "PythonInterpreterPath"
+		Set tPropInterpre.Type = "%String"
+		Set tPropInterpre.Description = "Path to the Python interpreter, if not set the default one will be used"
+		Do tPropInterpre.Parameters.SetAt("255","MAXLEN")
+		Set tSC = tCOSClass.Properties.Insert(tPropInterpre)
+		Quit:$$$ISERR(tSC)
+
+		#; Add the settings parameter
+		Set tSETTINGSParamValue = tSETTINGSParamValue_",PythonInterpreterPath:"_tPropCat
+
 		#dim tSETTINGSParam As %Dictionary.ParameterDefinition = ##class(%Dictionary.ParameterDefinition).%New()
 		Set tSETTINGSParam.Name = "SETTINGS"
 		Set tSETTINGSParam.Default = tSETTINGSParamValue

{iris_pex_embedded_python-3.4.1b8 → iris_pex_embedded_python-3.4.1b10/src/iris_pex_embedded_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iris_pex_embedded_python
-Version: 3.4.1b8
+Version: 3.4.1b10
 Summary: Iris Interoperability based on Embedded Python
 Author-email: grongier <guillaume.rongier@intersystems.com>
 License: MIT License
@@ -49,6 +49,7 @@ Requires-Dist: xmltodict>=0.12.0
 Requires-Dist: iris-embedded-python-wrapper>=0.0.6
 Requires-Dist: setuptools>=40.8.0
 Requires-Dist: jsonpath-ng>=1.7.0
+Requires-Dist: debugpy>=1.8.0
 Dynamic: license-file
 
 # IoP (Interoperability On Python)

{iris_pex_embedded_python-3.4.1b8 → iris_pex_embedded_python-3.4.1b10}/src/iris_pex_embedded_python.egg-info/SOURCES.txt

@@ -40,6 +40,7 @@ src/iop/_business_process.py
 src/iop/_business_service.py
 src/iop/_cli.py
 src/iop/_common.py
+src/iop/_debugpy.py
 src/iop/_decorators.py
 src/iop/_director.py
 src/iop/_dispatch.py

{iris_pex_embedded_python-3.4.1b8 → iris_pex_embedded_python-3.4.1b10}/src/iris_pex_embedded_python.egg-info/requires.txt

@@ -3,3 +3,4 @@ xmltodict>=0.12.0
 iris-embedded-python-wrapper>=0.0.6
 setuptools>=40.8.0
 jsonpath-ng>=1.7.0
+debugpy>=1.8.0