cleanups

Author: irmen

Makefile

@@ -1,8 +1,8 @@
-.PHONY: all dist sdist wheel docs install upload clean test
+.PHONY: all dist docs install upload clean test
 PYTHON=python3
 
 all:
-	@echo "targets include dist, docs, upload, install, clean"
+	@echo "targets: dist, docs, upload, install, clean, test"
 
 docs:
 	$(PYTHON) setup.py build_sphinx

Pyro5/core.py

@@ -203,7 +203,7 @@ def resolve(uri: Union[str, URI], delay_time: float = 0.0) -> URI:
         raise errors.PyroError("invalid uri protocol")
 
 
-from . import client  # XXX circular
+from . import client  # circular import...
 
 
 def locate_ns(host: Union[str, ipaddress.IPv4Address, ipaddress.IPv6Address] = "",

Pyro5/protocol.py

@@ -66,8 +66,12 @@
 _empty_correlation_id = b"\0" * 16
 
 
+from . import core   #  circular import...
+
+
 class SendingMessage:
     """Wire protocol message that will be sent."""
+
     def __init__(self, msgtype, flags, seq, serializer_id, payload, annotations=None):
         self.type = msgtype
         self.seq = seq
@@ -82,7 +86,6 @@ def __init__(self, msgtype, flags, seq, serializer_id, payload, annotations=None
         total_size = len(payload) + annotations_size
         if total_size > config.MAX_MESSAGE_SIZE:
             raise errors.ProtocolError("message too large ({:d}, max={:d})".format(total_size, config.MAX_MESSAGE_SIZE))
-        from . import core  # XXX circular
         if core.current_context.correlation_id:
             flags |= FLAGS_CORR_ID
             self.corr_id = core.current_context.correlation_id.bytes
@@ -178,12 +181,13 @@ def log_wiredata(logger, text, msg):
                  (text, msg.type, msg.flags, msg.serializer_id, msg.seq, num_anns, corr_id, bytes(msg.data)))
 
 
-def recv_stub(connection, accepted_msgtypes=None):  # @todo decouple i/o from actual protocol logic
+def recv_stub(connection, accepted_msgtypes=None):
     """
     Receives a pyro message from a given connection.
     Accepts the given message types (None=any, or pass a sequence).
     Also reads annotation chunks and the actual payload data.
     """
+    # TODO decouple i/o from actual protocol logic, so that the protocol can be easily unit tested
     header = connection.recv(6)  # 'PYRO' + 2 bytes protocol version
     ReceivingMessage.validate(header)
     header += connection.recv(_header_size - 6)

Pyro5/serializers.py

@@ -172,7 +172,7 @@ def dict_to_class(cls, data):
         Recreate an object out of a dict containing the class name and the attributes.
         Only a fixed set of classes are recognized.
         """
-        from . import core, client, server  # XXX circular
+        from . import core, client, server  # circular imports...
         classname = data.get("__class__", "<unknown>")
         if isinstance(classname, bytes):
             classname = classname.decode("utf-8")
@@ -181,7 +181,8 @@ def dict_to_class(cls, data):
             return converter(classname, data)
         if "__" in classname:
             raise errors.SecurityError("refused to deserialize types with double underscores in their name: " + classname)
-        # for performance, the constructors below are hardcoded here instead of added on a per-class basis to the dict-to-class registry
+        # for performance reasons, the constructors below are hardcoded here
+        # instead of added on a per-class basis to the dict-to-class registry
         if classname == "Pyro5.core.URI":
             uri = core.URI.__new__(core.URI)
             uri.__setstate__(data["state"])