wslink 2.2.1__tar.gz → 2.3.0__tar.gz

{wslink-2.2.1 → wslink-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wslink
-Version: 2.2.1
+Version: 2.3.0
 Summary: Python/JavaScript library for communicating over WebSocket
 Home-page: https://github.com/kitware/wslink
 Author: Kitware, Inc.

{wslink-2.2.1 → wslink-2.3.0}/setup.cfg

@@ -1,5 +1,5 @@
 [metadata]
-version = 2.2.1
+version = 2.3.0
 
 [egg_info]
 tag_build = 

{wslink-2.2.1 → wslink-2.3.0}/src/wslink/backends/aiohttp/__init__.py

@@ -23,6 +23,8 @@ HTTP_HEADERS: str | None = os.environ.get("WSLINK_HTTP_HEADERS")  # path to json
 if HTTP_HEADERS and Path(HTTP_HEADERS).exists():
     HTTP_HEADERS: dict = json.loads(Path(HTTP_HEADERS).read_text())
 
+STATE_KEY = aiohttp_web.AppKey("state", str)
+
 logger = logging.getLogger(__name__)
 
 # -----------------------------------------------------------------------------
@@ -92,7 +94,7 @@ class WebAppServer(AbstractWebApp):
             self.app.router.add_route("GET", "/", _root_handler)
             self.app.add_routes(routes)
 
-        self.app["state"] = {}
+        self.app[STATE_KEY] = {}
 
     # -------------------------------------------------------------------------
     # Server status

{wslink-2.2.1 → wslink-2.3.0}/src/wslink/backends/generic/core.py

@@ -56,7 +56,7 @@ class WsConnection:
 
 
 class WsEndpoint(WslinkHandler):
-    def __init__(self, protocol=None, web_app=None):
+    def __init__(self, protocol, web_app=None):
         super().__init__(protocol, web_app)
 
     async def connect(self):

{wslink-2.2.1 → wslink-2.3.0}/src/wslink/backends/jupyter/core.py

@@ -1,49 +1,9 @@
-import asyncio
 from functools import partial
+from wslink.emitter import EventEmitter
 from wslink.backends.generic.core import GenericServer
 from IPython.core.getipython import get_ipython
 
 
-class EventEmitter:
-    def __init__(self):
-        self._listeners = {}
-
-    def clear(self):
-        self._listeners = {}
-
-    def emit(self, event, *args, **kwargs):
-        listeners = self._listeners.get(event)
-        if listeners is None:
-            return
-
-        loop = asyncio.get_running_loop()
-        coroutine_run = (
-            loop.create_task if (loop and loop.is_running()) else asyncio.run
-        )
-
-        for listener in listeners:
-            if asyncio.iscoroutinefunction(listener):
-                coroutine_run(listener(*args, **kwargs))
-            else:
-                listener(*args, **kwargs)
-
-    def add_event_listener(self, event, listener):
-        listeners = self._listeners.get(event)
-        if listeners is None:
-            listeners = set()
-            self._listeners[event] = listeners
-
-        listeners.add(listener)
-
-    def remove_event_listener(self, event, listener):
-        listeners = self._listeners.get(event)
-        if listeners is None:
-            return
-
-        if listener in listeners:
-            listeners.remove(listener)
-
-
 class WsJupyterComm(EventEmitter):
     def __init__(self, kernel=None):
         super().__init__()

wslink-2.3.0/src/wslink/emitter.py

@@ -0,0 +1,63 @@
+from typing import TypeVar, Generic, LiteralString
+
+import asyncio
+import functools
+
+
+T = TypeVar("T", bound=LiteralString)
+
+
+class EventEmitter(Generic[T]):
+    def __init__(self):
+        self._listeners = {}
+
+    def clear(self):
+        self._listeners = {}
+
+    def __call__(self, event: T, *args, **kwargs):
+        self.emit(event, *args, **kwargs)
+
+    def __getattr__(self, name: T):
+        return functools.partial(self.emit, name)
+
+    def emit(self, event: T, *args, **kwargs):
+        listeners = self._listeners.get(event)
+        if listeners is None:
+            return
+
+        loop = asyncio.get_running_loop()
+        coroutine_run = (
+            loop.create_task if (loop and loop.is_running()) else asyncio.run
+        )
+
+        for listener in listeners:
+            if asyncio.iscoroutinefunction(listener):
+                coroutine_run(listener(*args, **kwargs))
+            else:
+                listener(*args, **kwargs)
+
+    def add_event_listener(self, event: T, listener):
+        listeners = self._listeners.get(event)
+        if listeners is None:
+            listeners = set()
+            self._listeners[event] = listeners
+
+        listeners.add(listener)
+
+    def remove_event_listener(self, event: T, listener):
+        listeners = self._listeners.get(event)
+        if listeners is None:
+            return
+
+        if listener in listeners:
+            listeners.remove(listener)
+
+    def has(self, event: T):
+        return self.listeners_count(event) > 0
+
+    def listeners_count(self, event: T):
+        listeners = self._listeners.get(event)
+        if listeners is None:
+            return 0
+
+        return len(listeners)

{wslink-2.2.1 → wslink-2.3.0}/src/wslink/protocol.py

@@ -9,6 +9,7 @@ import traceback
 from wslink import schedule_coroutine
 from wslink.publish import PublishManager
 from wslink.chunking import generate_chunks, UnChunker
+from wslink.websocket import ServerProtocol
 
 # from http://www.jsonrpc.org/specification, section 5.1
 METHOD_NOT_FOUND = -32601
@@ -141,7 +142,7 @@ class AbstractWebApp:
 
 
 class WslinkHandler(object):
-    def __init__(self, protocol=None, web_app=None):
+    def __init__(self, protocol: ServerProtocol, web_app=None):
         self.serverProtocol = protocol
         self.web_app = web_app
         self.functionMap = {}
@@ -153,6 +154,7 @@ class WslinkHandler(object):
         self.pub_manager = PublishManager()
         self.unchunkers = {}
         self.network_monitor = protocol.network_monitor
+        self.log_emitter = protocol.log_emitter
 
         # Build the rpc method dictionary, assuming we were given a serverprotocol
         if self.getServerProtocol():
@@ -253,7 +255,9 @@ class WslinkHandler(object):
 
     async def onMessage(self, is_binary, msg, client_id):
         if not is_binary:
-            logger.critical("wslink is not expecting text message:\n> %s", msg.data)
+            error_message = "wslink is not expecting text message:\n> %s"
+            logger.critical(error_message, msg.data)
+            self.log_emitter.critical(error_message % msg.data)
             return
 
         full_message = self.unchunkers[client_id].process_chunk(msg.data)
@@ -262,7 +266,13 @@ class WslinkHandler(object):
                 await self.onCompleteMessage(full_message, client_id)
 
     async def onCompleteMessage(self, rpc, client_id):
-        logger.debug("wslink incoming msg %s", self.payloadWithSecretStripped(rpc))
+        debug_message = "wslink incoming msg %s"
+        stripped_payload = self.payloadWithSecretStripped(rpc)
+        logger.debug(debug_message, stripped_payload)
+
+        if self.log_emitter.has("debug"):
+            self.log_emitter.debug(debug_message % stripped_payload)
+
         if "id" not in rpc:
             return
 
@@ -295,6 +305,7 @@ class WslinkHandler(object):
 
         # No matching method found
         if not methodName in self.functionMap:
+            self.log_emitter.error(f"Method not found: {methodName}")
             with self.network_monitor:
                 await self.sendWrappedError(
                     rpcid,
@@ -328,6 +339,7 @@ class WslinkHandler(object):
             logger.error("Exception raised")
             logger.error(repr(e_inst))
             logger.error(captured_trace)
+            self.log_emitter.exception(e_inst)
             with self.network_monitor:
                 await self.sendWrappedError(
                     rpcid,

{wslink-2.2.1 → wslink-2.3.0}/src/wslink/websocket.py

@@ -6,9 +6,12 @@ ServerProtocol to hook all the needed LinkProtocols together.
 
 import logging
 import asyncio
+from typing import Literal
+from dataclasses import dataclass
 
-from . import register as exportRpc
-from . import schedule_callback
+from wslink import register as exportRpc
+from wslink import schedule_callback
+from wslink.emitter import EventEmitter
 
 logger = logging.getLogger(__name__)
 
@@ -117,6 +120,9 @@ class NetworkMonitor:
             await self.event.wait()
 
 
+LogEmitterEvents = Literal["exception", "error", "critical", "info", "debug"]
+
+
 class ServerProtocol(object):
     """
     Defines the core server protocol for wslink. Gathers a list of LinkProtocol
@@ -125,6 +131,7 @@ class ServerProtocol(object):
 
     def __init__(self):
         self.network_monitor = NetworkMonitor()
+        self.log_emitter = EventEmitter[LogEmitterEvents]()
         self.linkProtocols = []
         self.secret = None
         self.initialize()
@@ -169,7 +176,9 @@ class ServerProtocol(object):
         try:
             self.linkProtocols.remove(protocol)
         except ValueError as e:
-            logger.error("Link protocol missing from registered list.")
+            error_message = "Link protocol missing from registered list."
+            logger.error(error_message)
+            self.log_emitter("error", error_message)
 
     def getLinkProtocols(self):
         return self.linkProtocols

{wslink-2.2.1 → wslink-2.3.0}/src/wslink.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wslink
-Version: 2.2.1
+Version: 2.3.0
 Summary: Python/JavaScript library for communicating over WebSocket
 Home-page: https://github.com/kitware/wslink
 Author: Kitware, Inc.

{wslink-2.2.1 → wslink-2.3.0}/src/wslink.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ setup.py
 src/wslink/LICENSE
 src/wslink/__init__.py
 src/wslink/chunking.py
+src/wslink/emitter.py
 src/wslink/launcher.py
 src/wslink/protocol.py
 src/wslink/publish.py