httpdbg 1.1.0__tar.gz → 1.1.2__tar.gz

{httpdbg-1.1.0 → httpdbg-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: httpdbg
-Version: 1.1.0
+Version: 1.1.2
 Summary: A very simple tool to debug HTTP(S) client and server requests.
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0
@@ -23,6 +23,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: license-file
 
 # httpdbg
 

{httpdbg-1.1.0 → httpdbg-1.1.2}/httpdbg/__init__.py

@@ -3,6 +3,6 @@ from httpdbg.hooks.all import httprecord
 from httpdbg.records import HTTPRecords
 
 
-__version__ = "1.1.0"
+__version__ = "1.1.2"
 
 __all__ = ["httprecord", "HTTPRecords"]

httpdbg-1.1.2/httpdbg/env.py

@@ -0,0 +1,4 @@
+HTTPDBG_MULTIPROCESS_DIR = "HTTPDBG_MULTIPROCESS_DIR"
+
+HTTPDBG_LOG_LEVEL = "HTTPDBG_LOG_LEVEL"
+HTTPDBG_LOG_PATH = "HTTPDBG_LOG_PATH"

{httpdbg-1.1.0 → httpdbg-1.1.2}/httpdbg/hooks/http.py

@@ -11,11 +11,17 @@ from httpdbg.records import HTTPRecords
 
 
 def set_hook_for_http_server_handle_one_request(records: HTTPRecords, method: Callable):
-    def hook(*args, **kwargs):
 
-        # the group label/full_label will be updated when the endpoint method will be called
-        with httpdbg_group(records, "one request", ""):
-            ret = method(*args, **kwargs)
+    def hook(self, *args, **kwargs):
+        from httpdbg.webapp.app import HttpbgHTTPRequestHandler
+
+        if isinstance(self, HttpbgHTTPRequestHandler):
+            # this request is for the httpdbg web server itself, we do not have to create a group
+            ret = method(self, *args, **kwargs)
+        else:
+            # the group label/full_label will be updated when the endpoint method will be called
+            with httpdbg_group(records, "one request", ""):
+                ret = method(self, *args, **kwargs)
 
         return ret
 

{httpdbg-1.1.0 → httpdbg-1.1.2}/httpdbg/hooks/pytest.py

@@ -12,13 +12,15 @@ from httpdbg.log import logger
 from httpdbg.records import HTTPRecords
 
 
-def set_hook_for_pytest_fixture(_: HTTPRecords, method: Callable):
+def set_hook_for_pytest_fixture(records: HTTPRecords, method: Callable):
     def hook(*args, **kwargs):
         logger().info("SET_HOOK_FOR_PYTEST_FIXTURE")
         callargs = getcallargs(method, *args, **kwargs)
 
         if "fixturefunc" in callargs:
-            with httpdbg_tag(getattr(callargs["fixturefunc"], "__name__", "fixture")):
+            with httpdbg_tag(
+                records, getattr(callargs["fixturefunc"], "__name__", "fixture")
+            ):
                 return method(*args, **kwargs)
         else:
             return method(*args, **kwargs)

{httpdbg-1.1.0 → httpdbg-1.1.2}/httpdbg/hooks/socket.py

@@ -217,7 +217,11 @@ def set_hook_for_socket_recv_into(records: HTTPRecords, method: Callable):
                             initiator.tbegin = tbegin
                             group.tbegin = tbegin
                         socketdata.record = HTTPRecord(
-                            tbegin=socketdata.tbegin, is_client=False
+                            records.current_initiator,
+                            records.current_group,
+                            records.current_tag,
+                            tbegin=socketdata.tbegin,
+                            is_client=False,
                         )
                         socketdata.record.address = socketdata.address
                         socketdata.record.ssl = socketdata.ssl
@@ -270,7 +274,11 @@ def set_hook_for_socket_recv(records: HTTPRecords, method: Callable):
                             initiator.tbegin = tbegin
                             group.tbegin = tbegin
                         socketdata.record = HTTPRecord(
-                            tbegin=socketdata.tbegin, is_client=False
+                            records.current_initiator,
+                            records.current_group,
+                            records.current_tag,
+                            tbegin=socketdata.tbegin,
+                            is_client=False,
                         )
                         socketdata.record.address = socketdata.address
                         socketdata.record.ssl = socketdata.ssl
@@ -320,7 +328,12 @@ def set_hook_for_socket_sendall(records: HTTPRecords, method: Callable):
                             )
                             initiator.tbegin = tbegin
                             group.tbegin = tbegin
