naeural-client 2.5.11__py3-none-any.whl → 2.5.13__py3-none-any.whl

naeural_client/_ver.py

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

naeural_client/base/generic_session.py

@@ -1374,7 +1374,8 @@ class GenericSession(BaseDecentrAIObject):
 
     def get_allowed_nodes(self):
       """
-      Get the list of all active Naeural Edge Protocol edge nodes to whom this session can send messages
+      Get the list of all active Naeural Edge Protocol edge nodes to whom this 
+      ssion can send messages. This is based on the last heartbeat received from each individual node.
 
       Returns
       -------
@@ -2238,11 +2239,43 @@ class GenericSession(BaseDecentrAIObject):
       online_only=False, 
       supervisors_only=False,
       min_supervisors=2,
+      allowed_only=False,
       supervisor=None,
     ):
       """
       This function will return a Pandas dataframe  known nodes in the network based on
       all the net-mon messages received so far.
+      
+      Parameters
+      ----------
+      
+      timeout : int, optional
+          The maximum time to wait for the desired number of supervisors to appear online.
+          Defaults to 10.
+          
+      online_only : bool, optional  
+          If True, will return only the online nodes. Defaults to False.
+      
+      supervisors_only : bool, optional
+          If True, will return only the supervisors. Defaults to False.
+          
+      min_supervisors : int, optional 
+          The minimum number of supervisors to wait for. Defaults to 2.
+          
+      allowed_only : bool, optional 
+          If True, will return only the allowed nodes. Defaults to False.
+          
+      supervisor : str, optional  
+          The supervisor to wait for. Defaults to None.
+          
+      Returns
+      -------
+      
+      dict
+          A dictionary containing the report, the reporter and the number of supervisors.
+          
+
+      
       """
       mapping = OrderedDict({
         'Address': PAYLOAD_DATA.NETMON_ADDRESS,
@@ -2252,13 +2285,16 @@ class GenericSession(BaseDecentrAIObject):
         'Last probe' : PAYLOAD_DATA.NETMON_LAST_REMOTE_TIME,
         'Zone' : PAYLOAD_DATA.NETMON_NODE_UTC,
         'Supervisor' : PAYLOAD_DATA.NETMON_IS_SUPERVISOR,
+        'Peered' : PAYLOAD_DATA.NETMON_WHITELIST,
       })
       reverse_mapping = {v: k for k, v in mapping.items()}
       res = OrderedDict()
       for k in mapping:
         res[k] = []
+
+      # the following loop will wait for the desired number of supervisors to appear online
+      # for the current session
       start = tm()      
-  
       while (tm() - start) < timeout:
         if supervisor is not None:
           if supervisor in self.__current_network_statuses:
@@ -2266,7 +2302,10 @@ class GenericSession(BaseDecentrAIObject):
         elif len(self.__current_network_statuses) >= min_supervisors:
           break
         sleep(0.1)
+      elapsed = tm() - start
       # end while
+      # done waiting for supervisors
+      
       if len(self.__current_network_statuses) > 0:
         best_info = {}
         best_super = None
@@ -2274,10 +2313,17 @@ class GenericSession(BaseDecentrAIObject):
           if len(net_info) > len(best_info):
             best_info = net_info
             best_super = supervisor
+        best_super_alias = None
         # done found best supervisor
         for _, node_info in best_info.items():
           is_online = node_info.get(PAYLOAD_DATA.NETMON_STATUS_KEY, None) == PAYLOAD_DATA.NETMON_STATUS_ONLINE
           is_supervisor = node_info.get(PAYLOAD_DATA.NETMON_IS_SUPERVISOR, False)
+          # the following will get the whitelist for the current inspected  node
+          # without calling self.get_allowed_nodes but instead using the netmon data
+          whitelist = node_info.get(PAYLOAD_DATA.NETMON_WHITELIST, [])
+          client_is_allowed = self.bc_engine.contains_current_address(whitelist)          
+          if allowed_only and not client_is_allowed:
+            continue
           if online_only and not is_online:
             continue
           if supervisors_only and not is_supervisor:
@@ -2292,9 +2338,21 @@ class GenericSession(BaseDecentrAIObject):
               # convert val (seconds) to a human readable format
               val = seconds_to_short_format(val)
             elif key == PAYLOAD_DATA.NETMON_ADDRESS:
+              if self.bc_engine._remove_prefix(val) == self.bc_engine._remove_prefix(best_super):
+                # again self.get_node_name(best_super) might not work if using the hb data
+                best_super_alias = node_info.get(PAYLOAD_DATA.NETMON_EEID, None)
               val = self.bc_engine._add_prefix(val)
+            elif key == PAYLOAD_DATA.NETMON_WHITELIST:
+              val = client_is_allowed
             res[column].append(val)          
         # end for
       # end if
       pd.options.display.float_format = '{:.1f}'.format
-      return pd.DataFrame(res), best_super
+      dct_result ={
+        'report' : pd.DataFrame(res),
+        'reporter' : best_super,
+        'reporter_alias' : best_super_alias,
+        'nr_super' : len(self.__current_network_statuses),
+        'elapsed' : elapsed,
+      }
+      return dct_result

naeural_client/bc/base.py

@@ -847,10 +847,30 @@ class BaseBlockEngine:
   ####                                                                     ####
   #############################################################################
   
+  
+  def contains_current_address(self, lst_addresses):
+    """
+    Checks if the current address is in the list of addresses
+
+    Parameters
+    ----------
+    lst_addresses : list
+      the list of addresses.
+
+    Returns
+    -------
+    bool
+      True if the current address is in the list.
+
+    """
+    lst = [self._remove_prefix(x) for x in lst_addresses]
+    return self.address_no_prefix in lst
+  
   @property
   def address(self):
     """Returns the public address"""
     return self.__address
+    
   
   @property
   def address_no_prefix(self):

naeural_client/cli/cli.py

@@ -52,7 +52,7 @@ def build_parser():
         if isinstance(subcmd_info, dict) and "params" in subcmd_info:
           for param, description in subcmd_info["params"].items():
             if param.startswith("--"):
-              if description.upper().endswith("FLAG"):
+              if description.lower().endswith("(flag)"):
                 subcommand_parser.add_argument(
                   param, action="store_true", help=description
                 )

naeural_client/cli/cli_commands.py

@@ -11,10 +11,12 @@ CLI_COMMANDS = {
         "nodes": {
             "func": get_nodes,
             "params": {
-                "--all": "Get all known nodes flag",  # DONE
-                "--online" : "Get only online nodes flag", # DONE
-                # "--peered": "Get only peered nodes"
-                "--supervisor" : "Use a specific supervisor node"
+              ### use "(flag)" at the end of the description to indicate a boolean flag 
+              ### otherwise it will be treated as a str parameter
+              "--all": "Get all known nodes including those that have been gone missing (flag)",  # DONE
+              "--online" : "Get only online nodes as seen by a active supervisor (flag)", # DONE
+              "--peered": "Get only peered nodes - ie nodes that can be used by current client address (flag)",  # DONE
+              "--supervisor" : "Use a specific supervisor node"
             }
         },
         "supervisors": {

naeural_client/cli/nodes.py

@@ -15,22 +15,20 @@ def get_nodes(args):
     log_with_color(f"Getting nodes from supervisor <{supervisor_addr}>...", color='b')
   from naeural_client import Session
   sess = Session(silent=not args.verbose)
-  if args.all:
-    df, supervisor = sess.get_network_known_nodes(supervisor=supervisor_addr)
-    log_with_color(f"Network full map reported by <{supervisor}>:", color='b')
-    log_with_color(f"{df}")    
-  elif args.online:
-    df, supervisor = sess.get_network_known_nodes(
-      online_only=True, supervisor=supervisor_addr
-    )
-    log_with_color(f"Online nodes reported by <{supervisor}>:", color='b')
-    log_with_color(f"{df}")    
-  else:
-    df, supervisor = sess.get_network_known_nodes(
-      online_only=True, supervisor=supervisor_addr
-    )
-    log_with_color(f"Online nodes reported by <{supervisor}>:", color='b')
-    log_with_color(f"{df}")    
+  online_only = args.online or args.peered
+  allowed_only = args.peered
+  
+  dct_info = sess.get_network_known_nodes(
+    online_only=online_only, allowed_only=allowed_only, supervisor=supervisor_addr
+  )
+  df = dct_info['report']
+  supervisor = dct_info['reporter']
+  super_alias = dct_info['reporter_alias']
+  nr_supers = dct_info['nr_super']
+  elapsed = dct_info['elapsed']
+  prefix = "Online n" if online_only else "N"
+  log_with_color(f"{prefix}odes reported by <{supervisor}> '{super_alias}' in {elapsed:.1f}s ({nr_supers} supervisors seen):", color='b')
+  log_with_color(f"{df}")    
   return
   
   
@@ -42,8 +40,12 @@ def get_supervisors(args):
     log_with_color("Getting supervisors...", color='b')
   from naeural_client import Session  
   sess = Session(silent=not args.verbose)
-  df, supervisor = sess.get_network_known_nodes(online_only=True, supervisors_only=True)
-  log_with_color(f"Supervisors reported by <{supervisor}>", color='b')
+  dct_info = sess.get_network_known_nodes(online_only=True, supervisors_only=True)
+  df = dct_info['report']
+  supervisor = dct_info['reporter']
+  super_alias = dct_info['reporter_alias']
+  elapsed = dct_info['elapsed']  
+  log_with_color(f"Supervisors reported by <{supervisor}> '{super_alias}' in {elapsed:.1f}s", color='b')
   log_with_color(f"{df}")
   return
 

naeural_client/const/payload.py

@@ -204,6 +204,7 @@ class PAYLOAD_DATA:
   NETMON_NODE_UTC = 'node_utc'
   NETMON_LAST_SEEN = 'last_seen_sec'
   NETMON_IS_SUPERVISOR = 'is_supervisor'
+  NETMON_WHITELIST = 'whitelist'
   
   
 class NET_CONFIG:

{naeural_client-2.5.11.dist-info → naeural_client-2.5.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: naeural_client
-Version: 2.5.11
+Version: 2.5.13
 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.5.11.dist-info → naeural_client-2.5.13.dist-info}/RECORD

@@ -1,10 +1,10 @@
 naeural_client/__init__.py,sha256=GP8WSrn87sjTPO-QRNL2PG8JK5Mixbiea_HrtbG8RAQ,592
-naeural_client/_ver.py,sha256=IdfZWUnwl4zBYBAU3-uWWoRHoL8PekhfbG6gV1dQpa8,331
+naeural_client/_ver.py,sha256=X8jG_pnMmkhenukxV6xSzGjehYk7LMlNwojkR7RFc5E,331
 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=wIUhOTRzG6X-3N5xC7qk6yYFvHlVLqD0VJUppB3Zeos,85786
+naeural_client/base/generic_session.py,sha256=6dc7oiKSw0Tc1pOh1WiE4XI8qX-hch-EKLozqsBiJ7o,88092
 naeural_client/base/instance.py,sha256=kcZJmjLBtx8Bjj_ysIOx1JmLA-qSpG7E28j5rq6IYus,20444
 naeural_client/base/pipeline.py,sha256=b4uNHrEIOlAtw4PGUx20dxwBhDck5__SrVXaHcSi8ZA,58251
 naeural_client/base/plugin_template.py,sha256=qGaXByd_JZFpjvH9GXNbT7KaitRxIJB6-1IhbKrZjq4,138123
@@ -14,15 +14,15 @@ naeural_client/base/webapp_pipeline.py,sha256=QmPLVmhP0CPdi0YuvbZEH4APYz2Amtw3gy
 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=ZXJkP0ainztIf0ehUOBUrqOr6msrfCyF8MvAklTxoDo,31773
+naeural_client/bc/base.py,sha256=Uzpv0_YAM-lVV0mRJkt2cCy3z107BI50R-xWf-i32hw,32184
 naeural_client/bc/chain.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 naeural_client/bc/ec.py,sha256=mWjodWCRgC3omVXOA9jtNdtPVNn2kMKV3Dcjt9oFUCQ,22974
 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/cli/README.md,sha256=WPdI_EjzAbUW1aPyj1sSR8rLydcJKZtoiaEtklQrjHo,74
-naeural_client/cli/cli.py,sha256=GyQhw16LrCbXU0JLH0HlbyYvKqa15K5RIhQ-Pgi7Gy4,3752
-naeural_client/cli/cli_commands.py,sha256=BtByinaxFvThyQdeu8Moz2aMioR5MW5GTiI1bGjbfwQ,1392
-naeural_client/cli/nodes.py,sha256=Q26sJpDCOd0oqpNonqEoCc1EcLVnf2CaGFzrG1wyzhA,2363
+naeural_client/cli/cli.py,sha256=Yni8USLNK9g9G-l8_XomppZ5tKhduvA8wS4xOw3KODc,3754
+naeural_client/cli/cli_commands.py,sha256=Y81oKz5Rx8qxYgzEzCwI9eB8iVL6iET7dETLVygs_VE,1686
+naeural_client/cli/nodes.py,sha256=aCbSDFhTnub18LdrOPzu3kvx6acaBqHRgmyAdgqblP8,2459
 naeural_client/code_cheker/__init__.py,sha256=pwkdeZGVL16ZA4Qf2mRahEhoOvKhL7FyuQbMFLr1E5M,33
 naeural_client/code_cheker/base.py,sha256=lT5DRIFO5rqzsMNCmdMRfkAeevmezozehyfgmhnKpuI,19074
 naeural_client/code_cheker/checker.py,sha256=QWupeM7ToancVIq1tRUxRNUrI8B5l5eoY0kDU4-O5aE,7365
@@ -38,7 +38,7 @@ naeural_client/const/environment.py,sha256=iytmTDgbOjvORPwHQmc0K0r-xJx7dnnzNnqAJ
 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=Y6x00YDtY1_nAk4OvikCLlfp8ggn11WQYTBGYzFlJPk,211
-naeural_client/const/payload.py,sha256=fHhhdSv1o_5Ldy72jO7m3YZtMmJOpOHaVhfjbNCuuzo,6446
+naeural_client/const/payload.py,sha256=vHKxSrPXnfBTBwD_xp9Aw7nue0_gxz4r01YjXRYiTIM,6479
 naeural_client/default/__init__.py,sha256=ozU6CMMuWl0LhG8Ae3LrZ65a6tLrptfscVYGf83zjxM,46
 naeural_client/default/instance/__init__.py,sha256=w1de6OMj9a5GPGF-Wl1b_I_YAy9fWBEss2QnyPPyaB0,546
 naeural_client/default/instance/chain_dist_custom_job_01_plugin.py,sha256=QtHi3uXKsVs9eyMgbnvBVbMylErhV1Du4X2-7zDL7Y0,1915
@@ -81,8 +81,8 @@ naeural_client/utils/__init__.py,sha256=mAnke3-MeRzz3nhQvhuHqLnpaaCSmDxicd7Ck9uw
 naeural_client/utils/comm_utils.py,sha256=4cS9llRr_pK_3rNgDcRMCQwYPO0kcNU7AdWy_LtMyCY,1072
 naeural_client/utils/config.py,sha256=aUVyi5rZjvnbUwM5mmj0E2IHvURdrlHSgleqZvJBNuU,5202
 naeural_client/utils/dotenv.py,sha256=_AgSo35n7EnQv5yDyu7C7i0kHragLJoCGydHjvOkrYY,2008
-naeural_client-2.5.11.dist-info/METADATA,sha256=-YWNOTUZO2cZEAaxd-PRBtX34Dh6yZit85NSuSSuaSM,14494
-naeural_client-2.5.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-naeural_client-2.5.11.dist-info/entry_points.txt,sha256=PNdyotDaQBAslZREx5luVyj0kqpQnwNACwkFNTPIHU4,55
-naeural_client-2.5.11.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
-naeural_client-2.5.11.dist-info/RECORD,,
+naeural_client-2.5.13.dist-info/METADATA,sha256=IrxAiqktgV62i7ztjMjrtXIzugDvd5difPNzdq-YkgI,14494
+naeural_client-2.5.13.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+naeural_client-2.5.13.dist-info/entry_points.txt,sha256=PNdyotDaQBAslZREx5luVyj0kqpQnwNACwkFNTPIHU4,55
+naeural_client-2.5.13.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
+naeural_client-2.5.13.dist-info/RECORD,,