Rework requests Mixin and Session

Author: Fabio Todaro

nephthys/clients/requests_session.py renamed to nephthys/clients/requests.py

@@ -1,7 +1,7 @@
 import logging
 from datetime import datetime
 from urllib.parse import parse_qs, urlparse
-from requests.sessions import Session
+from requests.sessions import Session as RequestsSession
 
 from nephthys import FilterLoggerAdapter, RequestLogRecord, Log
 from nephthys.filters.requests import BodyTypeFilter
@@ -78,7 +78,7 @@ class NephthysMixin:
 
     _logger = None
 
-    def init_nephthys_logger(self, log_tag, log_filters):
+    def __init__(self, log_tag=None, log_filters=None, *args, **kwargs):
         """
         :param log_tag: The tag that will identify logs from this Session
         :type log_tag: string
@@ -93,6 +93,7 @@ def init_nephthys_logger(self, log_tag, log_filters):
         self._logger = FilterLoggerAdapter(
             logger=logger, filters=_log_filters, extra_tags=[log_tag]
         )
+        super().__init__(*args, **kwargs)
 
     @catch_logger_exception
     def _send_log_record(
@@ -121,28 +122,6 @@ def _send_log_record(
         else:
             self._logger.info(Log(log_rec))
 
-
-class NephthysSession(Session, NephthysMixin):
-    """
-    Provides a requests.session.Session overriding .send() method so that it logs
-    each request with an instance of nephthys.FilterLoggerAdapter.
-
-    This class can be used as a concrete implementation of requests.session.Session
-    in an existing project.
-    If said project already uses a custom implementation of Session, this class can
-    be used as an example of how to add NephthysMixin to it.
-    """
-
-    def __init__(self, log_tag=None, log_filters=None):
-        """
-        :param log_tag: The tag that will identify logs from this Session
-        :type log_tag: string
-        :param log_filters: List of additional IRequestFilter
-        :type log_filters: list
-        """
-        super().__init__()
-        self.init_nephthys_logger(log_tag, log_filters)
-
     def send(self, request, **kwargs):
         start_time = datetime.utcnow().timestamp()
 
@@ -165,3 +144,10 @@ def send(self, request, **kwargs):
         )
 
         return response
+
+
+class Session(NephthysMixin, RequestsSession):
+    """
+    Provides a requests.session.Session with Nephthys Logging.
+    """
+    pass

setup.py

@@ -14,7 +14,7 @@ def make_long_description():
     description="Advanced Python Logger",
     long_description=make_long_description(),
     long_description_content_type="text/markdown",
-    version="0.4.0",
+    version="0.5.0",
     author="Fabio Todaro",
     license="MIT",
     author_email="ft@ovalmoney.com",

tests/test_clients/test_requests_session.py renamed to tests/test_clients/test_requests.py

@@ -8,11 +8,11 @@
 import pytest
 import requests
 
-from nephthys.clients.requests_session import (
+from nephthys.clients.requests import (
     catch_logger_exception,
     decorate_log_request,
     decorate_log_response,
-    NephthysSession)
+    Session)
 from nephthys.filters.requests import BODY_NOT_LOGGABLE
 
 
@@ -127,7 +127,7 @@ def test_send_log_record(caplog, m):
     caplog.set_level(logging.INFO)
     m.get("https://ovalmoney.com/user", status_code=200)
 
-    s = NephthysSession()
+    s = Session()
     s._logger.info = MagicMock()
     s.get("https://ovalmoney.com/user")
 
@@ -138,7 +138,7 @@ def test_send_log_record_exception(caplog, m):
     caplog.set_level(logging.INFO)
     m.get("https://ovalmoney.com/user", exc=requests.exceptions.ConnectTimeout)
 
-    s = NephthysSession()
+    s = Session()
     s._logger.exception = MagicMock()
     with pytest.raises(requests.exceptions.ConnectTimeout):
         s.get("https://ovalmoney.com/user")
@@ -154,7 +154,7 @@ def test_raw_data_reponse_log(caplog, m):
         content=b"\xFF\x8F",
     )
 
-    s = NephthysSession()
+    s = Session()
     s.get("https://ovalmoney.com/raw_data")
 
     log_rec = [rec for rec in caplog.records][0]
@@ -168,7 +168,7 @@ def test_raw_data_request_log(caplog, m):
     caplog.set_level(logging.INFO)
     m.post("https://ovalmoney.com/raw_data")
 
-    s = NephthysSession()
+    s = Session()
     s.post("https://ovalmoney.com/raw_data", headers={"Content-Type": "video"}, data=b"\xFF\x8F")
 
     log_rec = [rec for rec in caplog.records][0]
@@ -181,7 +181,7 @@ def test_raw_data_request_log(caplog, m):
 def test_session_fail_http(m):
     m.get("https://ovalmoney.com/user", exc=requests.exceptions.ConnectTimeout)
 
-    s = NephthysSession()
+    s = Session()
     with pytest.raises(requests.exceptions.ConnectTimeout):
         s.get("https://ovalmoney.com/user")
 
@@ -190,7 +190,7 @@ def test_session_fail_http_log(caplog, m):
     caplog.set_level(logging.INFO)
     m.get("https://ovalmoney.com/user", exc=requests.exceptions.ConnectTimeout)
 
-    s = NephthysSession()
+    s = Session()
     with pytest.raises(requests.exceptions.ConnectTimeout):
         s.get("https://ovalmoney.com/user")
 
@@ -213,7 +213,7 @@ def test_session_success(caplog, m):
         status_code=200,
     )
 
-    s = NephthysSession()
+    s = Session()
     response = s.get("https://ovalmoney.com/user", params={"key1": "value1", "key2": ["value2", "value3"]})
 
     assert response.headers
@@ -231,7 +231,7 @@ def test_session_success_log(caplog, m):
     )
 
     with freeze_time(datetime.utcnow()):
-        s = NephthysSession(log_tag="test")
+        s = Session(log_tag="test")
         s.get("https://ovalmoney.com/user", params={"key1": "value1", "key2": ["value2", "value3"]})
         now = datetime.utcnow().timestamp()