feat(transport): add kwargs updater to the transport

Fix: #15

Author: piraz

peasant/client/transport.py

@@ -15,10 +15,10 @@
 from __future__ import annotations
 
 import logging
-import typing
+import typing as t
 from urllib.parse import urlencode, urlparse
 
-if typing.TYPE_CHECKING:
+if t.TYPE_CHECKING:
     from peasant.client.protocol import Peasant
 
 logger = logging.getLogger(__name__)
@@ -66,8 +66,17 @@ def fix_address(address):
 
 class Transport:
 
+    _kwargs_updater: t.Callable = None
     _peasant: Peasant
 
+    @property
+    def kwargs_updater(self) -> t.Callable:
+        return self._kwargs_updater
+
+    @kwargs_updater.setter
+    def kwargs_updater(self, callable: t.Callable):
+        self._kwargs_updater = callable
+
     @property
     def peasant(self) -> Peasant:
         return self._peasant
@@ -114,3 +123,8 @@ def new_nonce(self):
 
     def is_registered(self):
         raise NotImplementedError
+
+    def update_kwargs(self, method, **kwargs):
+        if self.kwargs_updater is None:
+            return kwargs
+        return self.kwargs_updater(method, **kwargs)

peasant/client/transport_requests.py

@@ -15,7 +15,9 @@
 import copy
 import logging
 from peasant import get_version
-from peasant.client.transport import Transport
+from peasant.client.transport import (METHOD_DELETE, METHOD_GET, METHOD_HEAD,
+                                      METHOD_OPTIONS, METHOD_PATCH,
+                                      METHOD_POST, METHOD_PUT, Transport)
 
 logger = logging.getLogger(__name__)
 
@@ -58,6 +60,11 @@ def get_headers(self, **kwargs):
             headers.update(_headers)
         return headers
 
+    def update_kwargs(self, method, **kwargs):
+        if self.kwargs_updater is None:
+            return kwargs
+        return self.kwargs_updater(method, **kwargs)
+
     def delete(self, path: str, **kwargs):
         """ Sends a delete method with basic headers.
 
@@ -67,6 +74,7 @@ def delete(self, path: str, **kwargs):
         :return: :class:`requests.Response <Response>` object
         :rtype: requests.Response
         """
+        self.update_kwargs("DELETE", **kwargs)
         url = self.get_url(path, **kwargs)
         headers = self.get_headers(**kwargs)
         kwargs['headers'] = headers
@@ -83,6 +91,7 @@ def get(self, path, **kwargs):
         :return: :class:`requests.Response <Response>` object
         :rtype: requests.Response
         """
+        self.update_kwargs(METHOD_GET, **kwargs)
         url = self.get_url(path, **kwargs)
         headers = self.get_headers(**kwargs)
         kwargs['headers'] = headers
@@ -99,6 +108,7 @@ def head(self, path, **kwargs):
         :return: :class:`requests.Response <Response>` object
         :rtype: requests.Response
         """
+        self.update_kwargs(METHOD_HEAD, **kwargs)
         url = self.get_url(path, **kwargs)
         headers = self.get_headers(**kwargs)
         kwargs['headers'] = headers
@@ -115,6 +125,7 @@ def options(self, path, **kwargs):
         :return: :class:`requests.Response <Response>` object
         :rtype: requests.Response
         """
+        self.update_kwargs(METHOD_OPTIONS, **kwargs)
         url = self.get_url(path, **kwargs)
         headers = self.get_headers(**kwargs)
         kwargs['headers'] = headers
@@ -131,6 +142,7 @@ def patch(self, path, **kwargs):
         :return: :class:`requests.Response <Response>` object
         :rtype: requests.Response
         """
+        self.update_kwargs(METHOD_PATCH, **kwargs)
         url = self.get_url(path, **kwargs)
         headers = self.get_headers(**kwargs)
         kwargs['headers'] = headers
@@ -147,6 +159,7 @@ def post(self, path, **kwargs):
         :return: :class:`requests.Response <Response>` object
         :rtype: requests.Response
         """
+        self.update_kwargs(METHOD_POST, **kwargs)
         url = self.get_url(path, **kwargs)
         headers = self.get_headers(**kwargs)
         kwargs['headers'] = headers
@@ -163,6 +176,7 @@ def put(self, path, **kwargs):
         :return: :class:`requests.Response <Response>` object
         :rtype: requests.Response
         """
+        self.update_kwargs(METHOD_PUT, **kwargs)
         url = self.get_url(path, **kwargs)
         headers = self.get_headers(**kwargs)
         kwargs['headers'] = headers

tests/transport_test.py

@@ -12,7 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from peasant.client.transport import concat_url, fix_address
+from peasant.client.transport import (concat_url, fix_address, METHOD_POST,
+                                      Transport)
 from unittest import TestCase
 
 
@@ -75,3 +76,16 @@ def test_fix_address(self):
         expected_address = "http://localhost/a/path"
         fixed_address = fix_address(address)
         self.assertEqual(expected_address, fixed_address)
+
+    def test_kwargs_updater(self):
+        transport = Transport()
+
+        def kwargs_updater(method, **kwargs):
+            kwargs['test'] = method
+            return kwargs
+
+        kwargs = {}
+        transport.kwargs_updater = kwargs_updater
+        kwargs = transport.update_kwargs(METHOD_POST, **kwargs)
+        self.assertTrue("test" in kwargs)
+        self.assertEqual(METHOD_POST, kwargs['test'])