naeural-client 2.1.0__py3-none-any.whl → 2.1.2__py3-none-any.whl

naeural_client/_ver.py

@@ -1,4 +1,4 @@
-__VER__ = "2.1.0"
+__VER__ = "2.1.2"
 
 if __name__ == "__main__":
   with open("pyproject.toml", "rt") as fd:

naeural_client/base/generic_session.py

@@ -1717,32 +1717,50 @@ class GenericSession(BaseDecentrAIObject):
       *,
       node,
       name,
-      signature=PLUGIN_SIGNATURES.CUSTOM_WEB_APP_01,
+      signature=PLUGIN_SIGNATURES.BASIC_TELEGRAM_BOT_01,
       message_handler=None,
       telegram_bot_token=None,
       telegram_bot_token_env_key=ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY,
+      telegram_bot_name=None,
+      telegram_bot_name_env_key=ENVIRONMENT.TELEGRAM_BOT_NAME_ENV_KEY,
       **kwargs
     ):
       
+      assert callable(message_handler), "The `message_handler` method parameter must be provided."
+      
       if telegram_bot_token is None:
         telegram_bot_token = os.getenv(telegram_bot_token_env_key)
         if telegram_bot_token is None:
           message = f"Warning! No Telegram bot token provided as via env {ENVIRONMENT.TELEGRAM_BOT_TOKEN_ENV_KEY} or explicitly as `telegram_bot_token` param."
           raise ValueError(message)
+        
+      if telegram_bot_name is None:
+        telegram_bot_name = os.getenv(telegram_bot_name_env_key)
+        if telegram_bot_name is None:
+          message = f"Warning! No Telegram bot name provided as via env {ENVIRONMENT.TELEGRAM_BOT_NAME_ENV_KEY} or explicitly as `telegram_bot_name` param."
+          raise ValueError(message)
       
-      b64code = self._get_base64_code(message_handler)
 
       pipeline: Pipeline = self.create_pipeline(
         node=node,
         name=name,
         # default TYPE is "Void"
       )
-
+      
+      func_name, func_args, func_base64_code = pipeline._get_method_data(message_handler)
+      if len(func_args) != 2:
+        raise ValueError("The message handler function must have exactly 3 arguments: `plugin`, `message` and `user`.")
+      
+      obfuscated_token = telegram_bot_token[:4] + "*" * (len(telegram_bot_token) - 4)      
+      self.P(f"Creating telegram bot {telegram_bot_name} with token {obfuscated_token}...", color='b')      
       instance = pipeline.create_plugin_instance(
         signature=signature,
         instance_id=self.log.get_unique_id(),
         telegram_bot_token=telegram_bot_token,
-        message_handler=b64code,
+        telegram_bot_name=telegram_bot_name,
+        message_handler=func_base64_code,
+        message_handler_args=func_args, # mandatory message and user
+        message_handler_name=func_name, # not mandatory
         **kwargs
       )      
       return pipeline, instance
@@ -1852,3 +1870,10 @@ class GenericSession(BaseDecentrAIObject):
       # end for detach
 
       return lst_result_payload
+
+    def get_client_address(self):
+      return self.bc_engine.address
+    
+    @property
+    def client_address(self):
+      return self.get_client_address()

naeural_client/base/instance.py

@@ -202,6 +202,7 @@ class Instance():
 
       return f"<Instance: {node_addr}/{pipeline_name}/{signature}/{instance_id}>"
 
+
     def _is_tainted(self):
       """
       Check if the instance has a proposed configuration.
@@ -213,6 +214,7 @@ class Instance():
       """
       return self.proposed_config is not None
 
+
     def _get_config_dictionary(self):
       """
       Get the configuration of the instance as a dictionary.
@@ -229,6 +231,7 @@ class Instance():
 
       return config_dict
 
+
     def _get_proposed_config_dictionary(self, full=False):
       """
       Get the proposed configuration of the instance as a dictionary.
