Rename ApplevelProtocol -> ApplevelProtocolMixin, more descriptive.

Technologicat · Technologicat · commit 7967b9743351 · 2020-01-06T15:25:42.000+02:00
diff --git a/unpythonic/net/client.py b/unpythonic/net/client.py
@@ -35,7 +35,7 @@
 
 from .msg import MessageDecoder
 from .util import socketsource
-from .common import ApplevelProtocol
+from .common import ApplevelProtocolMixin
 
 __all__ = ["connect"]
 
@@ -76,7 +76,7 @@ def _handle_alarm(signum, frame):
 # to the beginning of the second message has already arrived and been read
 # from the socket, when trying to read the last batch of data belonging to
 # the end of the first message.
-class ControlClient(ApplevelProtocol):
+class ControlClient(ApplevelProtocolMixin):
     # TODO: manage the socket internally. We need to make this into a context manager,
     # so that __enter__ can set up the socket and __exit__ can tear it down.
     def __init__(self, sock):
@@ -92,7 +92,7 @@ def __init__(self, sock):
         self.decoder = MessageDecoder(socketsource(sock))
 
     # This belongs only to the client side of the application-level protocol,
-    # so it lives here, not in ApplevelProtocol.
+    # so it lives here, not in ApplevelProtocolMixin.
     def _remote_execute(self, request):
         """Send a command to the server, get the reply.
 
diff --git a/unpythonic/net/common.py b/unpythonic/net/common.py
@@ -5,9 +5,9 @@
 
 from .msg import encodemsg
 
-__all__ = ["ApplevelProtocol"]
+__all__ = ["ApplevelProtocolMixin"]
 
-class ApplevelProtocol:
+class ApplevelProtocolMixin:
     """Application-level communication protocol.
 
     We encode the payload dictionary as JSON, then encode the text as utf-8.
@@ -21,11 +21,9 @@ class ApplevelProtocol:
     Transmission is synchronous; when one end is sending, the other one must be
     receiving. Receiving will block until success, or until the socket is closed.
 
-    This can be used as a common base class for server/client object pairs.
-    It can also be used as a mixin.
+    This is a mixin class for communication between server/client object pairs.
 
-    **NOTE**: The derived class (or class mixing this in) must define two
-      attributes:
+    **NOTE**: The class class mixing this in must define two attributes:
 
       - `sock`: a TCP socket. When `_send` or `_recv` is called, the socket
         must be open and connected to the peer to communicate with.
diff --git a/unpythonic/net/server.py b/unpythonic/net/server.py
@@ -101,7 +101,7 @@
 
 from .util import ReuseAddrThreadingTCPServer, socketsource
 from .msg import MessageDecoder
-from .common import ApplevelProtocol
+from .common import ApplevelProtocolMixin
 from .ptyproxy import PTYSocketProxy
 
 # Because "These are only defined if the interpreter is in interactive mode.",
@@ -154,7 +154,7 @@ def server_print(*values, **kwargs):
     print(*values, **kwargs, file=_original_stdout)
 
 
-class ControlSession(socketserver.BaseRequestHandler, ApplevelProtocol):
+class ControlSession(socketserver.BaseRequestHandler, ApplevelProtocolMixin):
     """Entry point for connections to the control server.
 
     We use a separate connection for control to avoid head-of-line blocking.
