hide internals behind a public api

Author: jacklowrie

src/chordnet/__init__.py

@@ -1,6 +1,4 @@
 """init.py: defines importable classes."""
-from .address import Address
-from .net import _Net
-from .node import Node
+from .chordnet import ChordNet
 
-__all__=['Node', 'Address', '_Net']
+__all__=['ChordNet']

src/chordnet/net.py renamed to src/chordnet/_net.py

@@ -4,11 +4,11 @@
 
 from loguru import logger as log
 
+from ._net import _Net
 from .address import Address
-from .net import _Net
 
 callback_t = Callable[[str, list[str]], str | Address | None]
-class Node:
+class _Node:
     """Implements a Chord distributed hash table node.
 
     This is meant to run on a host and handle any chord-related

src/chordnet/node.py renamed to src/chordnet/_node.py

@@ -0,0 +1,51 @@
+"""chordnet.py: chordnet api."""
+from ._node import _Node
+
+
+class ChordNet:
+    """Interface for interacting with Chord networks."""
+
+    _node: _Node
+
+    def __init__(self,
+                 ip: str,
+                 port: int,
+                 interval:float=1.0,
+    ) -> None:
+        """Initializes a new Chord node.
+
+        Args:
+            ip: IP address for the node.
+            port: Port number to listen on.
+            daemon: whether to run the daemon.
+            interval: daemon interval.
+            debug: whether to print node state after every daemon run.
+        """
+        self._node = _Node(ip, port, interval=interval)
+
+
+    def create(self) -> None:
+        """Create a new ChordNet network (a new "ring").
+
+        This creates a new network with one node (this one).
+        """
+        self._node.create()
+
+    def join(self, known_ip: str, known_port: int) -> None:
+        """Joins an existing ChordNet network (an existing ring).
+
+        An existing chordnet can be joined through any node already on the ring.
+
+        Args:
+            known_ip (str): IP address of an existing node in the Chord ring.
+            known_port (int): Port number of the existing node.
+        """
+        self._node.join(known_ip, known_port)
+
+    def leave(self) -> None:
+        """Leave the current network.
+
+        Allows for a graceful shutdown of this node. Should be called before
+        program exit, but the network can recover if this does not happen.
+        """
+        pass

src/chordnet/chordnet.py

@@ -10,9 +10,7 @@
 
 import pytest
 
-from chordnet import (
-    _Net,
-)
+from chordnet._net import _Net
 
 
 def test_net_initialization() -> None:

tests/test_net.py

@@ -9,8 +9,8 @@
 
 import pytest
 
-from chordnet import Address
-from chordnet import Node as ChordNode
+from chordnet._node import _Node as ChordNode
+from chordnet.address import Address
 
 # Global test variables
 ip: str = "1.2.3.4"