refactor from grongier.pex to iop

Author: grongierisc

README.md

@@ -51,7 +51,7 @@ This proof of concept aims to show how the **iris interoperability framework** c
       - [6.12.4.1. setting.py file](#61241-settingpy-file)
         - [6.12.4.1.1. CLASSES section](#612411-classes-section)
         - [6.12.4.1.2. Productions section](#612412-productions-section)
-  - [6.13. Direct use of Grongier.PEX](#613-direct-use-of-grongierpex)
+  - [6.13. Direct use of IOP](#613-direct-use-of-iop)
 - [7. Command line](#7-command-line)
   - [7.1. help](#71-help)
   - [7.2. default](#72-default)
@@ -71,7 +71,7 @@ This proof of concept aims to show how the **iris interoperability framework** c
 
 bo.py
 ```python
-from grongier.pex import BusinessOperation,Message
+from iop import BusinessOperation,Message
 
 class MyBusinessOperation(BusinessOperation):
 
@@ -119,7 +119,7 @@ This file will be used to register your classes and productions.<br>
 e.g.:
 setting.py
 ```python
-from grongier.pex import Utils
+from iop import Utils
 
 import bo
 
@@ -162,7 +162,7 @@ pip3 install iris-pex-embedded-python
 Import the ObjectScript classes, open an embedded python shell and run :
 
 ```python
-from grongier.pex import Utils
+from iop import Utils
 Utils.setup()
 ```
 
@@ -307,7 +307,7 @@ This file will allow us to create the classes to import in the code.<br>
 It gets from the multiple files seen earlier the classes and make them into callable classes.
 That way, when you wish to create a business operation, for example, you can just do:
 ```python
-from grongier.pex import BusinessOperation
+from iop import BusinessOperation
 ```
 
 ## 6.2. The `common` class
@@ -366,7 +366,7 @@ TypeError: if request is not of type Message or IRISObject.
 
 
 ## 6.4. The `inbound_adapter` class
-Inbound Adapter in Python are subclass from grongier.pex.InboundAdapter in Python, that inherit from all the functions of the [common class](#72-the-common-class).<br>
+Inbound Adapter in Python are subclass from iop.InboundAdapter in Python, that inherit from all the functions of the [common class](#72-the-common-class).<br>
 This class is responsible for receiving the data from the external system, validating the data, and sending it to the business service by calling the BusinessHost process_input method.
 This class defines:
 
@@ -375,7 +375,7 @@ The message can have any structure agreed upon by the inbound adapter and the bu
 
 Example of an inbound adapter ( situated in the src/python/demo/reddit/adapter.py file ):
 ```python
-from grongier.pex import InboundAdapter
+from iop import InboundAdapter
 import requests
 import iris
 import json
@@ -437,7 +437,7 @@ class RedditInboundAdapter(InboundAdapter):
 ```
 
 ## 6.5. The `outbound_adapter` class
-Outbound Adapter in Python are subclass from grongier.pex.OutboundAdapter in Python, that inherit from all the functions of the [common class](#72-the-common-class).<br>
+Outbound Adapter in Python are subclass from iop.OutboundAdapter in Python, that inherit from all the functions of the [common class](#72-the-common-class).<br>
 This class is responsible for sending the data to the external system.
 
 The Outbound Adapter gives the Operation the possibility to have a heartbeat notion.
@@ -470,7 +470,7 @@ There are three ways of implementing a business service:<br>
 - Nonpolling business service - The production framework does not initiate the business service. Instead custom code in either a long-running process 
     or one that is started at regular intervals initiates the business service by calling the Director.CreateBusinessService() method.
 
-Business service in Python are subclass from grongier.pex.BusinessService in Python, that inherit from all the functions of the [business host](#73-the-business_host-class).<br>
+Business service in Python are subclass from iop.BusinessService in Python, that inherit from all the functions of the [business host](#73-the-business_host-class).<br>
 This class defines:
 
 `on_process_input`: Receives the message from the inbond adapter via the PRocessInput method and is responsible for forwarding it to target business processes or operations.<br>
@@ -483,7 +483,7 @@ The message can have any structure agreed upon by the inbound adapter and the bu
 
 Example of a business service ( situated in the src/python/demo/reddit/bs.py file ):
 ```python
-from grongier.pex import BusinessService
+from iop import BusinessService
 
 import iris
 
@@ -520,7 +520,7 @@ Typically contains most of the logic in a production.<br>
 A business process can receive messages from a business service, another business process, or a business operation.<br>
 It can modify the message, convert it to a different format, or route it based on the message contents.<br>
 The business process can route a message to a business operation or another business process.<br>
-Business processes in Python are subclass from grongier.pex.BusinessProcess in Python, that inherit from all the functions of the [business host](#73-the-business_host-class).<br>
+Business processes in Python are subclass from iop.BusinessProcess in Python, that inherit from all the functions of the [business host](#73-the-business_host-class).<br>
 This class defines:
 
 `on_request`: Handles requests sent to the business process. A production calls this method whenever an initial request for a specific business process arrives on the appropriate queue and is assigned a job in which to execute.<br>
@@ -561,7 +561,7 @@ An instance of IRISObject or subclass of Message that contains the response mess
 
 Example of a business process ( situated in the src/python/demo/reddit/bp.py file ):
 ```python
-from grongier.pex import BusinessProcess
+from iop import BusinessProcess
 
 from message import PostMessage
 from obj import PostClass
@@ -600,7 +600,7 @@ This class is responsible for sending the data to an external system or a local
 The business operation can optionally use an adapter to handle the outgoing message which is specified overriding the get_adapter_type method.<br>
 If the business operation has an adapter, it uses the adapter to send the message to the external system.<br>
 The adapter can either be a PEX adapter, an ObjectScript adapter or a [python adapter](#75-the-outbound_adapter-class).<br>
-Business operation in Python are subclass from grongier.pex.BusinessOperation in Python, that inherit from all the functions of the [business host](#73-the-business_host-class).<br>
+Business operation in Python are subclass from iop.BusinessOperation in Python, that inherit from all the functions of the [business host](#73-the-business_host-class).<br>
 
 ### 6.8.1. The dispacth system
 In a business operation it is possbile to create any number of function [similar to the on_message method](#782-the-methods) that will take as argument a [typed request](#711-the-messages) like this `my_special_message_method(self,request: MySpecialMessage)`.
@@ -622,7 +622,7 @@ The response object
 
 Example of a business operation ( situated in the src/python/demo/reddit/bo.py file ):
 ```python
-from grongier.pex import BusinessOperation
+from iop import BusinessOperation
 
 from message import MyRequest,MyMessage
 
@@ -721,13 +721,13 @@ class PostClass:
 
 ## 6.11. The `messages`
 The messages will contain one or more [objects](#710-the-objects), located in the `obj.py` file.<br>
-Messages, requests and responses all inherit from the `grongier.pex.Message` class.
+Messages, requests and responses all inherit from the `iop.Message` class.
 
 These messages will allow us to transfer information between any business service/process/operation.
 
 Example of a message ( situated in the src/python/demo/reddit/message.py file ):
 ```python
-from grongier.pex import Message
+from iop import Message
 
 from dataclasses import dataclass
 
@@ -760,13 +760,13 @@ Start an embedded python shell :
 Then use this class method to add a new py file to the component list for interoperability.
 
 ```python
-from grongier.pex import Utils
+from iop import Utils
 Utils.register_component(<ModuleName>,<ClassName>,<PathToPyFile>,<OverWrite>,<NameOfTheComponent>)
 ```
 
 e.g :
 ```python
-from grongier.pex import Utils
+from iop import Utils
 Utils.register_component("MyCombinedBusinessOperation","MyCombinedBusinessOperation","/irisdev/app/src/python/demo/",1,"PEX.MyCombinedBusinessOperation")
 ```
 
@@ -781,13 +781,13 @@ Start an embedded python shell :
 Then use this class method to add a new py file to the component list for interoperability.
 
 ```python
-from grongier.pex import Utils
+from iop import Utils
 Utils.register_file(<File>,<OverWrite>,<PackageName>)
 ```
 
 e.g :
 ```python
-from grongier.pex import Utils
+from iop import Utils
 Utils.register_file("/irisdev/app/src/python/demo/bo.py",1,"PEX")
 ```
 
@@ -802,13 +802,13 @@ Start an embedded python shell :
 Then use this class method to add a new py file to the component list for interoperability.
 
 ```python
-from grongier.pex import Utils
+from iop import Utils
 Utils.register_folder(<Path>,<OverWrite>,<PackageName>)
 ```
 
 e.g :
 ```python
-from grongier.pex import Utils
+from iop import Utils
 Utils.register_folder("/irisdev/app/src/python/demo/",1,"PEX")
 ```
 
@@ -823,7 +823,7 @@ Start an embedded python shell :
 Then use this static method to migrate the settings file to the iris framework.
 
 ```python
-from grongier.pex import Utils
+from iop import Utils
 Utils.migrate()
 ```
 
@@ -1050,9 +1050,9 @@ PRODUCTIONS = [
     ]
 ```
 
-## 6.13. Direct use of Grongier.PEX
+## 6.13. Direct use of IOP
 
-If you don't want to use the register_component util. You can add a Grongier.PEX.BusinessService component directly into the management portal and configure the properties :
+If you don't want to use the register_component util. You can add a IOP.BusinessService component directly into the management portal and configure the properties :
 - %module :
   - Module name of your python code
 - %classname :
@@ -1075,7 +1075,7 @@ iop
 
 output :
 ```bash
-usage: python3 -m grongier.pex [-h] [-d DEFAULT] [-l] [-s START] [-k] [-S] [-r] [-M MIGRATE] [-e EXPORT] [-x] [-v] [-L]
+usage: python3 -m iop [-h] [-d DEFAULT] [-l] [-s START] [-k] [-S] [-r] [-M MIGRATE] [-e EXPORT] [-x] [-v] [-L]
 optional arguments:
   -h, --help            display help and default production name
   -d DEFAULT, --default DEFAULT
@@ -1107,7 +1107,7 @@ iop -h
 
 output :
 ```bash
-usage: python3 -m grongier.pex [-h] [-d DEFAULT] [-l] [-s START] [-k] [-S] [-r] [-M MIGRATE] [-e EXPORT] [-x] [-v] [-L]
+usage: python3 -m iop [-h] [-d DEFAULT] [-l] [-s START] [-k] [-S] [-r] [-M MIGRATE] [-e EXPORT] [-x] [-v] [-L]
 ...
 default production: PEX.Production
 ```

demo/python/reddit/adapter.py

@@ -1,4 +1,4 @@
-from grongier.pex import InboundAdapter,OutboundAdapter
+from iop import InboundAdapter,OutboundAdapter
 import requests
 import iris
 import json

demo/python/reddit/bo.py

@@ -1,5 +1,5 @@
 
-from grongier.pex import BusinessOperation, Utils
+from iop import BusinessOperation, Utils
 
 import iris
 

demo/python/reddit/bp.py

@@ -1,4 +1,4 @@
-from grongier.pex import BusinessProcess
+from iop import BusinessProcess
 
 from message import PostMessage
 from obj import PostClass

demo/python/reddit/bs.py

@@ -1,4 +1,4 @@
-from grongier.pex import BusinessService
+from iop import BusinessService
 
 import iris
 

demo/python/requirements.txt

@@ -1,3 +1,3 @@
 dataclasses-json==0.5.7
 requests==2.27.1
-iris-pex-embedded-python>=2.0.0
+iris-pex-embedded-python>=3.0.0

module.xml

@@ -3,13 +3,13 @@
   <Document name="pex-embbeded-python.ZPM">
     <Module>
       <Name>pex-embbeded-python</Name>
-      <Version>2.3.24</Version>
+      <Version>3.0.0</Version>
       <Description>Hack of PEX Python but for Embedded Python</Description>
       <Keywords>python</Keywords>
       <SystemRequirements Interoperability="enabled" />
       <Packaging>module</Packaging>
-      <SourcesRoot>src/grongier/cls</SourcesRoot>
-      <Resource Name="Grongier.PKG"/>
+      <SourcesRoot>src/iop/cls</SourcesRoot>
+      <Resource Name="IOP.PKG"/>
       <SystemRequirements Version=">=2021.2" Interoperability="enabled" />
     </Module>
   </Document>

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools", "wheel"]
 
 [project]
 name = "iris_pex_embedded_python"
-version = "2.3.28"
+version = "3.0.0"
 description = "Iris Interoperability based on Embedded Python"
 readme = "README.md"
 authors = [

requirements.txt

@@ -1 +1 @@
-iris-pex-embedded-python>=2.0.0
+iris-pex-embedded-python>=3.0.0

src/grongier/cls/Grongier/PEX/BusinessOperation.cls

@@ -2,34 +2,7 @@
    Cambridge, Massachusetts, U.S.A.  All rights reserved.
    Confidential property of InterSystems Corporation. */
 
-Class Grongier.PEX.BusinessOperation Extends (Ens.BusinessOperation, Grongier.PEX.Common) [ Inheritance = right, ProcedureBlock, System = 4 ]
+Class Grongier.PEX.BusinessOperation Extends IOP.BusinessOperation [ Inheritance = right, ProcedureBlock, System = 4 ]
 {
 
-Parameter SETTINGS = "%classname:Python BusinessOperation,%module:Python BusinessOperation,%settings:Python BusinessOperation,%classpaths:Python BusinessOperation";
-
-Method OnMessage(
-	request As %Library.Persistent,
-	Output response As %Library.Persistent) As %Status
-{
-	set tSC = $$$OK
-	try {
-		set response = ..%class."_dispatch_on_message"(request)
-	} catch ex {
-		set tSC = ex.AsStatus()
-	}
-	quit tSC
-}
-
-Method OnKeepalive(pStatus As %Status = {$$$OK}) As %Status
-{
-	set tSC = $$$OK
-	try {
-		$$$ThrowOnError(##super(pStatus))
-		do ..%class."on_keepalive"()
-	} catch ex {
-		set tSC = ex.AsStatus()
-	}
-	quit tSC
-}
-
 }