-                        socketdata.record = HTTPRecord(tbegin=socketdata.tbegin)
+                        socketdata.record = HTTPRecord(
+                            records.current_initiator,
+                            records.current_group,
+                            records.current_tag,
+                            tbegin=socketdata.tbegin,
+                        )
                         socketdata.record.address = socketdata.address
                         socketdata.record.ssl = socketdata.ssl
                         socketdata.record.send_data(socketdata.rawdata)
@@ -371,7 +384,12 @@ def set_hook_for_socket_send(records: HTTPRecords, method: Callable):
                             )
                             initiator.tbegin = tbegin
                             group.tbegin = tbegin
-                        socketdata.record = HTTPRecord(tbegin=socketdata.tbegin)
+                        socketdata.record = HTTPRecord(
+                            records.current_initiator,
+                            records.current_group,
+                            records.current_tag,
+                            tbegin=socketdata.tbegin,
+                        )
                         socketdata.record.address = socketdata.address
                         socketdata.record.ssl = socketdata.ssl
                         socketdata.record.send_data(socketdata.rawdata)
@@ -446,7 +464,12 @@ def set_hook_for_sslobject_write(records: HTTPRecords, method: Callable):
                             )
                             initiator.tbegin = tbegin
                             group.tbegin = tbegin
-                        socketdata.record = HTTPRecord(tbegin=socketdata.tbegin)
+                        socketdata.record = HTTPRecord(
+                            records.current_initiator,
+                            records.current_group,
+                            records.current_tag,
+                            tbegin=socketdata.tbegin,
+                        )
                         socketdata.record.address = socketdata.address
                         socketdata.record.ssl = socketdata.ssl
                         socketdata.record.send_data(socketdata.rawdata)

{httpdbg-1.1.0 → httpdbg-1.1.2}/httpdbg/hooks/unittest.py

@@ -45,15 +45,15 @@ def set_hook_for_unittest_run(records: HTTPRecords, method: Callable):
     return hook
 
 
-def set_hook_for_unittest_fixture(_: HTTPRecords, method: Callable):
+def set_hook_for_unittest_fixture(records: HTTPRecords, method: Callable):
 
     def hook(*args, **kwargs):
 
         if getattr(method, "__name__") == "_callSetUp":
-            with httpdbg_tag("setUp"):
+            with httpdbg_tag(records, "setUp"):
                 return method(*args, **kwargs)
         elif getattr(method, "__name__") == "_callTearDown":
-            with httpdbg_tag("tearDown"):
+            with httpdbg_tag(records, "tearDown"):
                 return method(*args, **kwargs)
         else:
             return method(*args, **kwargs)

{httpdbg-1.1.0 → httpdbg-1.1.2}/httpdbg/initiator.py

@@ -15,9 +15,6 @@ from typing import TYPE_CHECKING
 if TYPE_CHECKING:
     from httpdbg.records import HTTPRecords
 
-from httpdbg.env import HTTPDBG_CURRENT_GROUP
-from httpdbg.env import HTTPDBG_CURRENT_INITIATOR
-from httpdbg.env import HTTPDBG_CURRENT_TAG
 from httpdbg.hooks.utils import getcallargs
 from httpdbg.utils import get_new_uuid
 from httpdbg.log import logger
@@ -244,26 +241,16 @@ def httpdbg_initiator(
     *args,
     **kwargs,
 ) -> Generator[Union[Tuple[Initiator, Group, bool], None], None, None]:
-    # An initiator is considered set if the environment variable exists and the initiator
-    # is recorded.If the environment variable exists but the initiatir is not recorded,
-    # it means httpdbg was called reentrantly, and we need to record the initiator again
-    # using the same id.
-    initiator_already_set = (HTTPDBG_CURRENT_INITIATOR in os.environ) and (
-        os.environ[HTTPDBG_CURRENT_INITIATOR] in records.initiators
-    )
-    try:
-        if not initiator_already_set:
-            original_initiator_id = None
-            if HTTPDBG_CURRENT_INITIATOR not in os.environ:
-                # temporary set a fake initiator env variable to avoid a recursion error
-                #  RecursionError: maximum recursion depth exceeded while calling a Python object
-                # TL;DR When we construct the short_stack string, a recursion error occurs if there
-                # is an object from a class where a hooked method is called in __repr__ or __str__.
-                os.environ[HTTPDBG_CURRENT_INITIATOR] = "blabla"
-            else:
-                original_initiator_id = os.environ[HTTPDBG_CURRENT_INITIATOR]
 
