Enhance _Common class by excluding additional properties from member listing and add new method for configuration initialization in Common.cls

Author: grongierisc

src/iop/_common.py

@@ -148,7 +148,9 @@ def _get_properties(cls) -> List[List[Any]]:
                 if not member[0].startswith('_'):
                     # remove other methods and functions
                     if not inspect.ismethod(member[1]) and not inspect.isfunction(member[1]) and not inspect.isclass(member[1]):
-                        if member[0] not in ('INFO_URL','ICON_URL','PERSISTENT_PROPERTY_LIST') :
+                        if member[0] not in ('INFO_URL','ICON_URL','PERSISTENT_PROPERTY_LIST'
+                                             ,'log_to_console','logger','iris_handle'
+                                             ,'DISPATCH','adapter','Adapter','buffer'):
                             name = member[0]
                             req = 0
                             cat = "Additional"

src/iop/cls/IOP/Common.cls

@@ -19,6 +19,18 @@ Property %settings As %String(MAXLEN = "");
 /// Instance of class
 Property %class As %SYS.Python;
 
+Method %OnNew(pConfigName As %String) As %Status
+{
+    set tSC = $$$OK
+    try {
+        $$$ThrowOnError(..Connect())
+        $$$ThrowOnError($method($this,"initConfig",.pConfigName)) ; call subclass
+    } catch ex {
+        set tSC = ex.AsStatus()
+    }
+    quit tSC
+}
+
 /// Get Class
 Method GetClass() As %SYS.Python
 {
@@ -41,7 +53,6 @@ Method OnInit() As %Status
 {
     set tSC = $$$OK
     try {
-        $$$ThrowOnError(..Connect())
         do ..%class."_dispatch_on_init"($this)
     } catch ex {
         set tSC = ex.AsStatus()
@@ -199,7 +210,6 @@ ClassMethod OnGetConnections(
     Catch ex {
     }
 
-
     // Get settings
     do pItem.GetModifiedSetting("%classpaths", .tClasspaths)
     do pItem.GetModifiedSetting("%classname", .tClassname)

src/iop/cls/IOP/Utils.cls

@@ -275,6 +275,54 @@ ClassMethod GenerateProxyClass(
 		set:($Case(tSuperClass,"IOP.InboundAdapter":1,"IOP.OutboundAdapter":1,:0)) type = "Adapter"
 		set tSETTINGSParamValue = $REPLACE(tSETTINGSParamValue,"$type",type)
 
+		#dim tCustomProp As %Dictionary.PropertyDefinition
+		#dim tPropInfo,tPropName,tDataType,tDefault,tDesc,tPropCat,tContext As %String
+
+		set builtins = ##class(%SYS.Python).Import("builtins")
+		#; each remote setting is of form $lb(propName,dataType,defaultVal,required,category,description,editorContext)
+		For i=0:1:builtins.len(pRemoteSettings)-1 {
+			Set tPropInfo = pRemoteSettings."__getitem__"(i)
+			Continue:""=tPropInfo ; this shouldn't happen, but just in case
+			Set tPropName = tPropInfo."__getitem__"(0)
+			Set tDataType = tPropInfo."__getitem__"(1)
+			If (""=tPropName) || (""=tDataType) {
+				Set tSC = $$$ERROR($$$EnsErrGeneral,"All properties must have a name and datatype defined")
+				Quit
+			}
+			Set tCustomProp = ##class(%Dictionary.PropertyDefinition).%New()
+			Set tCustomProp.Name = tPropName
+			If $Case(tDataType,"String":1,"Integer":1,"Boolean":1,"Numeric":1,:0) {
+				Set tDataType = "%"_tDataType
+			} ElseIf '##class(%Dictionary.ClassDefinition).%ExistsId(tDataType) {
+				Set tDataType = "%String"
+			}
+			Set tCustomProp.Type = tDataType
+			If tDataType["%String" {
+				Set tSC = tCustomProp.Parameters.SetAt("255","MAXLEN")
+				Quit:$$$ISERR(tSC)
+			}
+			Set tDefault = tPropInfo."__getitem__"(2)
+			If ""'=tDefault {
+				Set tCustomProp.InitialExpression = $$$quote(tDefault)
+			}
+			Set tCustomProp.Required = tPropInfo."__getitem__"(3)
+			
+			Set tSC = tCOSClass.Properties.Insert(tCustomProp)
+			Quit:$$$ISERR(tSC)
+			
+			#dim tMethod As %Dictionary.MethodDefinition = ##class(%Dictionary.MethodDefinition).%New()
+			Set tMethod.Name = tPropName_"Set"
+			Set tMethod.ReturnType = "%Status"
+			Set tMethod.FormalSpec = "value:"_tDataType
+			Do tMethod.Implementation.WriteLine("	Set ..%class."""_tPropName_""" = value")
+			Do tMethod.Implementation.WriteLine("	Quit $$$OK")
+			Set tSC = tCOSClass.Methods.Insert(tMethod)
+
+			Set tPropCat = "Python Attributes"
+			Set tSETTINGSParamValue = tSETTINGSParamValue_","_tPropName_":"_tPropCat
+		}
+		Quit:$$$ISERR(tSC)
+
 		#dim tSETTINGSParam As %Dictionary.ParameterDefinition = ##class(%Dictionary.ParameterDefinition).%New()
 		Set tSETTINGSParam.Name = "SETTINGS"
 		Set tSETTINGSParam.Default = tSETTINGSParamValue

src/tests/registerFilesIop/bo.py

@@ -128,6 +128,13 @@ def OnMessage(self, pRequest):
 
 class MyOperation(BusinessOperation):
 
+    my_empty_var : str
+    my_none_var = None
+    my_int_var :int = 0
+    my_float_var : float = 0.0
+    my_untyped_var = 0
+    my_str_var = "foo"
+
     def OnMessage(self, request):
         self.LOGINFO('hello')
         return MyResponse(request.StringValue)

src/tests/test_utils.py

@@ -33,7 +33,7 @@ def test_setup_succeeds(self):
 class TestComponentRegistration:
     @pytest.mark.parametrize("module,classname,iris_classname", [
         ('bo', 'EmailOperation', 'UnitTest.EmailOperation'),
-        # Add more test cases here
+        ('bo', 'MyOperation', 'UnitTest.MyOperation'),
     ])
     def test_register_component(self, register_path, module, classname, iris_classname):
         _Utils.register_component(