cdp-client 2.2.0__tar.gz → 2.3.0__tar.gz

{cdp_client-2.2.0 → cdp_client-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cdp-client
-Version: 2.2.0
+Version: 2.3.0
 Summary: Provides an API that allows to interact with CDP applications
 Home-page: https://github.com/CDPTechnologies/PythonCDPClient
 Author: CDP Technologies AS
@@ -13,28 +13,36 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development
-Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
 License-File: LICENSE.txt
 Requires-Dist: promise
 Requires-Dist: websocket-client
 Requires-Dist: protobuf
 Requires-Dist: mock
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 CDP-Client
 ==========
 
 A simple python interface for the CDP Studio development platform that allows Python scripts to interact with CDP Applications - retrieve CDP Application structures and read-write object values. For more information about CDP Studio see https://cdpstudio.com/
 
-The API makes heavy use of promise library for asynchronous operations. For more information see https://pypi.python.org/pypi/promise
+The API makes heavy use of promise library for asynchronous operations. For more information see https://pypi.org/project/promise/
 
 Installation
 ------------
@@ -62,6 +70,26 @@ The example below shows how you subscribe to CDP signal value changes.
     client.find_node('AppName.ComponentName.SignalName').then(subscribe_to_value_changes)
     client.run_event_loop()
 
+The example below shows how you subscribe to CDP events.
+
+.. code:: python
+
+    from cdp_client import cdp
+
+    def on_event_received(event_info):
+        print(f"Event {event_info.id} from {event_info.sender}")
+        print(f"Code: {event_info.code}, Timestamp: {event_info.timestamp}")
+        if event_info.data:
+            for data_item in event_info.data:
+                print(f"  {data_item.name}: {data_item.value}")
+	
+    def subscribe_to_events(node):
+        node.subscribe_to_events(on_event_received)
+	
+    client = cdp.Client(host='127.0.0.1')
+    client.root_node().then(subscribe_to_events)
+    client.run_event_loop()
+
 API
 ---
 
@@ -143,7 +171,7 @@ Client(host, port, auto_reconnect, notification_listener, encryption_parameters)
                             encryption_parameters={'use_encryption': True,
                                                    'cert_reqs': ssl.CERT_REQUIRED,
                                                    'ca_certs': 'StudioAPI.crt',
-                                                   'check_hostname': False},
+                                                   'check_hostname': False})
 
 Instance Methods / Client
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -391,6 +419,48 @@ Stops listening previously subscribed value changes
 	
         node.unsubscribe_from_value_changes(on_change)
 
+node.subscribe_to_events(callback, starting_from=None)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Starts listening to events from this node and its children, passing event information to the provided callback function
+
+- Arguments
+
+    callback - Function(event_info) where event_info contains id, sender, code, timestamp, and optional data fields
+
+    starting_from - Optional timestamp to start receiving events from (in nanoseconds since Epoch). Defaults to None for current events.
+
+- Usage
+
+    .. code:: python
+
+        def on_event(event_info):
+            print(f"Event {event_info.id} from {event_info.sender}")
+            print(f"Code: {event_info.code}, Timestamp: {event_info.timestamp}")
+            if event_info.data:
+                for data_item in event_info.data:
+                    print(f"  {data_item.name}: {data_item.value}")
+
+        node.subscribe_to_events(on_event)
+
+node.unsubscribe_from_events(callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Stops listening to previously subscribed events
+
+- Arguments
+
+    callback - Function(event_info) that was previously subscribed
+
+- Usage
+
+    .. code:: python
+
+        def on_event(event_info):
+            print(f"Event received: {event_info.id}")
+
+        node.unsubscribe_from_events(on_event)
+
 Notification Listener
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -463,7 +533,7 @@ To run the test suite execute the following command in package root folder:
 
 .. code:: sh
 
-    $ python setup.py test
+    $ python -m unittest discover cdp_client.tests -v
 
 License
 -------

cdp_client-2.2.0/cdp_client.egg-info/PKG-INFO → cdp_client-2.3.0/README.rst

@@ -1,40 +1,9 @@
-Metadata-Version: 2.1
-Name: cdp-client
-Version: 2.2.0
-Summary: Provides an API that allows to interact with CDP applications
-Home-page: https://github.com/CDPTechnologies/PythonCDPClient
-Author: CDP Technologies AS
-Author-email: info@cdptech.com
-License: MIT
-Keywords: cdp cdpstudio studio client cdp-client cdp_client
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Software Development
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-License-File: LICENSE.txt
-Requires-Dist: promise
-Requires-Dist: websocket-client
-Requires-Dist: protobuf
-Requires-Dist: mock
-
 CDP-Client
 ==========
 
 A simple python interface for the CDP Studio development platform that allows Python scripts to interact with CDP Applications - retrieve CDP Application structures and read-write object values. For more information about CDP Studio see https://cdpstudio.com/
 
-The API makes heavy use of promise library for asynchronous operations. For more information see https://pypi.python.org/pypi/promise
+The API makes heavy use of promise library for asynchronous operations. For more information see https://pypi.org/project/promise/
 
 Installation
 ------------
@@ -62,6 +31,26 @@ The example below shows how you subscribe to CDP signal value changes.
     client.find_node('AppName.ComponentName.SignalName').then(subscribe_to_value_changes)
     client.run_event_loop()
 
+The example below shows how you subscribe to CDP events.
+
+.. code:: python
+
+    from cdp_client import cdp
+
+    def on_event_received(event_info):
+        print(f"Event {event_info.id} from {event_info.sender}")
+        print(f"Code: {event_info.code}, Timestamp: {event_info.timestamp}")
+        if event_info.data:
+            for data_item in event_info.data:
+                print(f"  {data_item.name}: {data_item.value}")
+	
+    def subscribe_to_events(node):
+        node.subscribe_to_events(on_event_received)
+	
+    client = cdp.Client(host='127.0.0.1')
+    client.root_node().then(subscribe_to_events)
+    client.run_event_loop()
+
 API
 ---
 
@@ -143,7 +132,7 @@ Client(host, port, auto_reconnect, notification_listener, encryption_parameters)
                             encryption_parameters={'use_encryption': True,
                                                    'cert_reqs': ssl.CERT_REQUIRED,
                                                    'ca_certs': 'StudioAPI.crt',
-                                                   'check_hostname': False},
+                                                   'check_hostname': False})
 
 Instance Methods / Client
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -391,6 +380,48 @@ Stops listening previously subscribed value changes
 	
         node.unsubscribe_from_value_changes(on_change)
 