-            # in any case, we create an Initiator
+    try:
+        if records.current_initiator is None:
+            initiator_already_set = False
+
+            # temporary set a fake initiator env variable to avoid a recursion error
+            #  RecursionError: maximum recursion depth exceeded while calling a Python object
+            # TL;DR When we construct the short_stack string, a recursion error occurs if there
+            # is an object from a class where a hooked method is called in __repr__ or __str__.
+            records.current_initiator = "--fakeinitiator--"
             instruction, short_stack, stack = get_current_instruction(extracted_stack)
             short_stack += "----------\n" + construct_call_str(
                 original_method, *args, **kwargs
@@ -271,51 +258,48 @@ def httpdbg_initiator(
 
             current_initiator = Initiator(instruction, short_stack, stack)
 
-            if original_initiator_id:
-                # if we already have an initiator id (reentrant call) we change the initiator id
-                # to keep the same
-                current_initiator.id = original_initiator_id
-
-            records.initiators[current_initiator.id] = current_initiator
-
-            os.environ[HTTPDBG_CURRENT_INITIATOR] = current_initiator.id
-
+            records.add_initiator(current_initiator)
         else:
-            current_initiator = records.initiators[
-                os.environ[HTTPDBG_CURRENT_INITIATOR]
-            ]
+            initiator_already_set = True
+            if records.current_initiator != "--fakeinitiator--":
+                current_initiator = records.initiators[records.current_initiator]
+            else:
+                # this fake initiator does not need to be recorded
+                current_initiator = Initiator("", "", [])
 
         with httpdbg_group(
             records, current_initiator.label, current_initiator.short_stack
         ) as group:  # by default we group the requests by initiator
             yield current_initiator, group, initiator_already_set is False
     except Exception:
-        if (not initiator_already_set) and (HTTPDBG_CURRENT_INITIATOR in os.environ):
-            del os.environ[HTTPDBG_CURRENT_INITIATOR]
+        if not initiator_already_set:
+            records.current_initiator = None
         raise
 
-    if (not initiator_already_set) and (HTTPDBG_CURRENT_INITIATOR in os.environ):
-        del os.environ[HTTPDBG_CURRENT_INITIATOR]
+    if not initiator_already_set:
+        records.current_initiator = None
 
 
 @contextmanager
-def httpdbg_tag(tag: str) -> Generator[None, None, None]:
-
-    tag_already_set = HTTPDBG_CURRENT_TAG in os.environ
+def httpdbg_tag(records: "HTTPRecords", tag: str) -> Generator[None, None, None]:
 
-    if not tag_already_set:
-        os.environ[HTTPDBG_CURRENT_TAG] = tag
+    if records.current_tag is None:
+        tag_already_set = False
+        logger().info("httpdbg_tag (new)")
+        records.current_tag = tag
+    else:
+        tag_already_set = True
 
     try:
         logger().info(f"httpdbg_tag {tag}")
         yield
     except Exception:
-        if (not tag_already_set) and (HTTPDBG_CURRENT_TAG in os.environ):
-            del os.environ[HTTPDBG_CURRENT_TAG]
+        if not tag_already_set:
+            records.current_tag = None
         raise
 
-    if (not tag_already_set) and (HTTPDBG_CURRENT_TAG in os.environ):
-        del os.environ[HTTPDBG_CURRENT_TAG]
+    if not tag_already_set:
+        records.current_tag = None
 
 
 @contextmanager
@@ -327,25 +311,14 @@ def httpdbg_group(
     updatable: bool = True,
 ) -> Generator[Group, None, None]:
 
-    # A group is considered set if the environment variable exists and the group
-    # is recorded.If the environment variable exists but the group is not recorded,
-    # it means httpdbg was called reentrantly, and we need to record the group again
-    # using the same id.
-    group_already_set = (HTTPDBG_CURRENT_GROUP in os.environ) and (
-        os.environ[HTTPDBG_CURRENT_GROUP] in records.groups
-    )
-
-    if not group_already_set:
+    if records.current_group is None:
+        group_already_set = False
         logger().info("httpdbg_group (new)")
         group = Group(label, full_label, updatable=updatable)
-        # in case of a reentrant call to httpdbg, we force the group id to be the same
-        if HTTPDBG_CURRENT_GROUP in os.environ:
-            group.id = os.environ[HTTPDBG_CURRENT_GROUP]
-            logger().info("httpdbg_group (reentrant) keep id {group.id}")
-        records.groups[group.id] = group
-        os.environ[HTTPDBG_CURRENT_GROUP] = group.id
+        records.add_group(group)
     else:
-        group = records.groups[os.environ[HTTPDBG_CURRENT_GROUP]]
+        group_already_set = True
+        group = records.groups[records.current_group]
 
     if update and group.updatable:
         # Update the label and full_label of an existing group, in case of endpoint.
@@ -353,16 +326,16 @@ def httpdbg_group(
         group.full_label = full_label
     try:
         logger().info(
-            f"httpdbg_group {group} group_id={os.environ[HTTPDBG_CURRENT_GROUP]} label={label} full_label={full_label}"
+            f"httpdbg_group {group} group_id={records.current_group} label={label} full_label={full_label}"
         )
         yield group
     except Exception:
-        if (not group_already_set) and (HTTPDBG_CURRENT_GROUP in os.environ):
-            del os.environ[HTTPDBG_CURRENT_GROUP]
+        if not group_already_set:
+            records.current_group = None
         raise
 
-    if (not group_already_set) and (HTTPDBG_CURRENT_GROUP in os.environ):
-        del os.environ[HTTPDBG_CURRENT_GROUP]
+    if not group_already_set:
+        records.current_group = None
 
 
 @contextmanager

{httpdbg-1.1.0 → httpdbg-1.1.2}/httpdbg/records.py

@@ -2,16 +2,12 @@
 import asyncio
 import asyncio.proactor_events
 import datetime
-import os
 import socket
 import ssl
 import sys
 from urllib.parse import urlparse
 from typing import Dict, List, Tuple, Union
 
-from httpdbg.env import HTTPDBG_CURRENT_GROUP
-from httpdbg.env import HTTPDBG_CURRENT_INITIATOR
-from httpdbg.env import HTTPDBG_CURRENT_TAG
 from httpdbg.utils import HTTPDBGCookie
 from httpdbg.utils import HTTPDBGHeader
 from httpdbg.initiator import Group
@@ -212,21 +208,24 @@ class HTTPRecordResponse(HTTPRecordReqResp):
 
 class HTTPRecord:
     def __init__(
-        self, tbegin: datetime.datetime = None, is_client: bool = True
+        self,
+        initiator_id: str = None,
+        group_id: str = None,
+        tag: str = None,
+        tbegin: datetime.datetime = None,
+        is_client: bool = True,
     ) -> None:
         self.id = get_new_uuid()
         self.address: Tuple[str, int] = ("", 0)
         self._url: Union[str, None] = None
-        self.initiator_id: Union[str, None] = os.environ.get(
-            f"{HTTPDBG_CURRENT_INITIATOR}"
-        )
+        self.initiator_id: Union[str, None] = initiator_id
         self.exception: Union[Exception, None] = None
         self.request: HTTPRecordRequest = HTTPRecordRequest()
         self.response: HTTPRecordResponse = HTTPRecordResponse()
         self.ssl: Union[bool, None] = None
         self.tbegin: datetime.datetime = datetime.datetime.now(datetime.timezone.utc)
-        self.tag: Union[str, None] = os.environ.get(HTTPDBG_CURRENT_TAG)
-        self.group_id: Union[str, None] = os.environ.get(HTTPDBG_CURRENT_GROUP)
+        self.tag: Union[str, None] = tag
+        self.group_id: Union[str, None] = group_id
         self.is_client: bool = is_client
         if tbegin:
             self.tbegin = tbegin
@@ -337,7 +336,10 @@ class HTTPRecords:
         self.requests: Dict[str, HTTPRecord] = {}
         self.requests_already_loaded = 0
         self.initiators: Dict[str, Initiator] = {}
+        self.current_initiator: Union[str, None] = None
         self.groups: Dict[str, Group] = {}
+        self.current_group: Union[str, None] = None
+        self.current_tag: Union[str, None] = None
         self._sockets: Dict[int, SocketRawData] = {}
 
     @property
@@ -443,3 +445,11 @@ class HTTPRecords:
         new_record.exception = exception
         self.requests[new_record.id] = new_record
         return new_record
+
+    def add_initiator(self, initiator: Initiator):
+        self.initiators[initiator.id] = initiator
+        self.current_initiator = initiator.id
+
+    def add_group(self, group: Group):
+        self.groups[group.id] = group
+        self.current_group = group.id

{httpdbg-1.1.0 → httpdbg-1.1.2}/httpdbg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: httpdbg
-Version: 1.1.0
+Version: 1.1.2
 Summary: A very simple tool to debug HTTP(S) client and server requests.
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0
@@ -23,6 +23,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: license-file
 
 # httpdbg
 

httpdbg-1.1.0/httpdbg/env.py

@@ -1,7 +0,0 @@
-HTTPDBG_CURRENT_GROUP = "HTTPDBG_CURRENT_GROUP"
-HTTPDBG_CURRENT_INITIATOR = "HTTPDBG_CURRENT_INITIATOR"
-HTTPDBG_CURRENT_TAG = "HTTPDBG_CURRENT_TAG"
-HTTPDBG_MULTIPROCESS_DIR = "HTTPDBG_MULTIPROCESS_DIR"
-
-HTTPDBG_LOG_LEVEL = "HTTPDBG_LOG_LEVEL"
-HTTPDBG_LOG_PATH = "HTTPDBG_LOG_PATH"