@@ -249,6 +252,7 @@ class Instance():
 
       return proposed_config_dict
 
+
     def _apply_staged_config(self, verbose=False):
       """
       Apply the staged configuration to the instance.
@@ -264,6 +268,7 @@ class Instance():
       self.__staged_config = None
       return
 
+
     def _discard_staged_config(self, fail_reason: str):
       """
       Discard the staged configuration for the instance.
@@ -274,6 +279,7 @@ class Instance():
       self.__staged_config = None
       return
 
+
     def _stage_proposed_config(self):
       """
       Stage the proposed configuration for the instance.
@@ -291,6 +297,7 @@ class Instance():
       self.__was_last_operation_successful = None
       return
 
+
     def _handle_instance_command_success(self):
       """
       Handle the success of the instance command.
@@ -299,6 +306,7 @@ class Instance():
       self.__was_last_operation_successful = True
       return
 
+
     def _handle_instance_command_failure(self, fail_reason: str):
       """
       Handle the failure of the instance command.
@@ -307,6 +315,7 @@ class Instance():
       self.__was_last_operation_successful = False
       return
 
+
     def __register_transaction_for_instance_command(self, session_id: str = None, timeout: float = 0) -> list[Transaction]:
       """
       Register a new transaction for the instance command.
@@ -340,6 +349,7 @@ class Instance():
 
       return transactions
 
+
     def _get_instance_update_required_responses(self):
       """
       Get the responses required to update the instance.
@@ -356,6 +366,7 @@ class Instance():
 
       return responses
 
+
     def _get_instance_remove_required_responses(self):
       """
       Get the responses required to delete the instance.
@@ -371,6 +382,23 @@ class Instance():
 
       return responses
 
+    def _get_method_data(self, method: callable):
+      """
+      Get the full signature and definition of a method.
+      
+      Parameters
+      ----------
+      
+      method : callable
+          The method to get the signature and definition for.
+          
+      Returns
+      -------
+      tuple
+          A tuple containing the name, arguments and base64 code of the method.
+      """
+      return self.pipeline._get_method_data(method)
+    
   # API
   if True:
     @property
@@ -399,10 +427,12 @@ class Instance():
       """
       return self.__was_last_operation_successful
 
+
     def _sync_configuration_with_remote(self, config):
       self.config = {**self.config, **config}
       return
 
+
     def update_instance_config(self, config={}, **kwargs):
       """
       Update the configuration of the instance.
@@ -438,6 +468,7 @@ class Instance():
 
       return
 
+
     def send_instance_command(self, command, payload=None, command_params=None, wait_confirmation=True, session_id=None, timeout=10):
       """
       Send a command to the instance.
@@ -495,6 +526,7 @@ class Instance():
         return transactions
       return
 
+
     def close(self):
       """
       Close the instance.
@@ -502,20 +534,24 @@ class Instance():
       self.pipeline.remove_plugin_instance(self)
       return
 
+
     def stop(self):
       """
       Close the instance. Alias for `close`.
       """
       self.close()
 
+
     def P(self, *args, **kwargs):
       self.log.P(*args, **kwargs)
       return
 
+
     def D(self, *args, **kwargs):
       self.log.D(*args, **kwargs)
       return
 
+
     def temporary_attach(self, on_data=None, on_notification=None):
       """
       Attach a temporary callback to the instance.
@@ -542,6 +578,7 @@ class Instance():
 
       return attachment
 
+
     def temporary_detach(self, attachment):
       """
       Detach a temporary callback from the instance.
@@ -555,6 +592,7 @@ class Instance():
       self._remove_temporary_on_notification_callback(attachment)
       return
 
+   
     def convert_to_specialized_class(self, specialized_class):
       """
       Convert the object to a specialized class.
@@ -564,6 +602,7 @@ class Instance():
       self.__class__ = specialized_class
       return self
 
+
     def send_instance_command_and_wait_for_response_payload(self, command, payload=None, command_params=None, timeout_command=10, timeout_response_payload=3, response_params_key="COMMAND_PARAMS"):
       """
       Send a command to the instance and wait for the response payload.

