iris-pex-embedded-python 4.0.0b9__tar.gz → 4.0.0b10__tar.gz

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iris_pex_embedded_python
-Version: 4.0.0b9
+Version: 4.0.0b10
 Summary: Iris Interoperability based on Embedded Python
 Author-email: grongier <guillaume.rongier@intersystems.com>
 License: MIT License

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools", "wheel"]
 
 [project]
 name = "iris_pex_embedded_python"
-version = "4.0.0b9"
+version = "4.0.0b10"
 description = "Iris Interoperability based on Embedded Python"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -63,6 +63,9 @@ markers = [
     "e2e_remote: end-to-end test requiring a remote IRIS instance via REST API",
 ]
 
+[tool.pyright]
+pythonVersion = "3.10"
+
 [tool.ruff]
 target-version = "py310"
 line-length = 88

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/__init__.py

@@ -29,7 +29,6 @@ from iop.migration.utils import unregister_component as unregister_component
 from iop.production import ComponentItem as ComponentItem
 from iop.production import ComponentRef as ComponentRef
 from iop.production import OperationItem as OperationItem
-from iop.production import Port as Port
 from iop.production import ProcessItem as ProcessItem
 from iop.production import Production as Production
 from iop.production import ProductionApplyResult as ProductionApplyResult
@@ -38,14 +37,15 @@ from iop.production import ProductionDiff as ProductionDiff
 from iop.production import ProductionDiffEntry as ProductionDiffEntry
 from iop.production import ProductionGraph as ProductionGraph
 from iop.production import ProductionPlanOperation as ProductionPlanOperation
-from iop.production import ProductionVerifyResult as ProductionVerifyResult
 from iop.production import ProductionValidationError as ProductionValidationError
 from iop.production import ProductionValidationIssue as ProductionValidationIssue
 from iop.production import ProductionValidationReport as ProductionValidationReport
 from iop.production import ProductionValidationWarning as ProductionValidationWarning
+from iop.production import ProductionVerifyResult as ProductionVerifyResult
 from iop.production import Route as Route
 from iop.production import ServiceItem as ServiceItem
 from iop.production import TargetSetting as TargetSetting
+from iop.production import TargetSettingRef as TargetSettingRef
 from iop.production import target as target
 from iop.runtime.director import _Director
 from iop.runtime.protocol import DirectorProtocol as DirectorProtocol
@@ -71,7 +71,6 @@ __all__ = [
     "PersistentMessage",
     "PickleMessage",
     "PollingBusinessService",
-    "Port",
     "ProcessItem",
     "Production",
     "ProductionApplyResult",
@@ -91,6 +90,7 @@ __all__ = [
     "ServiceItem",
     "Setting",
     "TargetSetting",
+    "TargetSettingRef",
     "Utils",
     "bind_component",
     "controls",

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/cli/main.py

@@ -256,6 +256,9 @@ class Command:
         if export_format == "graph":
             print(production.graph())
             return
+        if export_format == "mermaid":
+            print(production.to_mermaid(), end="")
+            return
         raise ValueError(f"Unsupported export format: {export_format}")
 
     def _handle_migrate(self) -> None:

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/cli/parser.py

@@ -116,7 +116,7 @@ def create_parser() -> argparse.ArgumentParser:
     export.add_argument(
         "--format",
         dest="export_format",
-        choices=("json", "python", "class", "graph"),
+        choices=("json", "python", "class", "graph", "mermaid"),
         default="json",
         help="export format for -e/--export",
     )

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/cls/IOP/Utils.cls

@@ -798,6 +798,7 @@ ClassMethod ExportProductionConnections(pProductionName As %String) As %String
 			Set itemResult = {}
 			Set itemResult.item = item.Name
 			Set itemResult."class_name" = item.ClassName
+			Set itemResult.kind = ..ProductionItemKind(item.ClassName)
 			Set adapterClass = ""
 			Try {
 				Set adapterClass = $Parameter(item.ClassName, "ADAPTER")
@@ -806,6 +807,21 @@ ClassMethod ExportProductionConnections(pProductionName As %String) As %String
 			If adapterClass '= "" {
 				Set itemResult."adapter_class_name" = adapterClass
 			}
+			If ..ProductionItemIsIOP(item.ClassName) {
+				Set itemResult.iop = 1
+				Set module = ..ProductionItemSettingOrProxyDefault(item,item.ClassName,"%module")
+				Set classname = ..ProductionItemSettingOrProxyDefault(item,item.ClassName,"%classname")
+				Set classpaths = ..ProductionItemSettingOrProxyDefault(item,item.ClassName,"%classpaths")
+				If module '= "" {
+					Set itemResult.module = module
+				}
+				If classname '= "" {
+					Set itemResult.classname = classname
+				}
+				If classpaths '= "" {
+					Set itemResult.classpaths = classpaths
+				}
+			}
 			Set itemResult.connections = []
 			Set itemResult.warnings = []
 			Try {
@@ -828,6 +844,66 @@ ClassMethod ExportProductionConnections(pProductionName As %String) As %String
 	Return result.%ToJSON()
 }
 
