iris-pex-embedded-python 4.0.0b15__py3-none-any.whl → 4.0.1b2__py3-none-any.whl

iop/__init__.py

@@ -125,8 +125,8 @@ class BusinessService(_BusinessService):
         production graph.
 
     Lifecycle:
-        IRIS calls on_process_input(); the default implementation delegates to
-        on_process_input(request).
+        IRIS calls on_process_input(); the default implementation delegates the
+        incoming request to on_message(request).
 
     Best practices:
         Declare outbound routes with target() and wire them in a Production

iop/components/business_service.py

@@ -20,16 +20,13 @@ def _call_process_input(method, request):
 
 
 class _BusinessService(_BusinessHost):
-    """This class is responsible for receiving the data from external system and sending it to business processes or business operations in the production.
-    The business service can use an adapter to access the external system, which is specified in the InboundAdapter property.
-    There are three ways of implementing a business service:
-    1) Polling business service with an adapter - The production framework at regular intervals calls the adapter's task method,
-        which sends incoming data to the business service process input method.
-    2) Polling business service that uses the default adapter - In this case, the framework calls the default adapter's OnTask method with no data.
-        The on_process_input() method then performs the role of the adapter and is responsible for accessing the external system and receiving the data.
-    3) 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 through the Director API.
-    """
+    """Runtime base for inbound production entry points.
+
+    IRIS invokes on_process_input(...). By default, that hook delegates to
+    on_message(...). Application code should normally subclass iop.BusinessService
+    or iop.PollingBusinessService and wire outbound routes with target() in a
+    Production graph.
+    """
 
     Adapter = adapter = None
     _wait_for_next_call_interval = False
@@ -79,13 +76,12 @@ class _BusinessService(_BusinessHost):
         return None
 
     def on_process_input(self, message_input=None):
-        """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
-        and the business service is responsible for receiving the data from the external system and validating it.
+        """Handle IRIS ProcessInput and delegate to on_message(message_input).
 
-        Parameters:
-        message_input: an instance of IRISObject or subclass of Message containing the data that the inbound adapter passes in.
-            The message can have any structure agreed upon by the inbound adapter and the business service.
+        Override this low-level hook only when an inbound adapter or Director
+        call needs custom ProcessInput handling. For simple services, override
+        on_message(...); for scheduled polling, use PollingBusinessService and
+        override on_poll().
         """
         return self.on_message(message_input)
 

iop/migration/utils.py

@@ -193,8 +193,11 @@ def register_component(
     overwrite: int = 1,
     iris_classname: str = "Python",
 ):
-    """
-    It registers a component in the Iris database.
+    """Register a Python component as an IRIS proxy class.
+
+    Prefer a Python Production graph in PRODUCTIONS for new application
+    components. Use register_component() directly for standalone bindings,
+    legacy migration helpers, or manual proxy registration only.
 
     :param module: The name of the module that contains the class
     :type module: str
@@ -239,8 +242,11 @@ def bind_component(
     overwrite: int = 1,
     iris_classname: str = "Python",
 ):
-    """
-    Public alias for registering a Python component as an IRIS proxy class.
+    """Public alias for register_component().
+
+    Prefer a Python Production graph in PRODUCTIONS for new application
+    components. Use bind_component() directly only for standalone bindings,
+    legacy migration helpers, or manual proxy registration.
     """
     return register_component(module, classname, path, overwrite, iris_classname)
 