naeural_client/base/pipeline.py

@@ -664,6 +664,7 @@ class Pipeline(BaseCodeChecker):
 
       return self.code_to_base64(plain_code, verbose=False)
 
+    
   # Message handling
   if True:
     def _on_data(self, signature, instance_id, data):
@@ -1497,3 +1498,5 @@ class Pipeline(BaseCodeChecker):
       Return the node id of the pipeline.
       """
       return self.session.get_node_name(self.node_addr)
+
+

naeural_client/code_cheker/base.py

@@ -428,7 +428,15 @@ class BaseCodeChecker:
 
     return res
 
-  def _get_method_from_custom_code(self, str_b64code, debug=False, result_vars=RESULT_VARS, self_var=None, modify=True, method_arguments=[]):
+  def _get_method_from_custom_code(
+    self, 
+    str_b64code, 
+    debug=False, 
+    result_vars=RESULT_VARS, 
+    self_var=None, 
+    modify=True, 
+    method_arguments=[]
+    ):
     exec_code__result_vars = result_vars
     exec_code__debug = debug
     exec_code__self_var = self_var
@@ -470,8 +478,9 @@ class BaseCodeChecker:
         exec_code__errors = ["Cannot encapsulate code in method. No return statement found."]
         return exec_code__result_var, exec_code__errors, exec_code__warnings
       # endif can encapsulate code in method
-
-      exec(exec_code__code)
+      if exec_code__debug:
+        self.__msg("DEBUG EXEC: Encapsulated code: \n{}".format(exec_code__code))
+      exec(exec_code__code) # now we execute the method definition code not the actual method
       if exec_code__debug:
         self.__msg("DEBUG EXEC: locals(): \n{}".format(locals()))
       for _var in exec_code__result_vars:
@@ -521,11 +530,43 @@ class BaseCodeChecker:
     plain_code = '\n'.join([line.rstrip()[indent:] for line in plain_code])
 
     return plain_code
+  
+  def _get_method_data(self, method: callable):
+    """
+    Get the full signature and definition of a method.
+    
+    Parameters
+    ----------
+    
+    method : callable
+        The method to get the signature and definition for.
+        
+    Returns
+    -------
+    tuple
+        A tuple containing the name, arguments and base64 code of the method.
+    """
+    import inspect
+
+    name = method.__name__
+    args = list(map(str, inspect.signature(method).parameters.values()))
+    ## 
+    first_arg = args[0]
+    first_arg = first_arg.split(':')[0]
+    first_arg = first_arg.split('=')[0]
+    first_arg = first_arg.strip()
+    if first_arg in ['self', 'cls', 'plugin']:
+      args = args[1:]
+    ##      
+    source = self.get_function_source_code(method)
+    base64_code = self.code_to_base64(source)
+
+    return name, args, base64_code  
 
 
 if __name__ == '__main__':
   
-  def some_function(x):
+  def some_function(plugin : int, x):
     """
     A simple function that adds 1 to the input.
 