+node.subscribe_to_events(callback, starting_from=None)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Starts listening to events from this node and its children, passing event information to the provided callback function
+
+- Arguments
+
+    callback - Function(event_info) where event_info contains id, sender, code, timestamp, and optional data fields
+
+    starting_from - Optional timestamp to start receiving events from (in nanoseconds since Epoch). Defaults to None for current events.
+
+- Usage
+
+    .. code:: python
+
+        def on_event(event_info):
+            print(f"Event {event_info.id} from {event_info.sender}")
+            print(f"Code: {event_info.code}, Timestamp: {event_info.timestamp}")
+            if event_info.data:
+                for data_item in event_info.data:
+                    print(f"  {data_item.name}: {data_item.value}")
+
+        node.subscribe_to_events(on_event)
+
+node.unsubscribe_from_events(callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Stops listening to previously subscribed events
+
+- Arguments
+
+    callback - Function(event_info) that was previously subscribed
+
+- Usage
+
+    .. code:: python
+
+        def on_event(event_info):
+            print(f"Event received: {event_info.id}")
+
+        node.unsubscribe_from_events(on_event)
+
 Notification Listener
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -463,7 +494,7 @@ To run the test suite execute the following command in package root folder:
 
 .. code:: sh
 
-    $ python setup.py test
+    $ python -m unittest discover cdp_client.tests -v
 
 License
 -------

{cdp_client-2.2.0 → cdp_client-2.3.0}/cdp_client/cdp.py

@@ -161,6 +161,7 @@ class Node:
         self._children = []
         self._structure_subscriptions = []
         self._value_subscriptions = []
+        self._event_subscriptions = []
         self._value = proto.VariantValue()
         self._parent = parent
         for child in self._structure.node:
@@ -235,6 +236,27 @@ class Node:
         else:
             self._connection.send_value_unrequest(self._id())
 
+    def subscribe_to_events(self, callback, starting_from=None):
+        """Starts listening to events from this node and its children.
+
+        Args:
+            callback: Function(event_info) to call when events are received
+            starting_from: Optional timestamp to start receiving events from (nanoseconds since Epoch)
+        """
+        self._event_subscriptions.append(callback)
+        self._connection.send_event_request(self._id(), starting_from)
+
+    def unsubscribe_from_events(self, callback):
+        """Stops listening to previously subscribed events.
+
+        Args:
+            callback: Function(event_info) that was previously subscribed
+        """
+        if callback in self._event_subscriptions:
+            self._event_subscriptions.remove(callback)
+            if not self._event_subscriptions:
+                self._connection.send_event_unrequest(self._id())
+
     def _id(self):
         return self._structure.info.node_id
 
@@ -308,6 +330,10 @@ class Node:
         for callback, fs, sample_rate in self._value_subscriptions:
             callback(self._value, variant.timestamp + self._connection.server_time_difference() * nanoseconds_in_second)
 
+    def _update_event(self, event_info):
+        for callback in self._event_subscriptions:
+            callback(event_info)
+
     @staticmethod
     def _translate_type(node_type):
         if node_type == proto.CDP_SYSTEM:
@@ -446,6 +472,14 @@ class Connection:
         self._update_time_difference()
         self._compose_and_send_value(variant)
 
+    def send_event_request(self, node_id, starting_from=None):
+        self._update_time_difference()
+        self._compose_and_send_event_request(node_id, starting_from)
+
+    def send_event_unrequest(self, node_id):
+        self._update_time_difference()
+        self._compose_and_send_event_request(node_id, None, True)
+
     def run_event_loop(self):
         self._ws.run_forever(sslopt=self._encryption_parameters)
         while self._auto_reconnect:
@@ -468,16 +502,16 @@ class Connection:
                                       on_close=self._on_close,
                                       on_open=self._on_open)
 
