changelog update. allow different names for composite metadata routed method argument. add Payload class to documentation

Author: jell-o-fishi

CHANGELOG.rst

@@ -5,15 +5,18 @@ v0.4.6
 ======
 - fire_and_forget now only removes the stream id when the future denoting the frame was sent, is done
 - API documentation auto generated at rsocket.readthedocs.io
-- Raise error on empty or None route specified in request router
-- Added the following methods to RequestRouter to allow specifying handlers of unknown routes:
-    - response_unknown
-    - stream_unknown
-    - channel_unknown
-    - fire_and_forget_unknown
-    - metadata_push_unknown
-- Officially support route aliases by using the decorator multiple times on the same method
-- Fix value mapping in request router. A parameter of any name (not just *payload*) specified on a routed method with a type-hint other than Payload will use the payload_mapper specified in the router instantiation to decode the value.
+- Request router changes:
+    - Raise error on empty or None route specified in request router
+    - Added the following methods to RequestRouter to allow specifying handlers of unknown routes:
+        - response_unknown
+        - stream_unknown
+        - channel_unknown
+        - fire_and_forget_unknown
+        - metadata_push_unknown
+    - Officially support route aliases by using the decorator multiple times on the same method
+    - Fix value mapping in request router:
+        -A parameter of any name (not just *payload*) specified on a routed method with a type-hint other than Payload will use the payload_mapper to decode the value
+        - Any parameter with the type CompositeMetadata will receive the composite metadata
 
 v0.4.5
 ======

docs/api.rst

@@ -1,27 +1,37 @@
 Core API Reference
 ==================
 
+Controls
+--------
+
 Server
-------
+~~~~~~
 
 .. automodule:: rsocket.rsocket_server
     :members:
     :inherited-members:
 
 Client
-------
+~~~~~~
 
 .. automodule:: rsocket.rsocket_client
     :members:
     :inherited-members:
 
 Handler
--------
+~~~~~~~
 
 .. automodule:: rsocket.request_handler
     :members:
 
 
+Models
+------
+
+.. automodule:: rsocket.payload
+    :members:
+
+
 Interfaces
 ----------
 

docs/quickstart.rst

@@ -4,5 +4,4 @@ Quick start
 .. autosummary::
    :toctree: generated
 
-
 A quick getting started guide is available at https://rsocket.io/guides/rsocket-py/simple

rsocket/payload.py

@@ -5,6 +5,13 @@
 
 
 class Payload:
+    """
+    A stream message (upstream or downstream). Contains data and metadata, boty `bytes`.
+
+    :param data: data segment of payload
+    :param metadata: metadata segment of payload
+    """
+
     __slots__ = ('data', 'metadata')
 
     @staticmethod

rsocket/routing/request_router.py

@@ -151,7 +151,7 @@ def _collect_route_arguments(self, route_processor, payload, composite_metadata)
         for parameter in route_signature.parameters:
             parameter_type = route_signature.parameters[parameter]
 
-            if 'composite_metadata' == parameter:
+            if 'composite_metadata' == parameter or parameter_type is CompositeMetadata:
                 route_kwargs['composite_metadata'] = composite_metadata
             else:
                 if parameter_type.annotation not in (Payload, parameter_type.empty):