+ClassMethod ProductionItemKind(pClassName As %String) As %String [ Internal, Private ]
+{
+	Try {
+		If $ClassMethod(pClassName,"%Extends","Ens.BusinessService") {
+			Return "service"
+		}
+		If $ClassMethod(pClassName,"%Extends","Ens.BusinessProcess") {
+			Return "process"
+		}
+		If $ClassMethod(pClassName,"%Extends","Ens.BusinessOperation") {
+			Return "operation"
+		}
+	} Catch ex {
+	}
+	Quit "component"
+}
+
+ClassMethod ProductionItemIsIOP(pClassName As %String) As %Boolean [ Internal, Private ]
+{
+	Try {
+		If $ClassMethod(pClassName,"%Extends","IOP.Common") {
+			Return 1
+		}
+	} Catch ex {
+	}
+	Try {
+		Set class = ##class(%Dictionary.ClassDefinition).%OpenId(pClassName)
+		If $IsObject(class) {
+			If class.GeneratedBy = $CLASSNAME() {
+				Return 1
+			}
+			If class.Super [ "IOP." {
+				Return 1
+			}
+		}
+	} Catch exClass {
+	}
+	Quit 0
+}
+
+ClassMethod ProductionItemSettingOrProxyDefault(
+	pItem As Ens.Config.Item,
+	pClassName As %String,
+	pSettingName As %String) As %String [ Internal, Private ]
+{
+	Set value = ""
+	Try {
+		Do pItem.GetModifiedSetting(pSettingName,.value)
+	} Catch exSetting {
+	}
+	If value '= "" {
+		Quit value
+	}
+	Try {
+		Set value = ..ProxyPropertyInitialValue(pClassName,pSettingName)
+	} Catch exProxy {
+	}
+	Quit value
+}
+
 /// Export queue counters for production items.
 ClassMethod ExportProductionQueueInfo(pProductionName As %String) As %String
 {
@@ -963,10 +1039,10 @@ ClassMethod ApplyProductionPlanOperation(
 		Return ..RemoveConfigSetting(..FindProductionItem(pProduction,pOperation.%Get("item")),pOperation.%Get("target"),pOperation.%Get("setting"))
 	}
 	If opType = "set_route_setting" {
-		Return ..SetConfigSetting(..FindProductionItem(pProduction,pOperation.%Get("source_item")),"Host",pOperation.%Get("source_port"),..DynamicArrayToCSV(pOperation.%Get("after")))
+		Return ..SetConfigSetting(..FindProductionItem(pProduction,pOperation.%Get("source_item")),"Host",pOperation.%Get("source_target_setting"),..DynamicArrayToCSV(pOperation.%Get("after")))
 	}
 	If opType = "remove_route" {
-		Return ..RemoveConfigSetting(..FindProductionItem(pProduction,pOperation.%Get("source_item")),"Host",pOperation.%Get("source_port"))
+		Return ..RemoveConfigSetting(..FindProductionItem(pProduction,pOperation.%Get("source_item")),"Host",pOperation.%Get("source_target_setting"))
 	}
 	Quit $$$ERROR($$$EnsErrGeneral,"Unsupported production plan operation: "_opType)
 }

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/components/business_host.py

