naeural-client 2.7.5__py3-none-any.whl → 2.7.7__py3-none-any.whl

naeural_client/_ver.py

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

naeural_client/base/generic_session.py

@@ -42,6 +42,7 @@ from ..utils.config import (
 
 
 DEBUG_MQTT_SERVER = "r9092118.ala.eu-central-1.emqxsl.com"
+SDK_NETCONFIG_REQUEST_DELAY = 300
 
 
 class GenericSession(BaseDecentrAIObject):
@@ -88,6 +89,7 @@ class GenericSession(BaseDecentrAIObject):
               on_notification=None,
               on_heartbeat=None,
               debug_silent=True,
+              debug=False,
               silent=False,
               verbosity=1,
               dotenv_path=None,
@@ -156,8 +158,13 @@ class GenericSession(BaseDecentrAIObject):
         As arguments, it has a reference to this Session object, the node name and the heartbeat payload.
         Defaults to None.
         
-    debug_silent : bool, optional
+    debug_silent : bool, optional 
         This flag will disable debug logs, set to 'False` for a more verbose log, by default True
+        Observation: Obsolete, will be removed
+        
+    debug : bool, optional
+        This flag will enable debug logs, set to 'False` for a more verbose log, by default False
+        
         
     silent : bool, optional
         This flag will disable all logs, set to 'False` for a more verbose log, by default False
@@ -174,9 +181,11 @@ class GenericSession(BaseDecentrAIObject):
         Defaults to True.
     """
     
+    debug = debug or not debug_silent
+    
     self.__at_least_one_node_peered = False
     self.__at_least_a_netmon_received = False
-
+    
     # TODO: maybe read config from file?
     self._config = {**self.default_config, **config}
 
@@ -204,6 +213,9 @@ class GenericSession(BaseDecentrAIObject):
     self._dct_can_send_to_node: dict[str, bool] = {}
     self._dct_node_last_seen_time = {} # key is node address
     self._dct_node_addr_name = {}
+
+    self._dct_netconfig_pipelines_requests = {}
+    
     self.online_timeout = 60
     self.filter_workers = filter_workers
     self.__show_commands = show_commands
@@ -260,7 +272,7 @@ class GenericSession(BaseDecentrAIObject):
       
     super(GenericSession, self).__init__(
       log=log, 
-      DEBUG=not debug_silent, 
+      DEBUG=debug, 
       create_logger=True,
       silent=self.silent,
       local_cache_base_folder=local_cache_base_folder,
@@ -528,8 +540,7 @@ class GenericSession(BaseDecentrAIObject):
         **kwargs
       )
       self.bc_engine.sign(msg_to_send)
-      if not self.silent:
-        self.P(f'Sending encrypted payload to <{node_addr}>', color='y')
+      self.P(f'Sending encrypted payload to <{node_addr}>', color='d')
       self._send_payload(msg_to_send)
       return
 
@@ -551,10 +562,12 @@ class GenericSession(BaseDecentrAIObject):
       additional_data = {
         PAYLOAD_DATA.EE_PAYLOAD_PATH: [self.bc_engine.address, DEFAULT_PIPELINES.ADMIN_PIPELINE, PLUGIN_SIGNATURES.NET_CONFIG_MONITOR, None]
       }
+      self.D("Sending net-config request to <{}>".format(node_addr), color='y')
       self.send_encrypted_payload(
         node_addr=node_addr, payload=payload,
         additional_data=additional_data
       )
+      self._dct_netconfig_pipelines_requests[node_addr] = tm()      
       return
 
     def __track_allowed_node_by_netmon(self, node_addr, dict_msg):
@@ -578,9 +591,17 @@ class GenericSession(BaseDecentrAIObject):
         self.__track_online_node(node_addr, node_alias)
       
       client_is_allowed = self.bc_engine.contains_current_address(node_whitelist)
-      can_send = not node_secured or client_is_allowed or self.bc_engine.address == node_addr
+      can_send = not node_secured or client_is_allowed or self.bc_engine.address == node_addr      
       if node_addr not in self._dct_can_send_to_node and can_send:
-        self.__request_pipelines_from_net_config_monitor(node_addr)
+        if node_online:
+          # only attempt to request pipelines if the node is online and if not recently requested
+          last_requested_by_netmon = self._dct_netconfig_pipelines_requests.get(node_addr, 0)
+          if tm() - last_requested_by_netmon > SDK_NETCONFIG_REQUEST_DELAY:
+            self.__request_pipelines_from_net_config_monitor(node_addr)
+          else:
+            self.D(f"Node <{node_addr}> is online but pipelines were recently requested", color='y')
+        else:
+          self.D(f"Node <{node_addr}> is offline thus NOT sending net-config request", color='y')
       # endif node seen for the first time
 
       self._dct_can_send_to_node[node_addr] = can_send
@@ -623,6 +644,7 @@ class GenericSession(BaseDecentrAIObject):
           The name of the instance that sent the message.
       """
       # extract relevant data from the message
+      self.D("<HB> Received hb from: {}".format(msg_node_addr), verbosity=2)
 
       if dict_msg.get(HB.HEARTBEAT_VERSION) == HB.V2:
         str_data = self.log.decompress_text(dict_msg[HB.ENCODED_DATA])
@@ -647,7 +669,7 @@ class GenericSession(BaseDecentrAIObject):
         # this is for legacy and custom implementation where heartbeats still contain
         # the pipeline configuration.
         pipeline_names = [x.get(PAYLOAD_DATA.NAME, None) for x in msg_active_configs]
-        self.D(f'<HB>Received pipelines from <{msg_node_addr}>:{pipeline_names}', color='y')
+        self.D(f'<HB> Processing pipelines from <{msg_node_addr}>:{pipeline_names}', color='y')
         self.__process_node_pipelines(msg_node_addr, msg_active_configs)
 
       # TODO: move this call in `__on_message_default_callback`
@@ -661,7 +683,7 @@ class GenericSession(BaseDecentrAIObject):
       for transaction in open_transactions_copy:
         transaction.handle_heartbeat(dict_msg)
 
-      self.D("Received hb from: {}".format(msg_node_addr), verbosity=2)
+      self.D("<HB> Received hb from: {}".format(msg_node_addr), verbosity=2)
 
       self.__track_allowed_node_by_hb(msg_node_addr, dict_msg)
 
@@ -746,27 +768,31 @@ class GenericSession(BaseDecentrAIObject):
         current_network = dict_msg.get(PAYLOAD_DATA.NETMON_CURRENT_NETWORK, {})        
         if current_network:
           self.__at_least_a_netmon_received = True
-          all_addresses = [
-            x[PAYLOAD_DATA.NETMON_ADDRESS] for x in current_network.values()
-          ]
-          online_addresses = [
-            x[PAYLOAD_DATA.NETMON_ADDRESS] for x in current_network.values() 
-            if x[PAYLOAD_DATA.NETMON_STATUS_KEY] == PAYLOAD_DATA.NETMON_STATUS_ONLINE
-          ] 
-          self.P(f"Net config from <{sender_addr}> `{ee_id}`:  {len(online_addresses)}/{len(all_addresses)}", color='y')
           self.__current_network_statuses[sender_addr] = current_network
-
+          online_addresses = []
+          all_addresses = []
           for _ , node_data in current_network.items():
-            node_addr = node_data.get("address", None)    
+            node_addr = node_data.get(PAYLOAD_DATA.NETMON_ADDRESS, None)
+            all_addresses.append(node_addr)
+            is_online = node_data.get(PAYLOAD_DATA.NETMON_STATUS_KEY) == PAYLOAD_DATA.NETMON_STATUS_ONLINE
+            node_alias = node_data.get(PAYLOAD_DATA.NETMON_EEID, None)
+            if is_online:
+              # no need to call here __track_online_node as it is already called 
+              # in below in __track_allowed_node_by_netmon
+              online_addresses.append(node_addr)
+            # end if is_online
             if node_addr is not None:
               self.__track_allowed_node_by_netmon(node_addr, node_data)
-              nr_peers = sum([v for k, v in self._dct_can_send_to_node.items()])
-              if nr_peers > 0 and not self.__at_least_one_node_peered:                
-                self.__at_least_one_node_peered = True
-                self.P(
-                  f"Received {PLUGIN_SIGNATURES.NET_MON_01} from {sender_addr}, so far {nr_peers} peers that allow me: {json.dumps(self._dct_can_send_to_node, indent=2)}", 
-                  color='g'
-                )
+            # end if node_addr
+          # end for each node in network map
+          nr_peers = sum(self._dct_can_send_to_node.values())
+          self.P(f"Net config from <{sender_addr}> `{ee_id}`:  {len(online_addresses)}/{len(all_addresses)}", color='y')
+          if nr_peers > 0 and not self.__at_least_one_node_peered:                
+            self.__at_least_one_node_peered = True
+            self.P(
+              f"Received {PLUGIN_SIGNATURES.NET_MON_01} from {sender_addr}, so far {nr_peers} peers that allow me: {json.dumps(self._dct_can_send_to_node, indent=2)}", 
+              color='g'
+            )
           # end for each node in network map
         # end if current_network is valid
       # end if NET_MON_01
@@ -786,31 +812,37 @@ class GenericSession(BaseDecentrAIObject):
       if msg_pipeline.lower() == REQUIRED_PIPELINE.lower() and msg_signature.upper() == REQUIRED_SIGNATURE.upper():
         # extract data
         sender_addr = dict_msg.get(PAYLOAD_DATA.EE_SENDER, None)
+        short_sender_addr = sender_addr[:8] + '...' + sender_addr[-4:]
+        if self.client_address == sender_addr:
+          self.D("<NETCFG> Ignoring message from self", color='d')
         receiver = dict_msg.get(PAYLOAD_DATA.EE_DESTINATION, None)
         if not isinstance(receiver, list):
           receiver = [receiver]
         path = dict_msg.get(PAYLOAD_DATA.EE_PAYLOAD_PATH, [None, None, None, None])
         ee_id = dict_msg.get(PAYLOAD_DATA.EE_ID, None)
+        op = dict_msg.get(NET_CONFIG.NET_CONFIG_DATA, {}).get(NET_CONFIG.OPERATION, "UNKNOWN")
+        # drop any incoming request as we are not a net-config provider just a consumer
+        if op == NET_CONFIG.REQUEST_COMMAND:
+          self.P(f"<NETCFG> Dropping request from <{short_sender_addr}> `{ee_id}`", color='d')
+          return
         
         # check if I am allowed to see this payload
         if not self.bc_engine.contains_current_address(receiver):
-          self.P(f"Received net-config from <{sender_addr}> `{ee_id}` but I am not in the receiver list: {receiver}", color='d')
+          self.P(f"<NETCFG> Received `{op}` from <{short_sender_addr}> `{ee_id}` but I am not in the receiver list: {receiver}", color='d')
           return                
 
-        # decrypt payload
+        # encryption check. By now all should be decrypted
         is_encrypted = dict_msg.get(PAYLOAD_DATA.EE_IS_ENCRYPTED, False)
         if not is_encrypted:
-          self.P(f"Received net-config from <{sender_addr}> `{ee_id}` but it is not encrypted", color='r')
+          self.P(f"<NETCFG> Received from <{short_sender_addr}> `{ee_id}` but it is not encrypted", color='r')
           return
         net_config_data = dict_msg.get(NET_CONFIG.NET_CONFIG_DATA, {})
         received_pipelines = net_config_data.get('PIPELINES', [])
-        self.D(f"Received {len(received_pipelines)} pipelines from <{sender_addr}>")
+        self.D(f"<NETCFG> Received {len(received_pipelines)} pipelines from <{sender_addr}>")
         new_pipelines = self.__process_node_pipelines(sender_addr, received_pipelines)
         pipeline_names = [x.name for x in new_pipelines]
-        self.P(f'<NETCFG>Received pipelines from <{sender_addr}>:{pipeline_names}', color='y')
-        self.D(f'[DEBUG][NETCFG]Received pipelines from <{sender_addr}>:\n{new_pipelines}', color='y')
-
-        # load with same method as a hb
+        if len(new_pipelines) > 0:
+          self.P(f'<NETCFG>   Received NEW pipelines from <{sender_addr}>:{pipeline_names}', color='y')
       return True
       
 
@@ -1163,7 +1195,8 @@ class GenericSession(BaseDecentrAIObject):
       self, 
       seconds=10, 
       close_session_on_timeout=True, 
-      close_pipeline_on_timeout=False
+      close_pipeline_on_timeout=False,
+      **kwargs,
     ):
       """
       Wait for a given amount of time.
@@ -1178,11 +1211,21 @@ class GenericSession(BaseDecentrAIObject):
           
       close_pipeline_on_timeout : bool, optional
           If `True`, will close the pipelines when the time is up, by default False
+          
+      **kwargs : dict
+          Additional or replacement parameters to be passed to the `run` method:
+            `close_session` : bool - If `True` will close the session when the loop is exited.
+            `close_pipelines` : bool - If `True` will close all pipelines initiated by this session when the loop is exited.
+          
       """
