iris-pex-embedded-python 4.0.0b3__tar.gz → 4.0.0b5__tar.gz

{iris_pex_embedded_python-4.0.0b3/src/iris_pex_embedded_python.egg-info → iris_pex_embedded_python-4.0.0b5}/PKG-INFO

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

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools", "wheel"]
 
 [project]
 name = "iris_pex_embedded_python"
-version = "4.0.0b3"
+version = "4.0.0b5"
 description = "Iris Interoperability based on Embedded Python"
 readme = "README.md"
 requires-python = ">=3.10"

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/__init__.py

@@ -25,12 +25,22 @@ from iop.migration.utils import list_bindings as list_bindings
 from iop.migration.utils import register_component as register_component
 from iop.migration.utils import unbind_component as unbind_component
 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 ProductionDiff as ProductionDiff
 from iop.production import ProductionDiffEntry as ProductionDiffEntry
 from iop.production import ProductionGraph as ProductionGraph
+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 Route as Route
+from iop.production import ServiceItem as ServiceItem
+from iop.production import TargetSetting as TargetSetting
 from iop.production import target as target
 from iop.runtime.director import _Director
 from iop.runtime.protocol import DirectorProtocol as DirectorProtocol
@@ -40,6 +50,7 @@ __all__ = [
     "BusinessProcess",
     "BusinessService",
     "Category",
+    "ComponentItem",
     "ComponentRef",
     "Director",
     "DirectorProtocol",
@@ -50,18 +61,27 @@ __all__ = [
     "InboundAdapter",
     "Message",
     "Model",
+    "OperationItem",
     "OutboundAdapter",
     "PersistentMessage",
     "PickleMessage",
     "PollingBusinessService",
     "Port",
+    "ProcessItem",
     "Production",
     "ProductionDiff",
     "ProductionDiffEntry",
     "ProductionGraph",
+    "ProductionValidationError",
+    "ProductionValidationIssue",
+    "ProductionValidationReport",
+    "ProductionValidationWarning",
     "PydanticMessage",
     "PydanticPickleMessage",
+    "Route",
+    "ServiceItem",
     "Setting",
+    "TargetSetting",
     "Utils",
     "bind_component",
     "controls",

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/cli/main.py

@@ -230,6 +230,9 @@ class Command:
         if export_format == "python":
             print(production.to_python(), end="")
             return
+        if export_format == "class":
+            print(production.to_class(), end="")
+            return
         if export_format == "graph":
             print(production.graph())
             return
@@ -244,17 +247,33 @@ class Command:
             if self.args.migration_plan:
                 print(
                     migration_utils.explain_migration(
-                        migrate_path, mode=mode, namespace=self.director.namespace
+                        migrate_path,
+                        mode=mode,
+                        namespace=self.director.namespace,
+                        strict_production_validation=(
+                            self.args.strict_production_validation
+                        ),
                     )
                 )
                 return
             if self._is_remote:
                 print(
                     migration_utils.explain_migration(
-                        migrate_path, mode=mode, namespace=self.director.namespace
+                        migrate_path,
+                        mode=mode,
+                        namespace=self.director.namespace,
+                        strict_production_validation=(
+                            self.args.strict_production_validation
+                        ),
                     )
                 )
-            self.director.migrate(migrate_path)
+            if self.args.strict_production_validation:
+                self.director.migrate(
+                    migrate_path,
+                    strict_production_validation=True,
+                )
+            else:
+                self.director.migrate(migrate_path)
             if self._is_remote:
                 print(
                     migration_utils.format_migration_success(

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/cli/parser.py

@@ -95,12 +95,17 @@ def create_parser() -> argparse.ArgumentParser:
         help="show the migration plan and validation messages without writing to IRIS",
         action="store_true",
     )
+    migrate.add_argument(
+        "--strict-production-validation",
+        help="fail migration when production validation reports issues",
+        action="store_true",
+    )
 
     export = main_parser.add_argument_group("export arguments")
     export.add_argument(
         "--format",
         dest="export_format",
-        choices=("json", "python", "graph"),
+        choices=("json", "python", "class", "graph"),
         default="json",
         help="export format for -e/--export",
     )

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/cli/types.py

@@ -55,3 +55,4 @@ class CommandArgs:
     remote_settings: str | None = None
     update: bool = False
     migration_plan: bool = False
+    strict_production_validation: bool = False

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/cls/IOP/Service/Remote/Rest/v1.cls

@@ -499,6 +499,7 @@ ClassMethod PutMigrate() As %DynamicObject
 		set targetDirectory = dyna.%Get("remote_folder")
 		set packageName = dyna.%Get("package")
 		set settingsFile = dyna.%Get("settings_file")
+		set strictProductionValidation = dyna.%Get("strict_production_validation")
 		If settingsFile = "" { Set settingsFile = "settings.py" }
 		// check for namespace existence and user permissions against namespace
 		If '..NamespaceCheck(namespace) {
@@ -551,7 +552,7 @@ ClassMethod PutMigrate() As %DynamicObject
 		set iopUtils = ##class(IOP.Wrapper).Import("iop.migration.utils")
 		set builtins = ##class(%SYS.Python).Import("builtins")
 		If builtins.hasattr(iopUtils, "migrate") {
-			do builtins.getattr(iopUtils, "migrate")."__call__"(##class(%Library.File).NormalizeFilename(settingsFile, packagePath))
+			do builtins.getattr(iopUtils, "migrate")."__call__"(##class(%Library.File).NormalizeFilename(settingsFile, packagePath),"REMOTE",namespace,strictProductionValidation)
 		} Else {
 			do iopUtils."_Utils".migrate(##class(%Library.File).NormalizeFilename(settingsFile, packagePath))
 		}

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/cls/IOP/Utils.cls

@@ -595,6 +595,7 @@ ClassMethod CreateProductionFromJSON(
 	#dim tPayload As %DynamicObject
 	#dim tProductionData As %DynamicObject
 	#dim tProduction As Ens.Config.Production
+	#dim tProductionClass As %Dictionary.ClassDefinition
 	#dim tItems,tDeclaredName
 	Try {
 		Return:(""=pProductionName) $$$ERROR($$$EnsErrGeneral,"Production name is required.")
@@ -614,6 +615,15 @@ ClassMethod CreateProductionFromJSON(
 			}
 		}
 
+		If ('##class(%Dictionary.ClassDefinition).%ExistsId(pProductionName)) {
+			Set tProductionClass = ##class(%Dictionary.ClassDefinition).%New()
+			Set tProductionClass.Name = pProductionName
+			Set tProductionClass.Super = "Ens.Production"
+			Set tProductionClass.ClassVersion = 25
+			Set tSC = tProductionClass.%Save()
+			Quit:$$$ISERR(tSC)
+		}
+
 		Set tProduction = ##class(Ens.Config.Production).%New()
 		Set tProduction.Name = pProductionName
 		Set tProduction.Description = ..DynamicGet(tProductionData,"Description","")
@@ -719,8 +729,10 @@ ClassMethod InsertSetting(
 	pSettingData) As %Status [ Internal, Private ]
 {
 	#dim tSetting As Ens.Config.Setting
+	#dim tDefaultTarget As %String
+	Set tDefaultTarget = $Select(pOwner.%IsA("Ens.Config.Production"):"",1:"Host")
 	Set tSetting = ##class(Ens.Config.Setting).%New()
-	Set tSetting.Target = ..DynamicGet(pSettingData,"@Target","Host")
+	Set tSetting.Target = ..DynamicGet(pSettingData,"@Target",tDefaultTarget)
 	Set tSetting.Name = ..DynamicGet(pSettingData,"@Name","")
 	Set tSetting.Value = ..DynamicGet(pSettingData,"#text","")
 	Do pOwner.Settings.Insert(tSetting)

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/components/settings.py

@@ -1,5 +1,7 @@
+from __future__ import annotations
+
 from enum import Enum
-from typing import Any
+from typing import Any, overload
 
 _MISSING = object()
 
@@ -45,9 +47,17 @@ class Setting:
         self.control = control or ""
         self.exclude = exclude
         self.name = ""
+        self.owner = None
 
     def __set_name__(self, owner, name):
         self.name = name
+        self.owner = owner
+
+    @overload
+    def __get__(self, instance: None, owner: type | None = None) -> Setting: ...
+
+    @overload
+    def __get__(self, instance: object, owner: type | None = None) -> Any: ...
 
     def __get__(self, instance, owner=None):
         if instance is None:

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/migration/plans.py

@@ -4,6 +4,8 @@ import inspect
 import os
 from typing import Any
 
+from ..production.validation import validate_production_entry
+
 
 def format_migration_success(filename: str, namespace: str | None = None) -> str:
     suffix = f" in namespace {namespace}" if namespace else ""
@@ -21,6 +23,7 @@ def format_migration_plan(plan: dict[str, Any]) -> str:
     lines.extend(format_plan_section("CLASSES", plan["classes"]))
     lines.extend(format_plan_section("SCHEMAS", plan["schemas"]))
     lines.extend(format_plan_section("PRODUCTIONS", plan["productions"]))
+    lines.extend(format_plan_section("VALIDATION", plan.get("validation", [])))
     return "\n".join(lines)
 
 
@@ -47,6 +50,7 @@ class MigrationPlanner:
         filename=None,
         mode: str | None = None,
         namespace: str | None = None,
+        strict_production_validation: bool = False,
     ) -> dict[str, Any]:
         """Build and validate a migration plan from a settings module."""
         if not path:
@@ -59,11 +63,16 @@ class MigrationPlanner:
             "classes": [],
             "schemas": [],
             "productions": [],
+            "validation": [],
         }
 
         self._add_class_entries(plan, getattr(settings, "CLASSES", {}), path)
         self._add_schema_entries(plan, getattr(settings, "SCHEMAS", None))
-        self._add_production_entries(plan, getattr(settings, "PRODUCTIONS", None))
+        self._add_production_entries(
+            plan,
+            getattr(settings, "PRODUCTIONS", None),
+            strict_production_validation=strict_production_validation,
+        )
         return plan
 
     @staticmethod
@@ -102,7 +111,11 @@ class MigrationPlanner:
             plan["schemas"].append(self._utils._python_classname(cls))
 
     def _add_production_entries(
-        self, plan: dict[str, Any], productions: list[Any] | None
+        self,
+        plan: dict[str, Any],
+        productions: list[Any] | None,
+        *,
+        strict_production_validation: bool = False,
     ) -> None:
         if productions is None:
             return
@@ -110,6 +123,16 @@ class MigrationPlanner:
             raise ValueError("PRODUCTIONS must be a list.")
         auto_class_entries = set()
         for production in productions:
+            report = validate_production_entry(
+                production,
+                strict=strict_production_validation,
+                warn=False,
+            )
+            if report.has_issues:
+                plan["validation"].extend(
+                    f"{report.production_name}: {issue.to_text()}"
+                    for issue in report.issues
+                )
             if self._utils._is_production_object(production):
                 plan["productions"].append(production.name)
                 self._add_production_component_entries(

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/migration/utils.py

@@ -18,6 +18,7 @@ from ..messages.persistent import (
     is_persistent_message_class,
     register_persistent_message_class,
 )
+from ..production.validation import validate_production_entry
 from ..runtime import iris as _iris
 from ..runtime.environment import remove_sys_path, temporary_sys_path
 from .io import (
@@ -425,7 +426,12 @@ def filename_to_module(filename) -> str:
     return module
 
 
-def migrate(filename=None, mode: str | None = None, namespace: str | None = None):
+def migrate(
+    filename=None,
+    mode: str | None = None,
+    namespace: str | None = None,
+    strict_production_validation: bool = False,
+):
     """
     Read the settings.py file and register all the components
     settings.py file has two dictionaries:
@@ -443,10 +449,19 @@ def migrate(filename=None, mode: str | None = None, namespace: str | None = None
 
     try:
         plan = _build_migration_plan(
-            settings, path, filename, mode=mode, namespace=namespace
+            settings,
+            path,
+            filename,
+            mode=mode,
+            namespace=namespace,
+            strict_production_validation=strict_production_validation,
         )
         print(format_migration_plan(plan))
-        _register_settings_components(settings, path)
+        _register_settings_components(
+            settings,
+            path,
+            strict_production_validation=strict_production_validation,
+        )
         print(
             format_migration_success(
                 filename or inspect.getfile(settings), namespace=namespace
@@ -457,13 +472,21 @@ def migrate(filename=None, mode: str | None = None, namespace: str | None = None
 
 
 def explain_migration(
-    filename=None, mode: str | None = None, namespace: str | None = None
+    filename=None,
+    mode: str | None = None,
+    namespace: str | None = None,
+    strict_production_validation: bool = False,
 ):
     """Return a human-readable migration plan without writing to IRIS."""
     settings, path = _load_settings(filename)
     try:
         plan = _build_migration_plan(
-            settings, path, filename, mode=mode, namespace=namespace
+            settings,
+            path,
+            filename,
+            mode=mode,
+            namespace=namespace,
+            strict_production_validation=strict_production_validation,
         )
         return _format_migration_plan(plan)
     finally:
@@ -488,6 +511,7 @@ def _build_migration_plan(
     filename=None,
     mode: str | None = None,
     namespace: str | None = None,
+    strict_production_validation: bool = False,
 ):
     return MigrationPlanner(sys.modules[__name__]).build(
         settings,
@@ -495,6 +519,7 @@ def _build_migration_plan(
         filename=filename,
         mode=mode,
         namespace=namespace,
+        strict_production_validation=strict_production_validation,
     )
 
 
@@ -589,7 +614,12 @@ def _validate_dtl_schema_class(cls, setting_name):
         )
 
 
-def _register_settings_components(settings, path):
+def _register_settings_components(
+    settings,
+    path,
+    *,
+    strict_production_validation: bool = False,
+):
     """Register all components from settings (classes, productions, schemas).
 
     Args:
@@ -616,6 +646,7 @@ def _register_settings_components(settings, path):
             settings.PRODUCTIONS,
             path,
             persistent_registry=persistent_registry,
+            strict_production_validation=strict_production_validation,
         )
     except AttributeError:
         pass
@@ -835,18 +866,25 @@ def set_productions_settings(
     production_list,
     root_path=None,
     persistent_registry=None,
+    strict_production_validation: bool = False,
 ):
     """
     It takes a list of dictionaries and registers the productions
     """
     # for each production in the list
     for production in production_list:
-        if _is_production_object(production):
+        production_is_object = _is_production_object(production)
+        if production_is_object:
             _register_production_object_messages(
                 production,
                 persistent_registry=persistent_registry,
             )
             _register_production_object_components(production, root_path)
+            validate_production_entry(
+                production,
+                strict=strict_production_validation,
+                warn=True,
+            )
             production = production.to_dict()
         else:
             production = copy.deepcopy(production)
@@ -860,6 +898,12 @@ def set_productions_settings(
         production["Production"] = production.pop(production_name)
         # handle Items
         production = handle_items(production, root_path)
+        if not production_is_object:
+            validate_production_entry(
+                production,
+                strict=strict_production_validation,
+                warn=True,
+            )
         # register the production
         register_production_definition(production_name, production)
 
@@ -992,11 +1036,21 @@ def register_production_definition(production_name: str, production: dict):
     :param production_name: full IRIS production class name
     :param production: normalized {"Production": {...}} dictionary
     """
-    raise_on_error(
-        _iris.get_iris()
-        .cls("IOP.Utils")
-        .CreateProductionFromJSON(production_name, json.dumps(production))
-    )
+    try:
+        raise_on_error(
+            _iris.get_iris()
+            .cls("IOP.Utils")
+            .CreateProductionFromJSON(production_name, json.dumps(production))
+        )
+    except RuntimeError as exc:
+        if not _is_missing_production_class_error(exc, production_name):
+            raise
+        register_production(production_name, dict_to_xml(production))
+
+
+def _is_missing_production_class_error(exc: RuntimeError, production_name: str) -> bool:
+    message = str(exc)
+    return "CLASS DOES NOT EXIST" in message and production_name in message
 
 
 def export_production(production_name):

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/production/__init__.py

@@ -1,6 +1,11 @@
 from __future__ import annotations
 
 from .component import ComponentRef as ComponentRef
+from .declarations import ComponentItem as ComponentItem
+from .declarations import OperationItem as OperationItem
+from .declarations import ProcessItem as ProcessItem
+from .declarations import Route as Route
+from .declarations import ServiceItem as ServiceItem
 from .model import Production as Production
 from .runtime import resolve_target as resolve_target
 from .types import GraphEdge as GraphEdge
@@ -12,17 +17,30 @@ from .types import ProductionDiffEntry as ProductionDiffEntry
 from .types import ProductionGraph as ProductionGraph
 from .types import TargetSetting as TargetSetting
 from .types import target as target
+from .validation import ProductionValidationError as ProductionValidationError
+from .validation import ProductionValidationIssue as ProductionValidationIssue
+from .validation import ProductionValidationReport as ProductionValidationReport
+from .validation import ProductionValidationWarning as ProductionValidationWarning
 
 __all__ = [
     "ComponentRef",
+    "ComponentItem",
     "GraphEdge",
     "GraphNode",
+    "OperationItem",
     "PersistentMessageRegistration",
     "Port",
+    "ProcessItem",
     "Production",
     "ProductionDiff",
     "ProductionDiffEntry",
     "ProductionGraph",
+    "ProductionValidationError",
+    "ProductionValidationIssue",
+    "ProductionValidationReport",
+    "ProductionValidationWarning",
+    "Route",
+    "ServiceItem",
     "TargetSetting",
     "resolve_target",
     "target",

{iris_pex_embedded_python-4.0.0b3 → iris_pex_embedded_python-4.0.0b5}/src/iop/production/common.py

@@ -3,6 +3,30 @@ from __future__ import annotations
 import importlib
 from typing import Any
 
+PRODUCTION_SETTING_FIELDS: dict[str, tuple[str, Any]] = {
+    "shutdown_timeout": ("ShutdownTimeout", 120),
+    "update_timeout": ("UpdateTimeout", 10),
+    "alert_notification_manager": ("AlertNotificationManager", ""),
+    "alert_notification_operation": ("AlertNotificationOperation", ""),
+    "alert_notification_recipients": ("AlertNotificationRecipients", ""),
+    "alert_action_window": ("AlertActionWindow", 60),
+}
+
+PRODUCTION_SETTING_NAMES: dict[str, str] = {
+    field_name: iris_name
+    for field_name, (iris_name, _default) in PRODUCTION_SETTING_FIELDS.items()
+}
+
+PRODUCTION_SETTING_FIELDS_BY_IRIS: dict[str, str] = {
+    iris_name: field_name
+    for field_name, (iris_name, _default) in PRODUCTION_SETTING_FIELDS.items()
+}
+
+SETTING_NAME_ALIASES = {
+    "target_config_name": "TargetConfigName",
+    "target_config_names": "TargetConfigNames",
+}
+
 
 def _bool_text(value: bool | str) -> str:
     if isinstance(value, bool):