@@ -539,9 +580,44 @@ if __name__ == '__main__':
     _type_
         _description_
     """
+    print(f"Called by: {plugin}")
     return x + 1
   
+  
+  class SomeClass:
+    def __init__(self, eng : BaseCodeChecker, str_b64code, func_args):
+      self.eng : BaseCodeChecker = eng
+      self._func, _, _ = eng._get_method_from_custom_code(
+        str_b64code=str_b64code,
+        self_var='plugin',
+        method_arguments=["plugin"] + func_args,
+        debug=False
+      )  
+      return
+    
+    
+    def my_func(self, a):
+      res = self._func(x=a, plugin=self)
+      return res
+      
+
   checker = BaseCodeChecker()
   source_code = checker.get_function_source_code(some_function)
   print("some_function:\n" + source_code)
+  
+  name, args, b64code = checker._get_method_data(some_function)
+  print(f"Method name: {name}")
+  print(f"Method args: {args}")
+  print(f"Method code: {b64code}")
+  
+  target = SomeClass(checker, str_b64code=b64code, func_args=args)
+  
+  print(some_function(x=9.1, plugin=None))
+  print(target.my_func(9.1))
+  
+  
+  
+  
+  
+  
   

naeural_client/const/environment.py

@@ -30,3 +30,4 @@ class ENVIRONMENT:
   AIXP_SECURED = 'AIXP_SECURED'
   
   TELEGRAM_BOT_TOKEN_ENV_KEY = 'TELEGRAM_BOT_TOKEN'
+  TELEGRAM_BOT_NAME_ENV_KEY = 'TELEGRAM_BOT_NAME'

naeural_client/default/instance/basic_telegram_bot_01_plugin.py

@@ -3,3 +3,5 @@ from ...const import PLUGIN_SIGNATURES
 
 class BasicTelegramBot01(Instance):
   signature = PLUGIN_SIGNATURES.BASIC_TELEGRAM_BOT_01
+
+

naeural_client/default/instance/custom_web_app_01_plugin.py

@@ -12,13 +12,10 @@ class CustomWebApp01(Instance):
     return deepcopy(self.config.get("ENDPOINTS", []))
 
   def get_endpoint_fields(self, method: callable):
-    import inspect
-
-    name = method.__name__
-    args = list(map(str, inspect.signature(method).parameters.values()))[1:]
-    base64_code = self.pipeline._get_base64_code(method)
-
-    return name, args, base64_code
+    """
+    A aliast for get_method_data: it returns the name, args and base64 code of a method.
+    """  
+    return self._get_method_data(method)
 
 
   def get_proposed_assets(self):

{naeural_client-2.1.0.dist-info → naeural_client-2.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.1.0
+Version: 2.1.2
 Summary: `naeural_client` is the Python SDK required for client app development for the Naeural Edge Protocol Edge Protocol framework
 Project-URL: Homepage, https://github.com/Naeural Edge ProtocolEdgeProtocol/naeural_client
 Project-URL: Bug Tracker, https://github.com/Naeural Edge ProtocolEdgeProtocol/naeural_client/issues

{naeural_client-2.1.0.dist-info → naeural_client-2.1.2.dist-info}/RECORD

@@ -1,12 +1,12 @@
 naeural_client/__init__.py,sha256=UKEDGS0wFYyxwmhEAKJGecO2vYbIfRYUP4SQgnK10IE,578
-naeural_client/_ver.py,sha256=PKIJgoKWB4wskSQA9KvdwJkGx2b-A3tKTo2Rq6DMhdw,330
+naeural_client/_ver.py,sha256=aZEmCx4AtKydTHCcglvjwC1deqUrkwRDirx73Nslguk,330
 naeural_client/base_decentra_object.py,sha256=qDBpitcyhr1eEXPD8cGFtcNPNf71fqNRsmOEcCpx4sM,4180
 naeural_client/plugins_manager_mixin.py,sha256=X1JdGLDz0gN1rPnTN_5mJXR8JmqoBFQISJXmPR9yvCo,11106
 naeural_client/base/__init__.py,sha256=hACh83_cIv7-PwYMM3bQm2IBmNqiHw-3PAfDfAEKz9A,259
 naeural_client/base/distributed_custom_code_presets.py,sha256=cvz5R88P6Z5V61Ce1vHVVh8bOkgXd6gve_vdESDNAsg,2544
-naeural_client/base/generic_session.py,sha256=azhJGCXstzBFQjWqW1z5OjwtSn2nkoPCNsSIcag5hIE,69231
-naeural_client/base/instance.py,sha256=m6IKOWuT5GsZVSdFNdcR-ImJTpTdHqNoMe8KQlEK3Gc,19970
-naeural_client/base/pipeline.py,sha256=fWwSNUvvrVvJYzxRBCKTt1f9_pci1hCBiG2LtoyOpMU,57512
+naeural_client/base/generic_session.py,sha256=o5pWWvWPSqZQ15y6YdPdfeSDolos_xa0ufiwMHetGqk,70519
+naeural_client/base/instance.py,sha256=kcZJmjLBtx8Bjj_ysIOx1JmLA-qSpG7E28j5rq6IYus,20444
+naeural_client/base/pipeline.py,sha256=KwcPWD2XMvHotWFMpcnIycFhqiNnZuyUTUWiLU0PM5Y,57519
 naeural_client/base/plugin_template.py,sha256=qGaXByd_JZFpjvH9GXNbT7KaitRxIJB6-1IhbKrZjq4,138123
 naeural_client/base/responses.py,sha256=ZKBZmRhYDv8M8mQ5C_ahGsQvtWH4b9ImRcuerQdZmNw,6937
 naeural_client/base/transaction.py,sha256=bfs6td5M0fINgPQNxhrl_AUjb1YiilLDQ-Cd_o3OR_E,5146
@@ -19,7 +19,7 @@ naeural_client/bc/ec.py,sha256=8ryEvc3__lVXSoYxd1WoTy9c8uC5Q_8R1uME7CeloIg,8578
 naeural_client/certs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 naeural_client/certs/r9092118.ala.eu-central-1.emqxsl.com.crt,sha256=y-6io0tseyx9-a4Pmde1z1gPULtJNSYUpG_YFkYaMKU,1337
 naeural_client/code_cheker/__init__.py,sha256=pwkdeZGVL16ZA4Qf2mRahEhoOvKhL7FyuQbMFLr1E5M,33
-naeural_client/code_cheker/base.py,sha256=WIHP8LICypTBt7HR0FeC1KtIQ-PASTPaeFmCKvT5vuU,17190
+naeural_client/code_cheker/base.py,sha256=lT5DRIFO5rqzsMNCmdMRfkAeevmezozehyfgmhnKpuI,19074
 naeural_client/code_cheker/checker.py,sha256=QWupeM7ToancVIq1tRUxRNUrI8B5l5eoY0kDU4-O5aE,7365
 naeural_client/comm/__init__.py,sha256=za3B2HUKNXzYtjElMgGM9xbxNsdQfFY4JB_YzdyFkVU,76
 naeural_client/comm/amqp_wrapper.py,sha256=hzj6ih07DnLQy2VSfA88giDIFHaCp9uSdGLTA-IFE4s,8535
@@ -29,16 +29,16 @@ naeural_client/const/__init__.py,sha256=G7Fa50SpEhAPOnL8_mxgVmJ0Xq1qEncWd75pg2Bk
 naeural_client/const/apps.py,sha256=i0MNCM1Wf7QUCB4OKO1vGNUonPs6EsnZV6-XZjknppw,439
 naeural_client/const/base.py,sha256=V94oaT7xYrrTGxmLJlynxmbFujVX0G9wIfC8TilH5MU,2548
 naeural_client/const/comms.py,sha256=La6JXWHexH8CfcBCKyT4fCIoeaoZlcm7KtZ57ab4ZgU,2201
-naeural_client/const/environment.py,sha256=bq21Q7e5FXpTNpoek_CUOX5oOZpSJEtNHXiZ79ZHe18,753
+naeural_client/const/environment.py,sha256=1yM4HDX36Evi0fjLou9eHWlO8ywyOhFCqx-pXYfiYPs,803
 naeural_client/const/formatter.py,sha256=AW3bWlqf39uaqV4BBUuW95qKYfF2OkkU4f9hy3kSVhM,200
 naeural_client/const/heartbeat.py,sha256=jGHmKfeHTFOXJaKUT3o_ocnQyF-EpcLeunW-ifkYKfU,2534
 naeural_client/const/misc.py,sha256=1ypROmZsOyp_8zG2LARwPeo-YfXuyYqZnml0elTP4kw,211
 naeural_client/const/payload.py,sha256=k24vH9iJIBBPnCXx7HAEuli2fNAETK7h8ZuVKyKLgbk,5725
 naeural_client/default/__init__.py,sha256=ozU6CMMuWl0LhG8Ae3LrZ65a6tLrptfscVYGf83zjxM,46
 naeural_client/default/instance/__init__.py,sha256=pHR9_5t3xv9ug3nu-8202yW-rqq-KR3C_L5N2xaADTA,548
-naeural_client/default/instance/basic_telegram_bot_01_plugin.py,sha256=STaIwtGCnEZdvxm7cF9NIQeZL5Zlru1c4cMSHKJc5pQ,159
+naeural_client/default/instance/basic_telegram_bot_01_plugin.py,sha256=4674YFg5DfGO8_bYA1Uo77duZgKYGFX1J0Xp8YzjyPM,161
 naeural_client/default/instance/chain_dist_custom_job_01_plugin.py,sha256=QtHi3uXKsVs9eyMgbnvBVbMylErhV1Du4X2-7zDL7Y0,1915
-naeural_client/default/instance/custom_web_app_01_plugin.py,sha256=JblmfDa8ICppHItzEqU2HBSgT0nzZy9NWzgUHQ2sffw,4854
+naeural_client/default/instance/custom_web_app_01_plugin.py,sha256=ZDe-QXmr6KLyUx5wzA3xVrMPg8yHnWLUbGjZtB0PFgg,4785
 naeural_client/default/instance/net_mon_01_plugin.py,sha256=u85i2AiYHkLJnam0wOx-m71hlp0EYyNtk3JwbkOrvHg,1208
 naeural_client/default/instance/view_scene_01_plugin.py,sha256=5kMhd23kL5AYCdOJzrdCqi2ohoQNvmpv8oE6hWQtUWk,720
 naeural_client/default/session/mqtt_session.py,sha256=dpQcBhhVZDo458v0IqJMZb1CsTn-TxXhYjNlyJp9Rp8,2414
@@ -74,7 +74,7 @@ naeural_client/logging/tzlocal/windows_tz.py,sha256=Sv9okktjZJfRGGUOOppsvQuX_eXy
 naeural_client/utils/__init__.py,sha256=mAnke3-MeRzz3nhQvhuHqLnpaaCSmDxicd7Ck9uwpmI,77
 naeural_client/utils/comm_utils.py,sha256=4cS9llRr_pK_3rNgDcRMCQwYPO0kcNU7AdWy_LtMyCY,1072
 naeural_client/utils/dotenv.py,sha256=_AgSo35n7EnQv5yDyu7C7i0kHragLJoCGydHjvOkrYY,2008
-naeural_client-2.1.0.dist-info/METADATA,sha256=I71wSC0lZI0XDuh8j1mIcyHoxL8Y5SNcB0d_K31BTP0,14457
-naeural_client-2.1.0.dist-info/WHEEL,sha256=wukiCwsxxsuzcQTdnC_ZWHZECE4wwOh3xCCrap6i6Ts,87
-naeural_client-2.1.0.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
-naeural_client-2.1.0.dist-info/RECORD,,
+naeural_client-2.1.2.dist-info/METADATA,sha256=jz3-SkppEKJeRwqNP9KoSQ0E9NETayW7VLl6Nm3gxLU,14457
+naeural_client-2.1.2.dist-info/WHEEL,sha256=3U_NnUcV_1B1kPkYaPzN-irRckL5VW_lytn0ytO_kRY,87
+naeural_client-2.1.2.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
+naeural_client-2.1.2.dist-info/RECORD,,

{naeural_client-2.1.0.dist-info → naeural_client-2.1.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.0
+Generator: hatchling 1.26.1
 Root-Is-Purelib: true
 Tag: py3-none-any