+      if "close_pipelines" in kwargs:
+        close_pipeline_on_timeout = kwargs.get("close_pipelines")
+      if "close_session" in kwargs:
+        close_session_on_timeout = kwargs.get("close_session")
       self.run(
         wait=seconds, 
         close_session=close_session_on_timeout, 
-        close_pipelines=close_pipeline_on_timeout
+        close_pipelines=close_pipeline_on_timeout,
       )
       return    
 
@@ -2388,13 +2431,13 @@ class GenericSession(BaseDecentrAIObject):
       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."
+          message = f"Warning! No Telegram bot token provided as via env '{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)
+        telegram_bot_name = os.getenv(telegram_bot_name_env_key, name)
         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."
+          message = f"Warning! No Telegram bot name provided as via env '{telegram_bot_name_env_key}' or explicitly as `telegram_bot_name` param."
           raise ValueError(message)
       
 

naeural_client/bc/base.py

@@ -1514,6 +1514,7 @@ class BaseBlockEngine:
     debug=False, 
     max_tries=5,
     network=None,
+    return_full_data=False,
     **kwargs
   ):
     """
@@ -1662,4 +1663,6 @@ class BaseBlockEngine:
       # Invalid URL, thus dct_env will remain None
       self.P(f"dAuth URL is not invalid: {url}", color='r')
     #end if url is valid
+    if return_full_data:
+      return dct_response
     return dct_env

naeural_client/const/environment.py

@@ -29,7 +29,7 @@ class ENVIRONMENT:
   EE_SECURED = 'EE_SECURED'
   AIXP_SECURED = 'AIXP_SECURED'
   
-  TELEGRAM_BOT_TOKEN_ENV_KEY = 'TELEGRAM_BOT_TOKEN'
-  TELEGRAM_BOT_NAME_ENV_KEY = 'TELEGRAM_BOT_NAME'
+  TELEGRAM_BOT_TOKEN_ENV_KEY = 'EE_TELEGRAM_BOT_TOKEN'
+  TELEGRAM_BOT_NAME_ENV_KEY = 'EE_TELEGRAM_BOT_NAME'
   
-  TELEGRAM_API_AGENT_TOKEN_ENV_KEY = 'TELEGRAM_API_AGENT_TOKEN'
+  TELEGRAM_API_AGENT_TOKEN_ENV_KEY = 'EE_TELEGRAM_API_AGENT_TOKEN'

{naeural_client-2.7.5.dist-info → naeural_client-2.7.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: naeural_client
-Version: 2.7.5
+Version: 2.7.7
 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/NaeuralEdgeProtocol/naeural_client
 Project-URL: Bug Tracker, https://github.com/NaeuralEdgeProtocol/naeural_client/issues

{naeural_client-2.7.5.dist-info → naeural_client-2.7.7.dist-info}/RECORD

@@ -1,10 +1,10 @@
 naeural_client/__init__.py,sha256=YimqgDbjLuywsf8zCWE0EaUXH4MBUrqLxt0TDV558hQ,632
-naeural_client/_ver.py,sha256=fzU2D33TdF4AMAfvqYcWnQR2ihxWc-UHM259WZKYV5M,330
+naeural_client/_ver.py,sha256=OLKx8hnD71ZUP5b74nYB4l0k_HtixADmnEBuBvOqDu0,330
 naeural_client/base_decentra_object.py,sha256=C4iwZTkhKNBS4VHlJs5DfElRYLo4Q9l1V1DNVSk1fyQ,4412
 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=3Z7BGi1g5zIXDAUk-PCKsXVhQKaJldL9id2SDedbSIU,105872
+naeural_client/base/generic_session.py,sha256=ZcfiPGYvp4hh_SU9W3Bp6N2ClwWvsB6jNB4amvwF8QI,108236
 naeural_client/base/instance.py,sha256=kcZJmjLBtx8Bjj_ysIOx1JmLA-qSpG7E28j5rq6IYus,20444
 naeural_client/base/pipeline.py,sha256=EvESG5UH5GwyAZbJWJk1irTzGYBuOUjl-8KjkCdgLVI,58574
 naeural_client/base/plugin_template.py,sha256=7YAFaND2iXoZLgtunjYkFf_TBGieFr3VdNLO3vCqzmM,138795
@@ -14,7 +14,7 @@ naeural_client/base/webapp_pipeline.py,sha256=ZNGqZ36DY076XVDfGu2Q61kCt3kxIJ4Mi4
 naeural_client/base/payload/__init__.py,sha256=y8fBI8tG2ObNfaXFWjyWZXwu878FRYj_I8GIbHT4GKE,29
 naeural_client/base/payload/payload.py,sha256=x-au7l67Z_vfn_4R2C_pjZCaFuUVXHngJiGOfIAYVdE,2690
 naeural_client/bc/__init__.py,sha256=FQj23D1PrY06NUOARiKQi4cdj0-VxnoYgYDEht8lpr8,158
-naeural_client/bc/base.py,sha256=sTdJs_qcg7SlanxizZ2IfPilUR_z7hsBhcFO1fl-Jw0,46457
+naeural_client/bc/base.py,sha256=afXeOiPjA6_md3MGfuXwYIFTh7vErjU7vYK-rpQ_WRw,46536
 naeural_client/bc/chain.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 naeural_client/bc/ec.py,sha256=-HPfKpYAqy_eZpiJf3gWR2L4ZDDP7fZY2uwdNYYmS80,23868
 naeural_client/certs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -36,7 +36,7 @@ naeural_client/const/__init__.py,sha256=MM6Zib6i7M2qWcMkLtLx14zqU-lE-u2uPHjNvbh2
 naeural_client/const/apps.py,sha256=ePBiJXLuPfFOKuw-LJrT9OWbaodU7QApfDurIPNDoB4,655
 naeural_client/const/base.py,sha256=g3II1Ys-1sjr1OG-sDJyRCV3F48VnxKQc7zTBPn-7FE,6510
 naeural_client/const/comms.py,sha256=La6JXWHexH8CfcBCKyT4fCIoeaoZlcm7KtZ57ab4ZgU,2201
-naeural_client/const/environment.py,sha256=iytmTDgbOjvORPwHQmc0K0r-xJx7dnnzNnqAJJiFCDA,870
+naeural_client/const/environment.py,sha256=RpdDhDgB8NgRoFTk28eODigf9y0WcT9lul6mBOD029w,879
 naeural_client/const/formatter.py,sha256=AW3bWlqf39uaqV4BBUuW95qKYfF2OkkU4f9hy3kSVhM,200
 naeural_client/const/heartbeat.py,sha256=xHZBX_NzHTklwA2_AEKR0SGdlbavMT4nirqjQg8WlTU,2550
 naeural_client/const/misc.py,sha256=VDCwwpf5bl9ltx9rzT2WPVP8B3mZFRufU1tSS5MO240,413
@@ -84,8 +84,8 @@ naeural_client/utils/comm_utils.py,sha256=4cS9llRr_pK_3rNgDcRMCQwYPO0kcNU7AdWy_L
 naeural_client/utils/config.py,sha256=QDrVywnhmf1k-sAb5jIBHZ_80TjNZk02uRG-t8mYLKQ,7413
 naeural_client/utils/dotenv.py,sha256=_AgSo35n7EnQv5yDyu7C7i0kHragLJoCGydHjvOkrYY,2008
 naeural_client/utils/oracle_sync/oracle_tester.py,sha256=GmZwu2JM9_UB2K-4rKB3o0RgWLqM-7Im6HwBnQLXmHI,25312
-naeural_client-2.7.5.dist-info/METADATA,sha256=_jpKW1DCVrbH8SG_EBGU0h-P_IJJt_sQlxR-swuuRwc,12353
-naeural_client-2.7.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-naeural_client-2.7.5.dist-info/entry_points.txt,sha256=CTua17GUrRa4aXeafezGC9TiWKGKQzwTjQmB2jyj22g,91
-naeural_client-2.7.5.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
-naeural_client-2.7.5.dist-info/RECORD,,
+naeural_client-2.7.7.dist-info/METADATA,sha256=sROG0Xv0ef9ZdLou3W3d4FBhy8sYOiNyknRjy6gL8oU,12353
+naeural_client-2.7.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+naeural_client-2.7.7.dist-info/entry_points.txt,sha256=CTua17GUrRa4aXeafezGC9TiWKGKQzwTjQmB2jyj22g,91
+naeural_client-2.7.7.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
+naeural_client-2.7.7.dist-info/RECORD,,