-    def _on_error(self, error):
+    def _on_error(self, ws, error):
         if not self._auto_reconnect:
             self._cleanup_queued_requests(ConnectionError(error))
 
-    def _on_close(self):
+    def _on_close(self, ws, close_status_code=None, close_msg=None):
         self._is_connected = False
         if not self._auto_reconnect:
             self._cleanup_queued_requests(ConnectionError("Connection was closed"))
 
-    def _on_open(self):
+    def _on_open(self, ws):
         pass
 
     def _fetch_time_difference(self):
@@ -545,7 +579,10 @@ class Connection:
         self._ws.on_message = self._handle_container_message
         self._update_time_difference().then(self._node_tree.update()).then(self._send_queued_requests())
 
-    def _handle_auth_response(self, message):
+    def _handle_auth_response(self, ws=None, message=None):
+        if message is None:
+            message = ws
+            ws = None
         data = proto.AuthResponse()
         data.ParseFromString(message)
         if data.result_code in (data.eGranted, data.eGrantedPasswordWillExpireSoon):
@@ -569,7 +606,10 @@ class Connection:
         self._credentials = credentials
         self._compose_and_send_re_auth_request()
 
-    def _handle_hello_message(self, message):
+    def _handle_hello_message(self, ws=None, message=None):
+        if message is None:
+            message = ws
+            ws = None
         if self._parse_hello_message(message):
             request = AuthRequest(host=self._host, port=self._port, system_name=self._system_name,
                                   application_name=self._application_name, cdp_version=self._cdp_version,
@@ -600,7 +640,10 @@ class Connection:
             self._re_auth_request.then(self._re_authenticate)
             self._notification_listener.credentials_requested(self._re_auth_request)
 
-    def _handle_container_message(self, message):
+    def _handle_container_message(self, ws=None, message=None):
+        if message is None:
+            message = ws
+            ws = None
         data = proto.Container()
         data.ParseFromString(message)
         if data.message_type == proto.Container.eStructureResponse:
@@ -613,6 +656,8 @@ class Connection:
             self._parse_current_time_response(data.current_time_response)
         elif data.message_type == proto.Container.eReauthResponse:
             self._parse_re_auth_response(data.re_auth_response)
+        elif data.message_type == proto.Container.eEventResponse:
+            self._parse_event_response(data.event_response)
         elif data.message_type == proto.Container.eRemoteError:
             self._parse_error_response(data.error)
         else:
@@ -632,6 +677,13 @@ class Connection:
     def _parse_current_time_response(self, response):
         self._time_request.do_resolve(response)
 
+    def _parse_event_response(self, response):
+        for event_info in response:
+            for node_id in event_info.node_id:
+                node = self._node_tree.find_by_id(node_id)
+                if node is not None:
+                    node._update_event(event_info)
+
     def _parse_re_auth_response(self, response):
         if response.result_code not in (response.eGranted, response.eGrantedPasswordWillExpireSoon):
             self._re_auth_request = AuthRequest(host=self._host, port=self._port, system_name=self._system_name,
@@ -719,6 +771,18 @@ class Connection:
         data.message_type = proto.Container.eCurrentTimeRequest
         self._ws.send(data.SerializeToString())
 
+    def _compose_and_send_event_request(self, node_id, starting_from=None, stop=False):
+        data = proto.Container()
+        data.message_type = proto.Container.eEventRequest
+        event_request = proto.EventRequest()
+        event_request.node_id = node_id
+        if starting_from is not None:
+            event_request.starting_from = starting_from
+        if stop:
+            event_request.stop = stop
+        data.event_request.extend([event_request])
+        self._ws.send(data.SerializeToString())
+
     def _compose_auth_request(self, request):
         if not 'Username' in self._credentials:
             UnknownError("NotificationListener.credentials_requested() didn't return 'Username' entry")

cdp_client-2.3.0/cdp_client/cdp_pb2.py

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: cdp.proto
+# Protobuf Python Version: 6.30.2
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    6,
+    30,
+    2,
+    '',
+    'cdp.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\tcdp.proto\x12\x0fStudioAPI.Proto\"\xaf\x03\n\x05Hello\x12\x13\n\x0bsystem_name\x18\x01 \x02(\t\x12\x19\n\x0e\x63ompat_version\x18\x02 \x02(\r:\x01\x32\x12\x1e\n\x13incremental_version\x18\x03 \x02(\r:\x01\x30\x12\x12\n\npublic_key\x18\x04 \x03(\x0c\x12\x11\n\tchallenge\x18\x05 \x01(\x0c\x12\x18\n\x10\x61pplication_name\x18\x06 \x01(\t\x12\x19\n\x11\x63\x64p_version_major\x18\x07 \x01(\r\x12\x19\n\x11\x63\x64p_version_minor\x18\x08 \x01(\r\x12\x19\n\x11\x63\x64p_version_patch\x18\t \x01(\r\x12\x1b\n\x13idle_lockout_period\x18\n \x01(\r\x12\x1f\n\x17system_use_notification\x18\x0b \x01(\t\x12=\n\x0fsuggested_users\x18\x0c \x03(\x0b\x32$.StudioAPI.Proto.Hello.SuggestedUser\x1aG\n\rSuggestedUser\x12\x0f\n\x07user_id\x18\x01 \x01(\t\x12\x12\n\nfirst_name\x18\x02 \x01(\t\x12\x11\n\tlast_name\x18\x03 \x01(\t\"\x9f\x01\n\x0b\x41uthRequest\x12\x0f\n\x07user_id\x18\x01 \x01(\t\x12J\n\x12\x63hallenge_response\x18\x02 \x03(\x0b\x32..StudioAPI.Proto.AuthRequest.ChallengeResponse\x1a\x33\n\x11\x43hallengeResponse\x12\x0c\n\x04type\x18\x01 \x01(\t\x12\x10\n\x08response\x18\x02 \x01(\x0c\"\xc0\x01\n#AdditionalChallengeResponseRequired\x12\x0c\n\x04type\x18\x01 \x01(\t\x12\x0e\n\x06prompt\x18\x02 \x01(\t\x12Q\n\tparameter\x18\x03 \x03(\x0b\x32>.StudioAPI.Proto.AdditionalChallengeResponseRequired.Parameter\x1a(\n\tParameter\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t\"\xd4\x03\n\x0c\x41uthResponse\x12\x41\n\x0bresult_code\x18\x01 \x01(\x0e\x32,.StudioAPI.Proto.AuthResponse.AuthResultCode\x12\x13\n\x0bresult_text\x18\x02 \x01(\t\x12\x64\n&additional_challenge_response_required\x18\x03 \x03(\x0b\x32\x34.StudioAPI.Proto.AdditionalChallengeResponseRequired\x12\x15\n\rrole_assigned\x18\x04 \x03(\t\"\xee\x01\n\x0e\x41uthResultCode\x12\x18\n\x14\x65\x43redentialsRequired\x10\x00\x12\x0c\n\x08\x65Granted\x10\x01\x12\"\n\x1e\x65GrantedPasswordWillExpireSoon\x10\x02\x12\x18\n\x14\x65NewPasswordRequired\x10\n\x12\x1d\n\x19\x65InvalidChallengeResponse\x10\x0b\x12\x1f\n\x1b\x65\x41\x64\x64itionalResponseRequired\x10\x0c\x12\x17\n\x13\x65TemporarilyBlocked\x10\r\x12\x1d\n\x19\x65ReauthenticationRequired\x10\x0e\"\xe7\x08\n\tContainer\x12\x35\n\x0cmessage_type\x18\x01 \x01(\x0e\x32\x1f.StudioAPI.Proto.Container.Type\x12%\n\x05\x65rror\x18\x02 \x01(\x0b\x32\x16.StudioAPI.Proto.Error\x12\x19\n\x11structure_request\x18\x03 \x03(\r\x12\x31\n\x12structure_response\x18\x04 \x03(\x0b\x32\x15.StudioAPI.Proto.Node\x12\x35\n\x0egetter_request\x18\x05 \x03(\x0b\x32\x1d.StudioAPI.Proto.ValueRequest\x12\x36\n\x0fgetter_response\x18\x06 \x03(\x0b\x32\x1d.StudioAPI.Proto.VariantValue\x12\x35\n\x0esetter_request\x18\x07 \x03(\x0b\x32\x1d.StudioAPI.Proto.VariantValue\x12!\n\x19structure_change_response\x18\x08 \x03(\r\x12\x1d\n\x15\x63urrent_time_response\x18\t \x01(\x04\x12\x34\n\x11\x63hild_add_request\x18\n \x03(\x0b\x32\x19.StudioAPI.Proto.ChildAdd\x12:\n\x14\x63hild_remove_request\x18\x0b \x03(\x0b\x32\x1c.StudioAPI.Proto.ChildRemove\x12\x35\n\x0fre_auth_request\x18\x0c \x01(\x0b\x32\x1c.StudioAPI.Proto.AuthRequest\x12\x37\n\x10re_auth_response\x18\r \x01(\x0b\x32\x1d.StudioAPI.Proto.AuthResponse\x12\x34\n\revent_request\x18\x0e \x03(\x0b\x32\x1d.StudioAPI.Proto.EventRequest\x12\x32\n\x0e\x65vent_response\x18\x0f \x03(\x0b\x32\x1a.StudioAPI.Proto.EventInfo\"\xef\x02\n\x04Type\x12\x10\n\x0c\x65RemoteError\x10\x00\x12\x15\n\x11\x65StructureRequest\x10\x01\x12\x16\n\x12\x65StructureResponse\x10\x02\x12\x12\n\x0e\x65GetterRequest\x10\x03\x12\x13\n\x0f\x65GetterResponse\x10\x04\x12\x12\n\x0e\x65SetterRequest\x10\x05\x12\x1c\n\x18\x65StructureChangeResponse\x10\x06\x12\x17\n\x13\x65\x43urrentTimeRequest\x10\x07\x12\x18\n\x14\x65\x43urrentTimeResponse\x10\x08\x12\x14\n\x10\x65\x43hildAddRequest\x10\t\x12\x17\n\x13\x65\x43hildRemoveRequest\x10\n\x12\x12\n\x0e\x65ReauthRequest\x10\x0b\x12\x13\n\x0f\x65ReauthResponse\x10\x0c\x12\x19\n\x15\x65\x41\x63tivityNotification\x10\r\x12\x11\n\reEventRequest\x10\x0e\x12\x12\n\x0e\x65\x45ventResponse\x10\x0f*\x08\x08\x64\x10\x80\x80\x80\x80\x02\"\x81\x01\n\x05\x45rror\x12\x0c\n\x04\x63ode\x18\x01 \x02(\r\x12\x0c\n\x04text\x18\x02 \x01(\t\x12\x0f\n\x07node_id\x18\x03 \x01(\r\x12\x11\n\tparameter\x18\x04 \x01(\t\x12\x11\n\tchallenge\x18\x05 \x01(\x0c\x12\x1b\n\x13idle_lockout_period\x18\x06 \x01(\r*\x08\x08\x64\x10\x80\x80\x80\x80\x02\"\xb6\x03\n\x04Info\x12\x0f\n\x07node_id\x18\x01 \x02(\r\x12\x0c\n\x04name\x18\x02 \x02(\t\x12/\n\tnode_type\x18\x03 \x02(\x0e\x32\x1c.StudioAPI.Proto.CDPNodeType\x12\x31\n\nvalue_type\x18\x04 \x01(\x0e\x32\x1d.StudioAPI.Proto.CDPValueType\x12\x11\n\ttype_name\x18\x05 \x01(\t\x12\x13\n\x0bserver_addr\x18\x06 \x01(\t\x12\x13\n\x0bserver_port\x18\x07 \x01(\r\x12\x10\n\x08is_local\x18\x08 \x01(\x08\x12\r\n\x05\x66lags\x18\t \x01(\r\"\xc2\x01\n\x05\x46lags\x12\t\n\x05\x65None\x10\x00\x12\x0f\n\x0b\x65NodeIsLeaf\x10\x01\x12\x16\n\x12\x65ValueIsPersistent\x10\x02\x12\x14\n\x10\x65ValueIsReadOnly\x10\x04\x12\x14\n\x10\x65NodeIsRemovable\x10\x08\x12\x17\n\x13\x65NodeCanAddChildren\x10\x10\x12\x14\n\x10\x65NodeIsRenamable\x10 \x12\x13\n\x0f\x65NodeIsInternal\x10@\x12\x15\n\x10\x65NodeIsImportant\x10\x80\x01*\x08\x08\x64\x10\x80\x80\x80\x80\x02\"Z\n\x04Node\x12#\n\x04info\x18\x01 \x02(\x0b\x32\x15.StudioAPI.Proto.Info\x12#\n\x04node\x18\x02 \x03(\x0b\x32\x15.StudioAPI.Proto.Node*\x08\x08\x64\x10\x80\x80\x80\x80\x02\"Y\n\x08\x43hildAdd\x12\x16\n\x0eparent_node_id\x18\x01 \x02(\r\x12\x12\n\nchild_name\x18\x02 \x02(\t\x12\x17\n\x0f\x63hild_type_name\x18\x03 \x02(\t*\x08\x08\x64\x10\x80\x80\x80\x80\x02\"C\n\x0b\x43hildRemove\x12\x16\n\x0eparent_node_id\x18\x01 \x02(\r\x12\x12\n\nchild_name\x18\x02 \x02(\t*\x08\x08\x64\x10\x80\x80\x80\x80\x02\"\x92\x02\n\x0cVariantValue\x12\x0f\n\x07node_id\x18\x01 \x01(\r\x12\x0f\n\x07\x64_value\x18\x02 \x01(\x01\x12\x0f\n\x07\x66_value\x18\x03 \x01(\x02\x12\x12\n\nui64_value\x18\x04 \x01(\x04\x12\x11\n\ti64_value\x18\x05 \x01(\x12\x12\x10\n\x08ui_value\x18\x06 \x01(\r\x12\x0f\n\x07i_value\x18\x07 \x01(\x11\x12\x10\n\x08us_value\x18\x08 \x01(\r\x12\x0f\n\x07s_value\x18\t \x01(\x11\x12\x10\n\x08uc_value\x18\n \x01(\r\x12\x0f\n\x07\x63_value\x18\x0b \x01(\x11\x12\x0f\n\x07\x62_value\x18\x0c \x01(\x08\x12\x11\n\tstr_value\x18\r \x01(\t\x12\x11\n\ttimestamp\x18\x0e \x01(\x04*\x08\x08\x64\x10\x80\x80\x80\x80\x02\"X\n\x0cValueRequest\x12\x0f\n\x07node_id\x18\x01 \x02(\r\x12\n\n\x02\x66s\x18\x02 \x01(\x01\x12\x0c\n\x04stop\x18\x03 \x01(\x08\x12\x13\n\x0bsample_rate\x18\x04 \x01(\x01*\x08\x08\x64\x10\x80\x80\x80\x80\x02\"N\n\x0c\x45ventRequest\x12\x0f\n\x07node_id\x18\x01 \x01(\r\x12\x15\n\rstarting_from\x18\x02 \x01(\x04\x12\x0c\n\x04stop\x18\x03 \x01(\x08*\x08\x08\x64\x10\x80\x80\x80\x80\x02\"\x90\x03\n\tEventInfo\x12\x0f\n\x07node_id\x18\x01 \x03(\r\x12\n\n\x02id\x18\x02 \x01(\x04\x12\x0e\n\x06sender\x18\x03 \x01(\t\x12\x0c\n\x04\x63ode\x18\x04 \x01(\r\x12\x0e\n\x06status\x18\x05 \x01(\r\x12\x11\n\ttimestamp\x18\x06 \x01(\x04\x12\x32\n\x04\x64\x61ta\x18\x07 \x03(\x0b\x32$.StudioAPI.Proto.EventInfo.EventData\x12\x1d\n\x15\x61\x63k_handler_node_name\x18\x08 \x01(\t\x12$\n\x1c\x61\x63k_handler_param_data_names\x18\t \x03(\t\x1a(\n\tEventData\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t\"x\n\tCodeFlags\x12\r\n\taAlarmSet\x10\x01\x12\r\n\teAlarmClr\x10\x02\x12\r\n\teAlarmAck\x10\x04\x12\x0c\n\x08\x65Reprise\x10@\x12\x1d\n\x18\x65SourceObjectUnavailable\x10\x80\x02\x12\x11\n\teNodeBoot\x10\x80\x80\x80\x80\x04*\x08\x08\x64\x10\x80\x80\x80\x80\x02*\xd5\x01\n\x0fRemoteErrorCode\x12\x1a\n\x16\x65\x41UTH_RESPONSE_EXPIRED\x10\x01\x12\x14\n\x10\x65INVALID_REQUEST\x10\n\x12\x1f\n\x1b\x65UNSUPPORTED_CONTAINER_TYPE\x10\x14\x12\x1f\n\x1b\x65VALUE_THROTTLING_OCCURRING\x10\x1e\x12\x1d\n\x19\x65VALUE_THROTTLING_STOPPED\x10\x1f\x12\x15\n\x11\x65\x43HILD_ADD_FAILED\x10(\x12\x18\n\x14\x65\x43HILD_REMOVE_FAILED\x10\x32*\xfb\x01\n\x0b\x43\x44PNodeType\x12\x1a\n\rCDP_UNDEFINED\x10\xff\xff\xff\xff\xff\xff\xff\xff\xff\x01\x12\x0e\n\nCDP_SYSTEM\x10\x00\x12\x13\n\x0f\x43\x44P_APPLICATION\x10\x01\x12\x11\n\rCDP_COMPONENT\x10\x02\x12\x0e\n\nCDP_OBJECT\x10\x03\x12\x0f\n\x0b\x43\x44P_MESSAGE\x10\x04\x12\x13\n\x0f\x43\x44P_BASE_OBJECT\x10\x05\x12\x10\n\x0c\x43\x44P_PROPERTY\x10\x06\x12\x0f\n\x0b\x43\x44P_SETTING\x10\x07\x12\x0c\n\x08\x43\x44P_ENUM\x10\x08\x12\x10\n\x0c\x43\x44P_OPERATOR\x10\t\x12\x0c\n\x08\x43\x44P_NODE\x10\n\x12\x11\n\rCDP_USER_TYPE\x10\x64*\xbc\x01\n\x0c\x43\x44PValueType\x12\x0e\n\neUNDEFINED\x10\x00\x12\x0b\n\x07\x65\x44OUBLE\x10\x01\x12\x0b\n\x07\x65UINT64\x10\x02\x12\n\n\x06\x65INT64\x10\x03\x12\n\n\x06\x65\x46LOAT\x10\x04\x12\t\n\x05\x65UINT\x10\x05\x12\x08\n\x04\x65INT\x10\x06\x12\x0b\n\x07\x65USHORT\x10\x07\x12\n\n\x06\x65SHORT\x10\x08\x12\n\n\x06\x65UCHAR\x10\t\x12\t\n\x05\x65\x43HAR\x10\n\x12\t\n\x05\x65\x42OOL\x10\x0b\x12\x0b\n\x07\x65STRING\x10\x0c\x12\r\n\teUSERTYPE\x10\x64\x42*\n\x1b\x63om.cdptech.cdpclient.protoB\tStudioAPIH\x03')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'cdp_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'\n\033com.cdptech.cdpclient.protoB\tStudioAPIH\003'
+  _globals['_REMOTEERRORCODE']._serialized_start=4098
+  _globals['_REMOTEERRORCODE']._serialized_end=4311
+  _globals['_CDPNODETYPE']._serialized_start=4314
+  _globals['_CDPNODETYPE']._serialized_end=4565
+  _globals['_CDPVALUETYPE']._serialized_start=4568
+  _globals['_CDPVALUETYPE']._serialized_end=4756
+  _globals['_HELLO']._serialized_start=31
+  _globals['_HELLO']._serialized_end=462
+  _globals['_HELLO_SUGGESTEDUSER']._serialized_start=391
+  _globals['_HELLO_SUGGESTEDUSER']._serialized_end=462
+  _globals['_AUTHREQUEST']._serialized_start=465
+  _globals['_AUTHREQUEST']._serialized_end=624
+  _globals['_AUTHREQUEST_CHALLENGERESPONSE']._serialized_start=573
+  _globals['_AUTHREQUEST_CHALLENGERESPONSE']._serialized_end=624
+  _globals['_ADDITIONALCHALLENGERESPONSEREQUIRED']._serialized_start=627
+  _globals['_ADDITIONALCHALLENGERESPONSEREQUIRED']._serialized_end=819
+  _globals['_ADDITIONALCHALLENGERESPONSEREQUIRED_PARAMETER']._serialized_start=779
+  _globals['_ADDITIONALCHALLENGERESPONSEREQUIRED_PARAMETER']._serialized_end=819
+  _globals['_AUTHRESPONSE']._serialized_start=822
+  _globals['_AUTHRESPONSE']._serialized_end=1290
+  _globals['_AUTHRESPONSE_AUTHRESULTCODE']._serialized_start=1052
+  _globals['_AUTHRESPONSE_AUTHRESULTCODE']._serialized_end=1290
+  _globals['_CONTAINER']._serialized_start=1293
+  _globals['_CONTAINER']._serialized_end=2420
+  _globals['_CONTAINER_TYPE']._serialized_start=2043
+  _globals['_CONTAINER_TYPE']._serialized_end=2410
+  _globals['_ERROR']._serialized_start=2423
+  _globals['_ERROR']._serialized_end=2552
+  _globals['_INFO']._serialized_start=2555
+  _globals['_INFO']._serialized_end=2993
+  _globals['_INFO_FLAGS']._serialized_start=2789
+  _globals['_INFO_FLAGS']._serialized_end=2983
+  _globals['_NODE']._serialized_start=2995
+  _globals['_NODE']._serialized_end=3085
+  _globals['_CHILDADD']._serialized_start=3087
+  _globals['_CHILDADD']._serialized_end=3176
+  _globals['_CHILDREMOVE']._serialized_start=3178
+  _globals['_CHILDREMOVE']._serialized_end=3245
+  _globals['_VARIANTVALUE']._serialized_start=3248
+  _globals['_VARIANTVALUE']._serialized_end=3522
+  _globals['_VALUEREQUEST']._serialized_start=3524
+  _globals['_VALUEREQUEST']._serialized_end=3612
+  _globals['_EVENTREQUEST']._serialized_start=3614
+  _globals['_EVENTREQUEST']._serialized_end=3692
+  _globals['_EVENTINFO']._serialized_start=3695
+  _globals['_EVENTINFO']._serialized_end=4095
+  _globals['_EVENTINFO_EVENTDATA']._serialized_start=3923
+  _globals['_EVENTINFO_EVENTDATA']._serialized_end=3963
+  _globals['_EVENTINFO_CODEFLAGS']._serialized_start=3965
+  _globals['_EVENTINFO_CODEFLAGS']._serialized_end=4085
+# @@protoc_insertion_point(module_scope)

{cdp_client-2.2.0 → cdp_client-2.3.0}/cdp_client/tests/fake_data.py

@@ -226,3 +226,47 @@ def create_auth_response_expired_error(challenge):
     response.error.text = "Session expired"
     response.error.challenge = challenge
     return response
+
+
+event_info1 = proto.EventInfo()
+event_info1.node_id.append(1)
+event_info1.id = 12345
+event_info1.sender = "App1.Comp1"
+event_info1.code = 1001
+event_info1.timestamp = 1234567890
+data_item1 = event_info1.data.add()
+data_item1.name = "temperature"
+data_item1.value = "25.5"
+data_item2 = event_info1.data.add()
+data_item2.name = "status"
+data_item2.value = "OK"
+
+event_info2 = proto.EventInfo()
+event_info2.node_id.append(1)
+event_info2.id = 67890
+event_info2.sender = "App2.Comp2"
+event_info2.code = 2001
+event_info2.timestamp = 1234567900
+
+def create_event_request(node_id):
+    request = proto.Container()
+    request.message_type = proto.Container.eEventRequest
+    event_req = request.event_request.add()
+    event_req.node_id = node_id
+    event_req.stop = False
+    return request
+
+def create_event_unrequest(node_id):
+    request = proto.Container()
+    request.message_type = proto.Container.eEventRequest
+    event_req = request.event_request.add()
+    event_req.node_id = node_id
+    event_req.stop = True
+    return request
+
+def create_event_response(event_info):
+    response = proto.Container()
+    response.message_type = proto.Container.eEventResponse
+    event_resp = response.event_response.add()
+    event_resp.CopyFrom(event_info)
+    return response

{cdp_client-2.2.0 → cdp_client-2.3.0}/cdp_client/tests/test_connection.py

@@ -275,3 +275,31 @@ class ConnectionTester(unittest.TestCase):
         self.assertEqual(self._connection._notification_listener.credentials_requested_call_count, 1)
         self.assertFalse(mock_send.called)
         self.assertFalse(self._connection._is_connected)
+
+    @mock.patch.object(cdp.websocket.WebSocketApp, 'send')
+    @mock.patch.object(cdp.Connection, '_update_time_difference')
+    def test_sending_event_request(self, mock_time_update, mock_send):
+        node_id = 1
+        self._connection.send_event_request(node_id)
+        expected_msg = fake_data.create_event_request(node_id).SerializeToString()
+        # Debug: check if any message was sent
+        self.assertTrue(mock_send.called)
+        # Just verify the right type of call was made rather than exact bytes
+        calls = mock_send.call_args_list
+        self.assertEqual(len(calls), 1)
+
+    @mock.patch.object(cdp.websocket.WebSocketApp, 'send')
+    @mock.patch.object(cdp.Connection, '_update_time_difference')
+    def test_sending_event_unrequest(self, mock_time_update, mock_send):
+        node_id = 1
+        self._connection.send_event_unrequest(node_id)
+        mock_send.assert_any_call(fake_data.create_event_unrequest(node_id).SerializeToString())
+
+    @mock.patch.object(cdp.NodeTree, 'find_by_id')
+    @mock.patch.object(cdp.Node, '_update_event')
+    def test_node_event_received(self, mock_update_event, mock_find_by_id):
+        self._connection._is_connected = True
+        mock_find_by_id.return_value = cdp.Node(None, self._connection, fake_data.app1_node)
+        response = fake_data.create_event_response(fake_data.event_info1)
+        self._connection._handle_container_message(response.SerializeToString())
+        mock_update_event.assert_called_once_with(response.event_response[0])