cleanup code

Author: jryannel

pyproject.toml

@@ -3,4 +3,8 @@ requires = [
     "setuptools>=42",
     "wheel"
 ]
-build-backend = "setuptools.build_meta"
+build-backend = "setuptools.build_meta"
+[tool.pytest.ini_options]
+pythonpath = [
+  "src"
+]

src/olink/client/__init__.py

@@ -0,0 +1,5 @@
+from .sink import IObjectSink as IObjectSink
+from .node import ClientNode as ClientNode
+from .node import InvokeReplyArg as InvokeReplyArg
+from .registry import ClientRegistry as ClientRegistry
+from .registry import get_client_registry as get_client_registry

src/olink/clientnode.py src/olink/client/node.pysrc/olink/clientnode.py renamed to src/olink/client/node.py

@@ -1,9 +1,8 @@
-from re import A
-from typing import Any, Callable, Optional, Protocol as ProtocolType
-from olink.core.types import Base, LogLevel, MsgType, Name
-from olink.core.node import BaseNode
-from olink.core.protocol import Protocol
 
+from typing import Any, Optional, Callable
+from olink.core import LogLevel, MsgType, BaseNode, Protocol
+from .registry import ClientRegistry, get_client_registry
+from .sink import IObjectSink
 
 class InvokeReplyArg:
     def __init__(self, name: str, value: Any):
@@ -16,108 +15,6 @@ def __init__(self, name: str, value: Any):
 
 InvokeReplyFunc = Callable[[InvokeReplyArg], None]
 
-
-class IObjectSink(ProtocolType):
-    # interface for object sinks
-    def olink_object_name() -> str:
-        # return object name
-        raise NotImplementedError()
-
-    def olink_on_signal(self, name: str, args: list[Any]) -> None:
-        # called on signal message
-        raise NotImplementedError()
-
-    def olink_on_property_changed(self, name: str, value: Any) -> None:
-        # called on property changed message
-        raise NotImplementedError()
-
-    def olink_on_init(self, name: str, props: object, node: "ClientNode"):
-        # called on init message
-        raise NotImplementedError()
-
-    def olink_on_release(self) -> None:
-        # called when sink is released
-        raise NotImplementedError()
-
-
-class SinkToClientEntry:
-    # entry in the client registry
-    sink: IObjectSink = None
-    node: "ClientNode" = None
-
-    def __init__(self, sink=None):
-        self.sink = sink
-        self.node = None
-
-
-class ClientRegistry(Base):
-    # client side registry to link sinks to nodes
-    entries: dict[str, SinkToClientEntry] = {}
-
-    def remove_node(self, node: "ClientNode"):
-        # remove node from all sinks
-        for entry in self.entries.values():
-            if entry.node is node:
-                entry.node = None
-
-    def add_node_to_sink(self, name: str, node: "ClientNode"):
-        # add not to named sink
-        self._entry(name).node = node
-
-    def remove_node_from_sink(self, name: str, node: "ClientNode"):
-        # remove node from named sink
-        resource = Name.resource_from_name(name)
-        if resource in self.entries:
-            if self.entries[resource].node is node:
-                self.entries[resource].node = None
-            else:
-                self.emit_log(
-                    LogLevel.DEBUG, f"unlink node failed, not the same node: {resource}"
-                )
-
-    def register_sink(self, sink: IObjectSink) -> "ClientNode":
-        # register sink using object name
-        name = sink.olink_object_name()
-        entry = self._entry(name)
-        entry.sink = sink
-        return entry.node
-
-    def unregister_sink(self, sink: IObjectSink):
-        # unregister sink using object name
-        name = sink.olink_object_name()
-        self._remove_entry(name)
-
-    def get_sink(self, name: str) -> Optional[IObjectSink]:
-        # get sink using name
-        return self._entry(name).sink
-
-    def get_node(self, name: str) -> Optional["ClientNode"]:
-        # get node using name
-        return self._entry(name).node
-
-    def _entry(self, name: str) -> SinkToClientEntry:
-        # get an entry by name
-        resource = Name.resource_from_name(name)
-        if not resource in self.entries:
-            self.emit_log(LogLevel.DEBUG, f"add new resource: {resource}")
-            self.entries[resource] = SinkToClientEntry()
-        return self.entries[resource]
-
-    def _remove_entry(self, name: str) -> None:
-        # remove an entry by name
-        resource = Name.resource_from_name(name)
-        del self.entries[resource]
-
-
-# global client registry
-_registry = ClientRegistry()
-
-
-def get_client_registry() -> ClientRegistry:
-    # get global client registry
-    return _registry
-
-
 class ClientNode(BaseNode):
     # client side node
     invokes_pending: dict[int, InvokeReplyFunc] = {}
