httpdbg 0.28.2__tar.gz → 0.28.3__tar.gz

{httpdbg-0.28.2 → httpdbg-0.28.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.28.2
+Version: 0.28.3
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0

{httpdbg-0.28.2 → httpdbg-0.28.3}/httpdbg/__init__.py

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

{httpdbg-0.28.2 → httpdbg-0.28.3}/httpdbg/hooks/aiohttp.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from collections.abc import Callable
 from contextlib import contextmanager
 import traceback
 from typing import Generator
@@ -7,11 +8,10 @@ from httpdbg.hooks.utils import getcallargs
 from httpdbg.hooks.utils import decorate
 from httpdbg.hooks.utils import undecorate
 from httpdbg.initiator import httpdbg_initiator
-from httpdbg.records import HTTPRecord
 from httpdbg.records import HTTPRecords
 
 
-def set_hook_for_aiohttp_async(records, method):
+def set_hook_for_aiohttp_async(records: HTTPRecords, method: Callable):
     async def hook(*args, **kwargs):
         initiator = None
         try:
@@ -25,13 +25,9 @@ def set_hook_for_aiohttp_async(records, method):
 
             if "str_or_url" in callargs:
                 if initiator:
-                    record = HTTPRecord()
-
-                    record.initiator = initiator
-                    record.url = str(callargs["str_or_url"])
-                    record.exception = ex
-
-                    records.requests[record.id] = record
+                    records.add_new_record_exception(
+                        initiator, str(callargs["str_or_url"]), ex
+                    )
             raise
 
     return hook

{httpdbg-0.28.2 → httpdbg-0.28.3}/httpdbg/hooks/httpx.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from collections.abc import Callable
 from contextlib import contextmanager
 import traceback
 from typing import Generator
@@ -7,11 +8,10 @@ from httpdbg.hooks.utils import getcallargs
 from httpdbg.hooks.utils import decorate
 from httpdbg.hooks.utils import undecorate
 from httpdbg.initiator import httpdbg_initiator
-from httpdbg.records import HTTPRecord
 from httpdbg.records import HTTPRecords
 
 
-def set_hook_for_httpx_async(records, method):
+def set_hook_for_httpx_async(records: HTTPRecords, method: Callable):
     async def hook(*args, **kwargs):
         initiator = None
         try:
@@ -25,19 +25,15 @@ def set_hook_for_httpx_async(records, method):
 
             if "url" in callargs:
                 if initiator:
-                    record = HTTPRecord()
-
-                    record.initiator = initiator
-                    record.url = str(callargs["url"])
-                    record.exception = ex
-
-                    records.requests[record.id] = record
+                    records.add_new_record_exception(
+                        initiator, str(callargs["url"]), ex
+                    )
             raise
 
     return hook
 
 
-def set_hook_for_httpx(records, method):
+def set_hook_for_httpx(records: HTTPRecords, method: Callable):
     def hook(*args, **kwargs):
         initiator = None
         try:
@@ -51,13 +47,9 @@ def set_hook_for_httpx(records, method):
 
             if "url" in callargs:
                 if initiator:
-                    record = HTTPRecord()
-
-                    record.initiator = initiator
-                    record.url = str(callargs["url"])
-                    record.exception = ex
-
-                    records.requests[record.id] = record
+                    records.add_new_record_exception(
+                        initiator, str(callargs["url"]), ex
+                    )
             raise
 
     return hook

{httpdbg-0.28.2 → httpdbg-0.28.3}/httpdbg/hooks/requests.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from collections.abc import Callable
 from contextlib import contextmanager
 import traceback
 from typing import Generator
@@ -7,11 +8,10 @@ from httpdbg.hooks.utils import getcallargs
 from httpdbg.hooks.utils import decorate
 from httpdbg.hooks.utils import undecorate
 from httpdbg.initiator import httpdbg_initiator
-from httpdbg.records import HTTPRecord
 from httpdbg.records import HTTPRecords
 
 
-def set_hook_for_requests(records, method):
+def set_hook_for_requests(records: HTTPRecords, method: Callable):
     def hook(*args, **kwargs):
         initiator = None
         try:
@@ -25,13 +25,9 @@ def set_hook_for_requests(records, method):
 
             if "url" in callargs:
                 if initiator:
-                    record = HTTPRecord()
-
-                    record.initiator = initiator
-                    record.url = str(callargs["url"])
-                    record.exception = ex
-
-                    records.requests[record.id] = record
+                    records.add_new_record_exception(
+                        initiator, str(callargs["url"]), ex
+                    )
             raise
 
     return hook

{httpdbg-0.28.2 → httpdbg-0.28.3}/httpdbg/hooks/socket.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 import asyncio
 import asyncio.proactor_events
+from collections.abc import Callable
 from contextlib import contextmanager
 import platform
 import socket
@@ -16,7 +17,10 @@ from httpdbg.records import HTTPRecords
 from httpdbg.log import logger
 
 
-def set_hook_for_socket_init(records, method):
+# hook: socket.socket.__init__
+# what: A new socket object is created.
+# action: If an entry exists in the temporary raw socket storage list, it is removed.
+def set_hook_for_socket_init(records: HTTPRecords, method: Callable):
     def hook(self, *args, **kwargs):
         records.del_socket_data(self)
 
@@ -25,27 +29,24 @@ def set_hook_for_socket_init(records, method):
     return hook
 
 
-def set_hook_for_socket_connect(records, method):
+# hook: socket.socket.connect, ssl.SSLSocket.connect
+# what: A connection to a remote socket is initiated.
+# action: A new entry is added to the temporary raw socket storage list.
+def set_hook_for_socket_connect(records: HTTPRecords, method: Callable):
     def hook(self, address):
         socketdata = records.get_socket_data(self, force_new=True)
         if socketdata:
             logger().info(
                 f"CONNECT - self={self} id={id(self)} socketdata={socketdata} address={address}"
             )
-
         try:
             r = method(self, address)
         except Exception as ex:
             if not isinstance(
                 ex, (BlockingIOError, OSError)
             ):  # BlockingIOError for async, OSError for ipv6
-                record = HTTPRecord()
-                record.initiator = records.get_initiator()
-
-                record.exception = ex
-
-                records.requests[record.id] = record
-
+                initiator = records.get_initiator()
+                records.add_new_record_exception(initiator, "", ex)
             raise
 
         return r
@@ -53,18 +54,17 @@ def set_hook_for_socket_connect(records, method):
     return hook
 
 
-def set_hook_for_ssl_wrap_socket(records, method):
+# hook: ssl.wrap_socket,
+# what: Takes an instance sock of socket.socket, and returns an instance of ssl.SSLSocket.
+# a subtype of socket.socket, which wraps the underlying socket in an SSL context.
+# action: Link the socket and the sslsocket
+def set_hook_for_ssl_wrap_socket(records: HTTPRecords, method: Callable):
     def hook(sock, *args, **kwargs):
         try:
             sslsocket = method(sock, *args, **kwargs)
         except Exception as ex:
-            record = HTTPRecord()
-
-            record.initiator = records.get_initiator()
-            record.exception = ex
-
-            records.requests[record.id] = record
-
+            initiator = records.get_initiator()
+            records.add_new_record_exception(initiator, "", ex)
             raise
 
         logger().info(
@@ -80,18 +80,16 @@ def set_hook_for_ssl_wrap_socket(records, method):
     return hook
 
 
-def set_hook_for_sslcontext_wrap_socket(records, method):
+# hook: ssl.SSLContext.wrap_socket
+# what: Wrap an existing Python socket sock and return an instance of SSLContext.sslsocket_class (default SSLSocket).
+# action: Link the socket and the sslsocket
+def set_hook_for_sslcontext_wrap_socket(records: HTTPRecords, method: Callable):
     def hook(self, sock, *args, **kwargs):
         try:
             sslsocket = method(self, sock, *args, **kwargs)
         except Exception as ex:
-            record = HTTPRecord()
-
-            record.initiator = records.get_initiator()
-            record.exception = ex
-
-            records.requests[record.id] = record
-
+            initiator = records.get_initiator()
+            records.add_new_record_exception(initiator, "", ex)
             raise
 
         logger().info(
@@ -107,18 +105,16 @@ def set_hook_for_sslcontext_wrap_socket(records, method):
     return hook
 
 
-def set_hook_for_socket_wrap_bio(records, method):
+# hook: ssl.SSLContext.wrap_bio
+# what: Wrap the BIO objects incoming and outgoing and return an instance of SSLContext.sslobject_class (default SSLObject).
+# action: Record a new SocketRawData if necessary
+def set_hook_for_socket_wrap_bio(records: HTTPRecords, method: Callable):
     def hook(self, *args, **kwargs):
         try:
             sslobject = method(self, *args, **kwargs)
         except Exception as ex:
-            record = HTTPRecord()
-            record.initiator = records.get_initiator()
-
-            record.exception = ex
-
-            records.requests[record.id] = record
-
+            initiator = records.get_initiator()
+            records.add_new_record_exception(initiator, "", ex)
             raise
 
         logger().info(
@@ -134,7 +130,10 @@ def set_hook_for_socket_wrap_bio(records, method):
     return hook
 
 
-def set_hook_for_socket_recv_into(records, method):
+# hook: socket.socket.recv_into, ssl.SSLSocket.recv_into, asyncio.proactor_events._ProactorReadPipeTransport._data_received
+# what: Receive up to nbytes bytes from the socket, storing the data into a buffer rather than creating a new bytestring.
+# action: Append the data to an existing SocketRawData
+def set_hook_for_socket_recv_into(records: HTTPRecords, method: Callable):
     def hook(self, buffer, *args, **kwargs):
         socketdata = records.get_socket_data(self)
         if socketdata:
@@ -160,7 +159,10 @@ def set_hook_for_socket_recv_into(records, method):
     return hook
 
 
-def set_hook_for_socket_recv(records, method):
+# hook: socket.socket.recv, ssl.SSLSocket.recv
+# what: Receive data from the socket. The return value is a bytes object representing the data received.
+# action: Append the data to an existing SocketRawData
+def set_hook_for_socket_recv(records: HTTPRecords, method: Callable):
     def hook(self, bufsize, *args, **kwargs):
         socketdata = records.get_socket_data(self)
         if socketdata:
@@ -183,7 +185,11 @@ def set_hook_for_socket_recv(records, method):
     return hook
 
 
-def set_hook_for_socket_sendall(records, method):
+# hook: socket.socket.sendall
+# what: Send data to the socket.
+# action: Append the data to an existing SocketRawData. Check if this is an HTTP request.
+# and record it if this is case, otherwise delete the temporay SocketRawData.
+def set_hook_for_socket_sendall(records: HTTPRecords, method: Callable):
     def hook(self, bytes, *args, **kwargs):
         socketdata = records.get_socket_data(self, request=True)
         if socketdata:
@@ -218,7 +224,11 @@ def set_hook_for_socket_sendall(records, method):
     return hook
 
 
-def set_hook_for_socket_send(records, method):
+# hook: socket.socket.send, ssl.SSLSocket.send, asyncio.proactor_events._ProactorBaseWritePipeTransport.write
+# what: Send data to the socket.
+# action: Append the data to an existing SocketRawData. Check if this is an HTTP request.
+# and record it if this is case, otherwise delete the temporay SocketRawData.
+def set_hook_for_socket_send(records: HTTPRecords, method: Callable):
     def hook(self, bytes, *args, **kwargs):
         socketdata = records.get_socket_data(self, request=True)
         if socketdata:
@@ -253,7 +263,10 @@ def set_hook_for_socket_send(records, method):
     return hook
 
 
-def set_hook_for_asyncio_create_connection(records, method):
+# hook: asyncio.BaseEventLoop.create_connection
+# what: Open a streaming transport connection to a given address specified by host and port.
+# action: Link the socket and the sslsocket
+def set_hook_for_asyncio_create_connection(records: HTTPRecords, method: Callable):
     async def hook(self, *args, **kwargs):
         logger().info(
             f"CREATE_CONNECTION - self={self} id={id(self)} args={args} kwargs={kwargs}"
@@ -276,7 +289,11 @@ def set_hook_for_asyncio_create_connection(records, method):
     return hook
 
 
-def set_hook_for_sslobject_write(records, method):
+# hook: ssl.SSLObject.write
+# what: Write buf to the SSL socket and return the number of bytes written.
+# action: Append the data to an existing SocketRawData. Check if this is an HTTP request.
+# and record it if this is case, otherwise delete the temporay SocketRawData.
+def set_hook_for_sslobject_write(records: HTTPRecords, method: Callable):
     def hook(self, buf, *args, **kwargs):
         logger().info(f"WRITE - {type(self)}={id(self)} buf={(b'' + buf)[:20]}")
         socketdata = records.get_socket_data(self, request=True)
@@ -310,7 +327,10 @@ def set_hook_for_sslobject_write(records, method):
     return hook
 
 
-def set_hook_for_sslobject_read(records, method):
+# hook: ssl.SSLObject.read
+# what: Read up to len bytes of data from the SSL socket and return the result as a bytes instance.
+# action: Append the data to an existing SocketRawData.
+def set_hook_for_sslobject_read(records: HTTPRecords, method: Callable):
     def hook(self, *args, **kwargs):
         logger().info(f"READ - {type(self)}={id(self)}")
         socketdata = records.get_socket_data(self)

{httpdbg-0.28.2 → httpdbg-0.28.3}/httpdbg/hooks/urllib3.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from collections.abc import Callable
 from contextlib import contextmanager
 import traceback
 from typing import Generator
@@ -7,11 +8,10 @@ from httpdbg.hooks.utils import getcallargs
 from httpdbg.hooks.utils import decorate
 from httpdbg.hooks.utils import undecorate
 from httpdbg.initiator import httpdbg_initiator
-from httpdbg.records import HTTPRecord
 from httpdbg.records import HTTPRecords
 
 
-def set_hook_for_urllib3(records, method):
+def set_hook_for_urllib3(records: HTTPRecords, method: Callable):
     def hook(*args, **kwargs):
         initiator = None
         try:
@@ -25,13 +25,9 @@ def set_hook_for_urllib3(records, method):
 
             if "url" in callargs:
                 if initiator:
-                    record = HTTPRecord()
-
-                    record.initiator = initiator
-                    record.url = str(callargs["url"])
-                    record.exception = ex
-
-                    records.requests[record.id] = record
+                    records.add_new_record_exception(
+                        initiator, str(callargs["url"]), ex
+                    )
             raise
 
     return hook

{httpdbg-0.28.2 → httpdbg-0.28.3}/httpdbg/records.py

@@ -24,6 +24,8 @@ from httpdbg.log import logger
 
 
 class SocketRawData(object):
+    """Store the request data without encryption, even when using an SSLSocket."""
+
     def __init__(self, id: int, address: Tuple[str, int], ssl: bool) -> None:
         self.id: int = id
         self.address: Tuple[str, int] = address
@@ -343,6 +345,7 @@ class HTTPRecords:
     def get_socket_data(
         self, obj, extra_sock=None, force_new=False, request=None
     ) -> Union[SocketRawData, None]:
+        """Record a new SocketRawData (or get an existing one) and return it."""
         socketdata = None
 
         if force_new:
@@ -410,3 +413,13 @@ class HTTPRecords:
             logger().info(f"SocketRawData del id={id(obj)}")
             self._sockets[id(obj)] = None
             del self._sockets[id(obj)]
+
+    def add_new_record_exception(
+        self, initiator: Initiator, url: str, exception: Exception
+    ) -> HTTPRecord:
+        new_record = HTTPRecord()
+        new_record.url = url
+        new_record.initiator = initiator
+        new_record.exception = exception
+        self.requests[new_record.id] = new_record
+        return new_record

{httpdbg-0.28.2 → httpdbg-0.28.3}/httpdbg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.28.2
+Version: 0.28.3
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0