docstrings

Author: miguelgrinberg

docs/api.rst

@@ -89,3 +89,13 @@ API Reference
 .. autoclass:: AsyncAioPikaManager
    :members:
    :inherited-members:
+
+.. autoclass:: socketio.packet.Packet
+   :members:
+   :inherited-members:
+   :no-undoc-members:
+
+.. autoclass:: socketio.msgpack_packet.MsgPackPacket
+   :members:
+   :inherited-members:
+   :no-undoc-members:

src/socketio/msgpack_packet.py

@@ -5,10 +5,22 @@
 class MsgPackPacket(packet.Packet):
     uses_binary_events = False
     dumps_default = None
-    ext_hook = msgpack.ExtType
+    ext_hook = msgpack.ExtType  #: :meta private:
 
     @classmethod
     def configure(cls, dumps_default=None, ext_hook=msgpack.ExtType):
+        """Change the default options for msgpack encoding and decoding.
+
+        :param dumps_default: a function called for objects that cannot be
+                              serialized by default msgpack. The function
+                              receives one argument, the object to serialize.
+                              It should return a serializable object or a
+                              ``msgpack.ExtType`` instance.
+        :param ext_hook: a function called when a ``msgpack.ExtType`` object is
+                         seen during decoding. The function receives two
+                         arguments, the code and the data. It should return the
+                         decoded object.
+        """
         class CustomMsgPackPacket(MsgPackPacket):
             dumps_default = None
             ext_hook = None

src/socketio/packet.py

@@ -20,7 +20,7 @@ class Packet:
     # data: JSON dump of data payload
 
     uses_binary_events = True
-    json = _json
+    json = _json  #: :meta private:
 
     def __init__(self, packet_type=EVENT, data=None, namespace=None, id=None,
                  binary=None, encoded_packet=None):