@@ -1,7 +1,7 @@
 import ast
 import textwrap
 from inspect import getsource
-from typing import Any
+from typing import Any, cast
 
 from ..messages.base import _Message as Message
 from ..messages.decorators import (
@@ -15,13 +15,18 @@ from ..messages.dispatch import (
     dispatch_message,
     dispatch_serializer,
 )
-from ..production import Port, resolve_target
+from ..production import TargetSettingRef, resolve_target
 from ..runtime import iris as _iris
 from .async_request import AsyncRequest
 from .common import _Common
 from .generator_request import _GeneratorRequest
 
-_CONNECTION_METHODS = {"send_request_sync", "send_request_async"}
+_CONNECTION_METHODS = {
+    "send_request_sync",
+    "send_request_async",
+    "send_request_async_ng",
+    "send_generator_request",
+}
 _UNRESOLVED = object()
 
 
@@ -95,7 +100,7 @@ class _BusinessHost(_Common):
     @output_deserializer
     def send_request_sync(
         self,
-        target: str | Port,
+        target: str | TargetSettingRef,
         request: Message | Any,
         timeout: int = -1,
         description: str | None = None,
@@ -122,7 +127,7 @@ class _BusinessHost(_Common):
     @input_serializer_param(1, "request")
     def send_request_async(
         self,
-        target: str | Port,
+        target: str | TargetSettingRef,
         request: Message | Any,
         description: str | None = None,
     ) -> None:
@@ -141,7 +146,7 @@ class _BusinessHost(_Common):
 
     async def send_request_async_ng(
         self,
-        target: str | Port,
+        target: str | TargetSettingRef,
         request: Message | Any,
         timeout: int = -1,
         description: str | None = None,
@@ -157,12 +162,12 @@ class _BusinessHost(_Common):
         Returns:
             Response from target component
         """
-        target = resolve_target(target)
+        target = cast(str, resolve_target(target))
         return await AsyncRequest(target, request, timeout, description, self)
 
     def send_generator_request(
         self,
-        target: str | Port,
+        target: str | TargetSettingRef,
         request: Message | Any,
         timeout: int = -1,
         description: str | None = None,
@@ -178,12 +183,12 @@ class _BusinessHost(_Common):
         Raises:
             TypeError: If request is not of type Message
         """
-        target = resolve_target(target)
+        target = cast(str, resolve_target(target))
         return _GeneratorRequest(self, target, request, timeout, description)
 
     def send_multi_request_sync(
         self,
-        target_request: list[tuple[str | Port, Message | Any]],
+        target_request: list[tuple[str | TargetSettingRef, Message | Any]],
         timeout: int = -1,
         description: str | None = None,
     ) -> list[tuple[str, Message | Any, Any, int]]:
@@ -202,31 +207,31 @@ class _BusinessHost(_Common):
             ValueError: If target_request is empty
         """
         self._validate_target_request(target_request)
-        target_request = [
+        resolved_target_request: list[tuple[str, Message | Any]] = [
             (resolve_target(target), request) for target, request in target_request
         ]
 
         call_list = [
             self._create_call_structure(target, request)
-            for target, request in target_request
-        ]
+            for target, request in resolved_target_request
+        ]
 
         response_list = self.iris_handle.dispatchSendRequestSyncMultiple(
             call_list, timeout
         )
 
-        return [
-            (
-                target_request[i][0],
-                target_request[i][1],
-                dispatch_deserializer(response_list[i].Response),
-                response_list[i].ResponseCode,
-            )
-            for i in range(len(target_request))
-        ]
+        return [
+            (
+                resolved_target_request[i][0],
+                resolved_target_request[i][1],
+                dispatch_deserializer(response_list[i].Response),
+                int(response_list[i].ResponseCode),
+            )
+            for i in range(len(resolved_target_request))
+        ]
 
     def _validate_target_request(
-        self, target_request: list[tuple[str | Port, Message | Any]]
+        self, target_request: list[tuple[str | TargetSettingRef, Message | Any]]
     ) -> None:
         """Validate the target_request parameter structure."""
         if not isinstance(target_request, list):
@@ -239,7 +244,7 @@ class _BusinessHost(_Common):
             raise TypeError("target_request must contain tuples of (target, request)")
 
     def _create_call_structure(
-        self, target: str | Port, request: Message | Any
+        self, target: str | TargetSettingRef, request: Message | Any
     ) -> Any:
         """Create an Ens.CallStructure object for the request."""
         iris = _iris.get_iris()

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/components/business_process.py

@@ -6,7 +6,7 @@ from ..messages.decorators import (
     output_serializer,
 )
 from ..messages.dispatch import create_dispatch, dispatch_message
-from ..production import Port, resolve_target
+from ..production import TargetSettingRef, resolve_target
 from .business_host import _BusinessHost
 
 
@@ -88,7 +88,7 @@ class _BusinessProcess(_BusinessHost):
     @input_serializer_param(1, "request")
     def send_request_async(
         self,
-        target: str | Port,
+        target: str | TargetSettingRef,
         request: Any,
         description: str | None = None,
         completion_key: str | None = None,

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/production/__init__.py

@@ -15,11 +15,11 @@ from .runtime import resolve_target as resolve_target
 from .types import GraphEdge as GraphEdge
 from .types import GraphNode as GraphNode
 from .types import PersistentMessageRegistration as PersistentMessageRegistration
-from .types import Port as Port
 from .types import ProductionDiff as ProductionDiff
 from .types import ProductionDiffEntry as ProductionDiffEntry
 from .types import ProductionGraph as ProductionGraph
 from .types import TargetSetting as TargetSetting
+from .types import TargetSettingRef as TargetSettingRef
 from .types import target as target
 from .validation import ProductionValidationError as ProductionValidationError
 from .validation import ProductionValidationIssue as ProductionValidationIssue
@@ -33,7 +33,6 @@ __all__ = [
     "GraphNode",
     "OperationItem",
     "PersistentMessageRegistration",
-    "Port",
     "ProcessItem",
     "Production",
     "ProductionApplyResult",
@@ -50,6 +49,7 @@ __all__ = [
     "Route",
     "ServiceItem",
     "TargetSetting",
+    "TargetSettingRef",
     "resolve_target",
     "target",
 ]

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/production/actions.py

@@ -17,7 +17,7 @@ from .planning import (
 )
 from .rendering import message_to_classname_body
 from .runtime import _has_remote_director, _ProductionRuntime, _temporary_env
-from .types import Port
+from .types import TargetSettingRef
 
 
 def start(production, detach: bool = True) -> None:
@@ -67,7 +67,10 @@ def update(production) -> None:
     director.update_production()
 
 
-def start_component(production, component: ComponentRef | Port | str) -> None:
+def start_component(
+    production,
+    component: ComponentRef | TargetSettingRef | str,
+) -> None:
     component_name = production._runtime_component_name(component)
     director = _ProductionRuntime(production).director
     require_current_runtime(
@@ -78,7 +81,10 @@ def start_component(production, component: ComponentRef | Port | str) -> None:
     director.start_component(component_name)
 
 
-def stop_component(production, component: ComponentRef | Port | str) -> None:
+def stop_component(
+    production,
+    component: ComponentRef | TargetSettingRef | str,
+) -> None:
     component_name = production._runtime_component_name(component)
     director = _ProductionRuntime(production).director
     require_current_runtime(
@@ -89,7 +95,10 @@ def stop_component(production, component: ComponentRef | Port | str) -> None:
     director.stop_component(component_name)
 
 
-def restart_component(production, component: ComponentRef | Port | str) -> None:
+def restart_component(
+    production,
+    component: ComponentRef | TargetSettingRef | str,
+) -> None:
     component_name = production._runtime_component_name(component)
     director = _ProductionRuntime(production).director
     require_current_runtime(
@@ -300,13 +309,13 @@ def log(production, top: int | None = None) -> None:
 
 def test_component(
     production,
-    target_or_port: str | Port | ComponentRef,
+    target_or_ref: str | TargetSettingRef | ComponentRef,
     message: Any = None,
     classname: str | None = None,
     body: str | dict | None = None,
 ) -> Any:
     director = _ProductionRuntime(production).director
-    target_name = production.resolve_target(target_or_port)
+    target_name = production.resolve_target(target_or_ref)
 
     raise_if_existing_production_not_running(production, director)
 

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/production/component.py

@@ -12,7 +12,7 @@ from .common import (
     _settings_to_iris,
     _text_value,
 )
-from .types import Port, TargetSetting
+from .types import TargetSetting, TargetSettingRef
 
 
 @dataclass
@@ -36,7 +36,8 @@ class ComponentRef:
     host_settings: dict[str, Any] = field(default_factory=dict)
     adapter_settings: dict[str, Any] = field(default_factory=dict)
     other_settings: list[dict[str, Any]] = field(default_factory=list)
-    port_names: set[str] = field(default_factory=set)
+    target_setting_names: set[str] = field(default_factory=set)
+    runtime_metadata: dict[str, Any] = field(default_factory=dict)
 
     def __post_init__(self) -> None:
         if self.class_name is None:
@@ -52,22 +53,22 @@ class ComponentRef:
         if not self.adapter_class_name:
             self.adapter_class_name = _adapter_type_from_class_name(self.class_name)
 
-    def __getattr__(self, name: str) -> Port:
+    def __getattr__(self, name: str) -> TargetSettingRef:
         if self.component_class is not None:
             descriptor = getattr(self.component_class, name, None)
             if isinstance(descriptor, TargetSetting):
-                return Port(
+                return TargetSettingRef(
                     production=self.production,
                     component=self,
                     name=name,
                 )
-        if name in self.port_names:
-            return self.port(name)
+        if name in self.target_setting_names:
+            return self.target_setting(name)
         raise AttributeError(name)
 
-    def port(self, name: str) -> Port:
-        self.port_names.add(name)
-        return Port(
+    def target_setting(self, name: str) -> TargetSettingRef:
+        self.target_setting_names.add(name)
+        return TargetSettingRef(
             production=self.production,
             component=self,
             name=name,
@@ -160,30 +161,29 @@ class ComponentRef:
 
     def connect(
         self,
-        port_name: str | Port,
-        target_component: ComponentRef | str,
+        target_setting: str | TargetSettingRef,
+        target_component: ComponentRef | str | None = None,
+        **kwargs: Any,
     ) -> ComponentRef:
-        port = self._coerce_port(port_name)
-        self.production.connect(port, target_component)
+        target_setting_ref = self._coerce_target_setting_ref(target_setting)
+        self.production.connect(target_setting_ref, target_component, **kwargs)
         return self
 
-    def connect_add(
+    def _coerce_target_setting_ref(
         self,
-        port_name: str | Port,
-        target_component: ComponentRef | str,
-    ) -> ComponentRef:
-        port = self._coerce_port(port_name)
-        self.production.connect_add(port, target_component)
-        return self
-
-    def _coerce_port(self, port_name: str | Port) -> Port:
-        if isinstance(port_name, Port):
-            if port_name.production is not self.production:
-                raise ValueError("source port belongs to a different Production")
-            if port_name.component is not self:
-                raise ValueError("source port belongs to a different component")
-            return port_name
-        return self.port(str(port_name))
+        target_setting: str | TargetSettingRef,
+    ) -> TargetSettingRef:
+        if isinstance(target_setting, TargetSettingRef):
+            if target_setting.production is not self.production:
+                raise ValueError(
+                    "source target setting belongs to a different Production"
+                )
+            if target_setting.component is not self:
+                raise ValueError(
+                    "source target setting belongs to a different component"
+                )
+            return target_setting
+        return self.target_setting(str(target_setting))
 
     def inspect(self, *, refresh: bool = True) -> dict[str, Any]:
         return self.production.inspect_component(self, refresh=refresh)

{iris_pex_embedded_python-4.0.0b9 → iris_pex_embedded_python-4.0.0b10}/src/iop/production/declarations.py

@@ -15,19 +15,19 @@ class _NamedRouteTarget(Protocol):
 
 @dataclass(frozen=True)
 class Route:
-    """Declarative route from a production item port to one or more targets."""
+    """Declarative route from a target setting to one or more targets."""
 
-    port: str | TargetSetting
+    target_setting: str | TargetSetting
     targets: str | _NamedRouteTarget | Iterable[str | _NamedRouteTarget]
 
     @property
-    def port_name(self) -> str:
-        return normalize_route_port(self.port)
+    def target_setting_name(self) -> str:
+        return normalize_route_target_setting(self.target_setting)
 
     @property
-    def port_owner(self) -> type | None:
-        if isinstance(self.port, TargetSetting):
-            return self.port.owner
+    def target_setting_owner(self) -> type | None:
+        if isinstance(self.target_setting, TargetSetting):
+            return self.target_setting.owner
         return None
 
     @property
@@ -39,12 +39,17 @@ class Route:
                 targets = tuple(self.targets)
             except TypeError as exc:
                 raise TypeError(
-                    f"Route {self.port_name!r} targets must be an item name, "
+                    f"Route {self.target_setting_name!r} targets must be an item name, "
                     "a production item declaration, or an iterable of either"
                 ) from exc
         if not targets:
-            raise ValueError(f"Route {self.port_name!r} requires at least one target")
-        return tuple(_route_target_name(target, self.port_name) for target in targets)
+            raise ValueError(
+                f"Route {self.target_setting_name!r} requires at least one target"
+            )
+        return tuple(
+            _route_target_name(target, self.target_setting_name)
+            for target in targets
+        )
 
 
 @dataclass(frozen=True)
@@ -128,7 +133,7 @@ class OperationItem(_ProductionItemDeclaration):
     kind: ClassVar[str] = "operation"
 
 
-def normalize_route_port(name: str | TargetSetting) -> str:
+def normalize_route_target_setting(name: str | TargetSetting) -> str:
     """Normalize known Pythonic route aliases without changing other settings."""
 
     if isinstance(name, TargetSetting):
@@ -137,19 +142,19 @@ def normalize_route_port(name: str | TargetSetting) -> str:
                 "Route target setting must be declared on a component class"
             )
         return name.name
-    port_name = str(name)
-    return SETTING_NAME_ALIASES.get(port_name, port_name)
+    target_setting_name = str(name)
+    return SETTING_NAME_ALIASES.get(target_setting_name, target_setting_name)
 
 
-def normalize_route_port_for_match(name: str | TargetSetting) -> str:
-    return normalize_route_port(name)
+def normalize_route_target_setting_for_match(name: str | TargetSetting) -> str:
+    return normalize_route_target_setting(name)
 
 
 def _is_route_target(value: Any) -> bool:
     return isinstance(value, str) or isinstance(value, _ProductionItemDeclaration)
 
 
-def _route_target_name(value: Any, port_name: str) -> str:
+def _route_target_name(value: Any, target_setting_name: str) -> str:
     if isinstance(value, str):
         if value:
             return value
@@ -158,7 +163,7 @@ def _route_target_name(value: Any, port_name: str) -> str:
             return value.name
 
     raise TypeError(
-        f"Route {port_name!r} targets must be item names or production item "
+        f"Route {target_setting_name!r} targets must be item names or production item "
         "declarations"
     )