@@ -143,7 +40,7 @@ def invoke_remote(
         self.emit_write(Protocol.invoke_message(request_id, name, args))
 
     def set_remote_property(self, name: str, value: Any) -> None:
-        # send remote propertymessage
+        # send remote property message
         self.emit_log(LogLevel.DEBUG, f"ClientNode.set_remote_property: {name} {value}")
         self.emit_write(Protocol.set_property_message(name, value))
 
@@ -177,7 +74,7 @@ def link_remote(self, name: str):
         self.emit_write(Protocol.link_message(name))
 
     def unlink_remote(self, name: str):
-        # unlink this node froom sink and send an unlink message
+        # unlink this node from sink and send an unlink message
         self.emit_log(LogLevel.DEBUG, f"ClientNode.unlink_remote: {name}")
         self.emit_write(Protocol.unlink_message(name))
         self.registry().remove_node_from_sink(name, self)

src/olink/client/registry.py

@@ -0,0 +1,83 @@
+from typing import Optional
+from olink.core import LogLevel, Base, Name
+from .sink import IObjectSink
+
+
+class SinkToClientEntry:
+    # entry in the client registry
+    sink: IObjectSink = None
+    node: "ClientNode" = None
+
+    def __init__(self, sink=None):
+        self.sink = sink
+        self.node = None
+
+
+class ClientRegistry(Base):
+    # client side registry to link sinks to nodes
+    entries: dict[str, SinkToClientEntry] = {}
+
+    def remove_node(self, node: "ClientNode"):
+        # remove node from all sinks
+        for entry in self.entries.values():
+            if entry.node is node:
+                entry.node = None
+
+    def add_node_to_sink(self, name: str, node: "ClientNode"):
+        # add not to named sink
+        self._entry(name).node = node
+
+    def remove_node_from_sink(self, name: str, node: "ClientNode"):
+        # remove node from named sink
+        resource = Name.resource_from_name(name)
+        if resource in self.entries:
+            if self.entries[resource].node is node:
+                self.entries[resource].node = None
+            else:
+                self.emit_log(
+                    LogLevel.DEBUG, f"unlink node failed, not the same node: {resource}"
+                )
+
+    def register_sink(self, sink: IObjectSink) -> "ClientNode":
+        # register sink using object name
+        name = sink.olink_object_name()
+        entry = self._entry(name)
+        entry.sink = sink
+        return entry.node
+
+    def unregister_sink(self, sink: IObjectSink):
+        # unregister sink using object name
+        name = sink.olink_object_name()
+        self._remove_entry(name)
+
+    def get_sink(self, name: str) -> Optional[IObjectSink]:
+        # get sink using name
+        return self._entry(name).sink
+
+    def get_node(self, name: str) -> Optional["ClientNode"]:
+        # get node using name
+        return self._entry(name).node
+
+    def _entry(self, name: str) -> SinkToClientEntry:
+        # get an entry by name
+        resource = Name.resource_from_name(name)
+        if not resource in self.entries:
+            self.emit_log(LogLevel.DEBUG, f"add new resource: {resource}")
+            self.entries[resource] = SinkToClientEntry()
+        return self.entries[resource]
+
+    def _remove_entry(self, name: str) -> None:
+        # remove an entry by name
+        resource = Name.resource_from_name(name)
+        del self.entries[resource]
+
+
+# global client registry
+_registry = ClientRegistry()
+
+
+def get_client_registry() -> ClientRegistry:
+    # get global client registry
+    return _registry
+
+

src/olink/client/sink.py

@@ -0,0 +1,23 @@
+from typing import Any, Protocol as ProtocolType
+
+class IObjectSink(ProtocolType):
+    # interface for object sinks
+    def olink_object_name() -> str:
+        # return object name
+        raise NotImplementedError()
+
+    def olink_on_signal(self, name: str, args: list[Any]) -> None:
+        # called on signal message
+        raise NotImplementedError()
+
+    def olink_on_property_changed(self, name: str, value: Any) -> None:
+        # called on property changed message
+        raise NotImplementedError()
+
+    def olink_on_init(self, name: str, props: object, node: "ClientNode"):
+        # called on init message
+        raise NotImplementedError()
+
+    def olink_on_release(self) -> None:
+        # called when sink is released
+        raise NotImplementedError()

src/olink/core/protocol.py

@@ -1,5 +1,4 @@
-from typing import Any
-from typing import Protocol as ProtocolType
+from typing import Any, Protocol as ProtocolType
 from .types import Base, LogLevel, MsgType
 
 

src/olink/mocks/__init__.py

@@ -0,0 +1,2 @@
+from .mocksink import MockSink as MockSink
+from .mocksource import MockSource as MockSource

src/olink/mocks/mocksink.py

@@ -1,6 +1,6 @@
-from olink.core.types import Name
 from typing import Any, Optional
-from olink.clientnode import ClientNode, IObjectSink, InvokeReplyArg
+from olink.core import Name
+from olink.client import ClientNode, IObjectSink, InvokeReplyArg
 
 
 class MockSink(IObjectSink):

src/olink/mocks/mocksource.py

@@ -1,6 +1,6 @@
-from olink.core.types import Name
 from typing import Any
-from olink.remotenode import IObjectSource, RemoteNode
+from olink.core import Name
+from olink.remote import IObjectSource, RemoteNode
 
 
 class MockSource(IObjectSource):

src/olink/remote/__init__.py

@@ -0,0 +1,4 @@
+from .source import IObjectSource as IObjectSource
+from .registry import RemoteRegistry as RemoteRegistry
+from .registry import get_remote_registry as get_remote_registry
+from .node import RemoteNode as RemoteNode