naeural-client 2.1.0__tar.gz → 2.1.1__tar.gz

{naeural_client-2.1.0 → naeural_client-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: naeural_client
-Version: 2.1.0
+Version: 2.1.1
 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 → naeural_client-2.1.1}/naeural_client/_ver.py

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

{naeural_client-2.1.0 → naeural_client-2.1.1}/naeural_client/base/generic_session.py

@@ -1724,25 +1724,32 @@ class GenericSession(BaseDecentrAIObject):
       **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)
       
-      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 2 arguments: `instance` and `data`.")
+      
       instance = pipeline.create_plugin_instance(
         signature=signature,
         instance_id=self.log.get_unique_id(),
         telegram_bot_token=telegram_bot_token,
-        message_handler=b64code,
+        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 +1859,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-2.1.0 → naeural_client-2.1.1}/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-2.1.0 → naeural_client-2.1.1}/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-2.1.0 → naeural_client-2.1.1}/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,37 @@ 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()))
+    if args[0] 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, x):
     """
     A simple function that adds 1 to the input.
 
@@ -539,9 +574,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-2.1.0 → naeural_client-2.1.1}/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-2.1.0 → naeural_client-2.1.1}/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 → naeural_client-2.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "naeural_client"
-version = "2.1.0"
+version = "2.1.1"
 authors = [
   { name="Stefan Saraev", email="saraevstefan@gmail.com" },
   { name="Andrei Ionut Damian", email="andrei.damian@me.com" },

{naeural_client-2.1.0 → naeural_client-2.1.1}/tutorials/ex01_part1_connect.py

@@ -3,6 +3,18 @@ This is a simple example of how to use the naeural_client SDK.
 
 In this example, we connect to the network, listen for heartbeats from 
   Naeural Edge Protocol edge nodes and print the CPU of each node.
+  
+  
+  
+New connection algorithm:
+
+1. The client connects to the network.
+2. The client waits for the first 2 supervisors payload with network map. 
+3. The client reads `partner_peers` - all nodes that recognize the client as allowed - based on supervisor(s) network map.
+4. The client sends a pipeline status to all `partner_peers`.
+5. The client then knows the `partner_peers` and can send messages to them.
+IMPORTANT: Session will WAIT until network map is clarified.
+
 """
 import json
 
@@ -50,6 +62,7 @@ if __name__ == '__main__':
       on_heartbeat=filterer.on_heartbeat,
   )
 
+  session.P("Client address is: {}".format(session.get_client_address()), color='g')
 
   # Observation:
   #   next code is not mandatory - it is used to keep the session open and cleanup the resources

{naeural_client-2.1.0 → naeural_client-2.1.1}/tutorials/ex10_telegram_echo_bot.py

@@ -6,6 +6,8 @@ from naeural_client import Session, CustomPluginTemplate, PLUGIN_TYPES
 def reply(plugin: CustomPluginTemplate, message: str, user: str):
   """
   This function is used to reply to a message.
+  
+  The given parameters are mandatory
   """
   # for each user message we increase a counter
   plugin.int_cache[user] += 1 # int_cache is a default dict that allows persistence in the plugin
@@ -13,8 +15,9 @@ def reply(plugin: CustomPluginTemplate, message: str, user: str):
   result = f"The answer to your {plugin.int_cache[user]} question is in the question itself: {message}"
   return result
 
+
 if __name__ == "__main__":
-  TELEGRAM_BOT_TOKEN_ENV_KEY = "TELEGRAM_BOT_TOKEN"
+  # TELEGRAM_BOT_TOKEN_ENV_KEY = "TELEGRAM_BOT_TOKEN"  # this is the default - we can specify a env key here
   MY_NODE = None # we can specify a node here, if we want to connect to a specific
     
   session = Session() # assume .env is available and will be used for the connection and tokens
@@ -28,11 +31,12 @@ if __name__ == "__main__":
       
   # now we create a telegram bot pipeline & plugin instance
   # we can chose to use the token directly or use the environment key
-  instance: PLUGIN_TYPES.BASIC_TELEGRAM_BOT_01
-  pipeline, instance = session.create_telegram_simple_bot(
+  # instance: PLUGIN_TYPES.BASIC_TELEGRAM_BOT_01
+  pipeline, _ = session.create_telegram_simple_bot(
     node=node,
     name="telegram_bot_echo",
-    telegram_bot_token_env_key=TELEGRAM_BOT_TOKEN_ENV_KEY,
+    # telegram_bot_token=os.getenv("TELEGRAM_BOT_TOKEN"),  # we use the token directly
+    # telegram_bot_token_env_key=TELEGRAM_BOT_TOKEN_ENV_KEY, # not mandatory - we can use the default
     reply_function=reply,
   )
   

naeural_client-2.1.1/tutorials/ex11_telegram_smart_bot.py

@@ -0,0 +1,44 @@
+import os
+
+from naeural_client import Session, CustomPluginTemplate, PLUGIN_TYPES
+
+if __name__ == "__main__":
+  # TELEGRAM_BOT_TOKEN_ENV_KEY = "TELEGRAM_BOT_TOKEN" # we can specify the token here
+  MY_NODE = None # we can specify a node here, if we want to connect to a specific
+  
+  SYSTEM_PROMPT = """
+  Hi! I am a simple echo bot. I will repeat everything you say to me.
+  """
+    
+  session = Session() # assume .env is available and will be used for the connection and tokens
+
+  if MY_NODE:
+    node = MY_NODE
+  else:
+    session.wait_for_any_node() # we wait for any node to present itself as active
+    node = session.get_active_nodes()[0] # we get the first active node
+  
+      
+  # now we create a telegram bot pipeline & plugin instance
+  # we can chose to use the token directly or use the environment key
+  # instance: PLUGIN_TYPES.BASIC_TELEGRAM_BOT_01
+  pipeline, _ = session.create_telegram_conversational_bot(
+    node=node,
+    name="telegram_bot_echo",
+    # telegram_bot_token_env_key=TELEGRAM_BOT_TOKEN_ENV_KEY, # this is not mandatory
+    system_prompt=SYSTEM_PROMPT, # simple bot based on system prompt only
+    # rag_source=rag_db_url,    # advanced 
+    # bot_type="API" # "API", "HOSTED"
+    # api_token_env_key="BOT_API_TOKEN", # if bot_type is "API" - this is a default
+  )
+  
+  pipeline.deploy() # we deploy the pipeline
+
+  # # Observation:
+  # #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  # #   in production, you would not need this code as the script can close after the pipeline will be sent  
+  # session.run(
+  #   wait=60,  # we run the session for 60 seconds
+  #   close_pipelines=True,  # we close the pipelines after the session
+  #   close_session=True,  # we close the session after the session
+  # )