@@ -436,18 +442,12 @@ def migrate(
     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:
-        * CLASSES
-            * key: the name of the class
-            * value: an instance of the class
-        * PRODUCTIONS
-            list of dictionaries:
-            * key: the name of the production
-            * value: a dictionary containing the settings for the production
-        * SCHEMAS
-            List of classes
+    """Read a migration file and apply its registrations to IRIS.
+
+    New Python-authored applications should normally export Production objects
+    through PRODUCTIONS. CLASSES remains available for standalone bindings,
+    native PersistentMessage classes, and legacy migration files. SCHEMAS
+    registers Message or PydanticMessage schemas for DTL support.
     """
     settings, path = _load_settings(filename)
 
@@ -546,7 +546,19 @@ def _build_migration_manifest(
 
 
 def _load_settings(filename):
-    """Load settings module from file or default location.
+    """Load a migration settings module.
+
+    Purpose:
+        Resolve settings.py as a file-based module and keep imports local to the
+        settings file directory for this process.
+
+    Best practices:
+        Keep modules imported by settings.py in the same project/package rooted
+        near the settings file. Let IoP manage temporary import path setup.
+
+    Common mistakes:
+        Do not require users to set PYTHONPATH. Do not mutate environment
+        variables to force imports when module/package layout should be fixed.
 
     Returns:
         tuple: (settings_module, path_added_to_sys)
@@ -723,6 +735,20 @@ def _cleanup_sys_path(path):
 
 
 def import_module_from_path(module_name, file_path):
+    """Import one module from an absolute file path.
+
+    Purpose:
+        Execute a specific settings or component module by file location
+        without relying on global PYTHONPATH configuration.
+
+    Best practices:
+        Use absolute paths and stable module/package layout so imports resolve
+        from the project directory containing settings.py.
+
+    Common mistakes:
+        Do not patch PYTHONPATH or sys.path globally to make imports pass.
+        Keep import fixes in project structure and import statements.
+    """
     if not os.path.isabs(file_path):
         raise ValueError("The file path must be absolute")
 

{iris_pex_embedded_python-4.0.0b15.dist-info → iris_pex_embedded_python-4.0.1b2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iris_pex_embedded_python
-Version: 4.0.0b15
+Version: 4.0.1b2
 Summary: Iris Interoperability based on Embedded Python
 Author-email: grongier <guillaume.rongier@intersystems.com>
 License: MIT License
@@ -69,14 +69,38 @@ For application repositories, start from the [reusable AGENTS.md template](https
 
 ## Example
 
-Here's a simple example of how a Business Operation can be implemented in Python:
+Here's a tiny Python-authored production:
 
 ```python
-from iop import BusinessOperation
+from dataclasses import dataclass
 
-class MyBo(BusinessOperation):
-    def on_message(self, request):
-        self.log_info("Hello World")
+from iop import BusinessOperation, Message, PollingBusinessService, Production, target
+
+
+@dataclass
+class HelloRequest(Message):
+    text: str = "Hello World"
+
+
+class HelloService(PollingBusinessService):
+    Output = target()
+
+    def on_poll(self):
+        self.send_request_async(self.Output, HelloRequest())
+
+
+class HelloOperation(BusinessOperation):
+    def on_message(self, request: HelloRequest):
+        self.log_info(request.text)
+        return request
+
+
+prod = Production("HelloWorld.Production", testing_enabled=True)
+service = prod.service("HelloService", HelloService)
+operation = prod.operation("HelloOperation", HelloOperation)
+prod.connect(service.Output, operation)
+
+PRODUCTIONS = [prod]
 ```
 
 ## Installation

{iris_pex_embedded_python-4.0.0b15.dist-info → iris_pex_embedded_python-4.0.1b2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-iop/__init__.py,sha256=4QGYNWs4t-Zt4-WfjHXmKRosWS5jZ5A27vl2hiObCVc,10621
+iop/__init__.py,sha256=bnhSiC7XcOIiS7e51uY8fr9Li7RYjhCnlCyVDzZI6-I,10636
 iop/__main__.py,sha256=2rUNM7vaYK0W57Jj72rm7GORyIFLMXKwPq3QNLwYBmY,100
 iop/cli/__init__.py,sha256=Y78pBdA-ULzq1c_9xQZsFBlzm3x5xgxSzkvrH5DoM7I,31
 iop/cli/formatting.py,sha256=OLgHA1d8_paAuINQyKkYgihWMLoBhPn7kSXW5whRlIs,1606
@@ -39,7 +39,7 @@ iop/components/async_request.py,sha256=AU36pf6NIQMM9ZYR5h6LeQry0EfXXqDaKAjsP16_h
 iop/components/business_host.py,sha256=5EXwzZzfEVYLFlzi519GXKclTz2m5FMcqtl10lLzUyw,12089
 iop/components/business_operation.py,sha256=KycRNz-zuyJs2VneTBVcppyd3rKLekrISjbubCbzHxY,2905
 iop/components/business_process.py,sha256=1xTYwqhvJaXC-BvQ5WoGOud5QwxT9EPpvDPDX4zThXg,9839
-iop/components/business_service.py,sha256=fwSdHGFuC55_qSjFBpW-cLZmrK3Cm8Yxgk1KvxuQv2Y,4718
+iop/components/business_service.py,sha256=Bp47bJzTWHp66kp0Zo_D-blOKHzj4i6kXu-lCRMMzfg,3597
 iop/components/common.py,sha256=tsP2APRBnks1hVazS9dX0Q8KCoANbUsnaFTlzqOIkVY,19063
 iop/components/debugpy.py,sha256=sNFKaF9MtWBNAqxH4ubSIVqjsIpsHGjRK2jzBU-O59Y,6011
 iop/components/generator_request.py,sha256=NOllwJnY06kk_eC7cQXDQ8NBFKfQakyz3A_AgYJ5f5Y,1351
@@ -61,7 +61,7 @@ iop/migration/__init__.py,sha256=wp-RvjLKYW_Pi2AJLfiWe1bACxENzEgjXtP9UMNiSVY,36
 iop/migration/io.py,sha256=hAehtApFZFgGzjzgwBmDMxdA1xoRhE-okOcEzvgFdQ4,1822
 iop/migration/manifest.py,sha256=Bs4eC1_i-ZnovlgSW9FKu5WBwy_6Zwy5ZAcsi5A1szU,19351
 iop/migration/plans.py,sha256=5kx3aqQiPDJ3F8hU9pp9_mOO1_N6GA0Ps7--G1Iv6z8,2549
-iop/migration/utils.py,sha256=A3BlFpBGsDpF5DyA2DE1Oy52Ja7qC8QbFCxLFe_Xzg0,36867
+iop/migration/utils.py,sha256=pOojLPMZes05KXrGN2ap45ffppP5Z4tS4bjJ0gSD5Oc,38183
 iop/production/__init__.py,sha256=95VmJgC3lWtHpUJijLqyKKxFZa65OcRni8803kb4aHE,2148
 iop/production/actions.py,sha256=TLVAjPTPq21oLj9c-IG10qMNJ2hvPzueviMy_c1a0ZU,17199
 iop/production/common.py,sha256=IoUg9jkFzSQwDsHcXvkVAC4qxpWKs3kTfXFm_EP07EU,3091
@@ -91,9 +91,9 @@ iop/runtime/remote/director.py,sha256=bkie751GrYLgGs7ApRCowHpSnJA8KupxCOrFDQmjyO
 iop/runtime/remote/migration.py,sha256=Iboz-Ye7i9xif9bn433GazCF-gtD-HJW3wiUwWS5P6w,1831
 iop/runtime/remote/settings.py,sha256=P1Hsgld5o57HpSZgPVZzobyjlUmxJj6bstiWvR0JXnc,2144
 iop/runtime/remote/setup.py,sha256=Tr80F3JJTy7oSUso2jyx0iA_KZayd4MYt9vL0BvPpMA,2600
-iris_pex_embedded_python-4.0.0b15.dist-info/licenses/LICENSE,sha256=rZSiBFId_sfbJ6RL0GjjPX-InNLkNS9ou7eQsikciI8,1089
-iris_pex_embedded_python-4.0.0b15.dist-info/METADATA,sha256=FAs1I9jhJCMQabHY14tAR02X2fnv_DS7Yu-yrAZLVso,5284
-iris_pex_embedded_python-4.0.0b15.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-iris_pex_embedded_python-4.0.0b15.dist-info/entry_points.txt,sha256=fzS8ZFsPe8cnpEx208X60DNugCPQmuSloPeg4pyyJDY,42
-iris_pex_embedded_python-4.0.0b15.dist-info/top_level.txt,sha256=BM54-OXQ6l2BDtmesWNXckh033s9gcjoO7bfjbwZbxU,4
-iris_pex_embedded_python-4.0.0b15.dist-info/RECORD,,
+iris_pex_embedded_python-4.0.1b2.dist-info/licenses/LICENSE,sha256=rZSiBFId_sfbJ6RL0GjjPX-InNLkNS9ou7eQsikciI8,1089
+iris_pex_embedded_python-4.0.1b2.dist-info/METADATA,sha256=_ECUhPwnkbE0A3kXsGrptdIEBcOaWWuOEFOT9p25n1I,5846
+iris_pex_embedded_python-4.0.1b2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+iris_pex_embedded_python-4.0.1b2.dist-info/entry_points.txt,sha256=fzS8ZFsPe8cnpEx208X60DNugCPQmuSloPeg4pyyJDY,42
+iris_pex_embedded_python-4.0.1b2.dist-info/top_level.txt,sha256=BM54-OXQ6l2BDtmesWNXckh033s9gcjoO7bfjbwZbxU,4
+iris_pex_embedded_python-4.0.1b2.dist-info/RECORD,,