release 5.4

Author: irmen

Pyro5/serializers.py

@@ -16,7 +16,12 @@
 import marshal
 import json
 import serpent
-import msgpack
+try:
+    import msgpack
+    if msgpack.version < (0, 5, 2):
+        raise RuntimeError("requires msgpack 0.5.2 or better")
+except ImportError:
+    msgpack = None
 from . import errors
 
 __all__ = ["SerializerBase", "SerpentSerializer", "JsonSerializer", "MarshalSerializer", "MsgpackSerializer",
@@ -33,9 +38,6 @@
 if ver < (1, 27):
     raise RuntimeError("requires serpent 1.27 or better")
 
-if msgpack.version < (0, 5, 2):
-    raise RuntimeError("requires msgpack 0.5.2 or better")
-
 
 all_exceptions = {}
 for name, t in vars(builtins).items():
@@ -494,9 +496,12 @@ def register_type_replacement(cls, object_type, replacement_function):
 serializers = {
     "serpent": SerpentSerializer(),
     "marshal": MarshalSerializer(),
-    "json": JsonSerializer(),
-    "msgpack": MsgpackSerializer()
+    "json": JsonSerializer()
 }
 
+if msgpack:
+    serializers["msgpack"] = MsgpackSerializer()
+
+
 """The available serializers by their internal id"""
 serializers_by_id = {ser.serializer_id: ser for ser in serializers.values()}

docs/source/changelog.rst

@@ -2,6 +2,11 @@
 Change Log
 **********
 
+**Pyro 5.5**
+
+- made msgpack serializer optional
+
+
 **Pyro 5.4**
 
 - made the decision that Pyro5 will require Python 3.5 or newer, and won't support Python 2.7 (which will be EOL in january 2020)

docs/source/config.rst

@@ -100,7 +100,7 @@ SOCK_REUSE                bool    True                    Should SO_REUSEADDR be
 PREFER_IP_VERSION         int     4                       The IP address type that is preferred (4=ipv4, 6=ipv6, 0=let OS decide).
 THREADPOOL_SIZE           int     40                      For the thread pool server: maximum number of threads running
 THREADPOOL_SIZE_MIN       int     4                       For the thread pool server: minimum number of threads running
-SERIALIZER                str     serpent                 The wire protocol serializer to use for clients/proxies (one of: serpent, json, marshal, msgpack, pickle, cloudpickle, dill)
+SERIALIZER                str     serpent                 The wire protocol serializer to use for clients/proxies (one of: serpent, json, marshal, msgpack)
 SERIALIZERS_ACCEPTED      set     json,marshal,serpent    The wire protocol serializers accepted in the server/daemon. In your code it should be a set of strings,
                                                           use a comma separated string instead when setting the shell environment variable.
 PICKLE_PROTOCOL_VERSION   int     highest possible        The pickle protocol version to use, if pickle is selected as serializer. Defaults to pickle.HIGHEST_PROTOCOL

docs/source/install.rst

@@ -47,9 +47,8 @@ Third party libraries that Pyro5 uses
 `serpent <https://pypi.python.org/pypi/serpent>`_ - required, 1.27 or newer
     Should be installed automatically when you install Pyro.
 
-`msgpack <https://pypi.python.org/pypi/msgpack>`_ - required (for now, may become optional), 0.5.2 or newer
+`msgpack <https://pypi.python.org/pypi/msgpack>`_ - optional, 0.5.2 or newer
     Install this to use the msgpack serializer.
-    Right now it is required, and should be installed automatically when you install Pyro.
 
 
 Stuff you get extra in the source distribution archive and not with packaged versions

requirements.txt

@@ -1,2 +1 @@
 serpent>=1.27
-msgpack>=0.5.2

setup.cfg

@@ -32,7 +32,6 @@ include_package_data = False
 packages = Pyro5, Pyro5.utils, Pyro5.compatibility
 install_requires =
     serpent>=1.27
-    msgpack>=0.5.2
 setup_requires =
     pytest-runner
 test_require =

test-requirements.txt

@@ -0,0 +1,2 @@
+serpent>=1.27
+msgpack>=0.5.2

tests/test_serialize.py

@@ -92,5 +92,11 @@ class TestJsonSerializer(TestSerpentSerializer):
     serializer = Pyro5.serializers.serializers["json"]
 
 
-class TestMsgpackSerializer(TestSerpentSerializer):
-    serializer = Pyro5.serializers.serializers["msgpack"]
+try:
+    import msgpack
+
+    class TestMsgpackSerializer(TestSerpentSerializer):
+        serializer = Pyro5.serializers.serializers["msgpack"]
+
+except ImportError:
+    pass

tox.ini

@@ -3,7 +3,7 @@ envlist=py35,py36,py37,py38,pypy3
 
 [testenv]
 deps=
-    -rrequirements.txt
+    -rtest-requirements.txt
     pytest
 setenv=
     PYTHONPATH={toxinidir}