httpdbg 2.0.0__tar.gz → 2.0.2__tar.gz

{httpdbg-2.0.0 → httpdbg-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: httpdbg
-Version: 2.0.0
+Version: 2.0.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

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/__init__.py

@@ -1,8 +1,7 @@
-# -*- coding: utf-8 -*-
 from httpdbg.hooks.all import httprecord
 from httpdbg.records import HTTPRecords
 
 
-__version__ = "2.0.0"
+__version__ = "2.0.2"
 
 __all__ = ["httprecord", "HTTPRecords"]

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/__main__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import sys
 import time
 
@@ -24,7 +23,8 @@ def pyhttpdbg(params, subparams, test_mode=False):
 
     url = f"http://{params.host}:{params.port}/{'?hi=on' if params.console else ''}"
 
-    print_msg(f"  httpdbg - HTTP(S) requests available at {url}")
+    if not params.no_banner:
+        print_msg(f"  httpdbg - HTTP(S) requests available at {url}")
 
     sys.path.insert(0, "")  # to mimic the default python command behavior
 
@@ -39,7 +39,8 @@ def pyhttpdbg(params, subparams, test_mode=False):
                 run_console(records, test_mode)
 
         if not (params.force_quit or test_mode):
-            print_msg(f"  httpdbg - HTTP(S) requests available at {url}")
+            if not params.no_banner:
+                print_msg(f"  httpdbg - HTTP(S) requests available at {url}")
 
             if params.keep_up:
                 input("Press enter to quit")

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/args.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import argparse
 from pathlib import Path
 
@@ -65,7 +64,13 @@ def read_args(args: list[str]) -> tuple[argparse.Namespace, list[str]]:
         help="The log level",
     )
 
-    parser.add_argument("--log", type=Path, help="Path to the log file.")
+    parser.add_argument("--log", type=Path, help="path to the log file.")
+
+    parser.add_argument(
+        "--no-banner",
+        action="store_true",
+        help="do not print the banner in the console",
+    )
 
     actions = parser.add_mutually_exclusive_group()
 

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/hooks/aiohttp.py

@@ -1,7 +1,5 @@
-# -*- coding: utf-8 -*-
 from collections.abc import Callable
 from contextlib import contextmanager
-import traceback
 from typing import Generator
 
 from httpdbg.hooks.utils import getcallargs
@@ -16,7 +14,7 @@ def set_hook_for_aiohttp_async(records: HTTPRecords, method: Callable):
         initiator_and_group = None
         try:
             with httpdbg_initiator(
-                records, traceback.extract_stack(), method, *args, **kwargs
+                records, method, *args, **kwargs
             ) as initiator_and_group:
                 ret = await method(*args, **kwargs)
             return ret

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/hooks/generic.py

@@ -1,11 +1,9 @@
-# -*- coding: utf-8 -*-
 import builtins
 from collections.abc import Callable
 from contextlib import contextmanager
 import functools
 import importlib
 import inspect
-import traceback
 from types import ModuleType
 from typing import Any
 from typing import Generator
@@ -22,9 +20,7 @@ def set_hook_for_generic_async(records: HTTPRecords, method: Any):
     logger().info(f"SET_HOOK_FOR_GENERIC_ASYNC {method}")
 
     async def hook(*args, **kwargs):
-        with httpdbg_initiator(
-            records, traceback.extract_stack(), method, *args, **kwargs
-        ):
+        with httpdbg_initiator(records, method, *args, **kwargs):
             ret = await method(*args, **kwargs)
 
         return ret
@@ -36,9 +32,7 @@ def set_hook_for_generic(records: HTTPRecords, method: Any):
     logger().info(f"SET_HOOK_FOR_GENERIC {method}")
 
     def hook(*args, **kwargs):
-        with httpdbg_initiator(
-            records, traceback.extract_stack(), method, *args, **kwargs
-        ):
+        with httpdbg_initiator(records, method, *args, **kwargs):
             ret = method(*args, **kwargs)
 
         return ret

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/hooks/h2.py

@@ -1,7 +1,6 @@
 from collections.abc import Callable
 from contextlib import contextmanager
 import random
-import traceback
 from typing import Generator
 from typing import Union
 
@@ -101,9 +100,7 @@ def set_hook_for_h2_send_headers(records: HTTPRecords, method: Callable):
         stream_id = callargs.get("stream_id")
         headers = callargs.get("headers")
 
-        with httpdbg_initiator(
-            records, traceback.extract_stack(), method, *args, **kwargs
-        ) as initiator_and_group:
+        with httpdbg_initiator(records, method, *args, **kwargs) as initiator_and_group:
             initiator, group, _ = initiator_and_group
             if all(x is not None for x in (self, stream_id, headers)):
                 logger().debug(
@@ -127,9 +124,7 @@ def set_hook_for_h2_send_data(records: HTTPRecords, method: Callable):
         stream_id = callargs.get("stream_id")
         data = callargs.get("data")
 
-        with httpdbg_initiator(
-            records, traceback.extract_stack(), method, *args, **kwargs
-        ):
+        with httpdbg_initiator(records, method, *args, **kwargs):
             if all(x is not None for x in (self, stream_id, data)):
                 logger().debug(
                     f"H2 send_data - self={id(self)} steam_id={stream_id} data={data[:20]!r}"
@@ -146,9 +141,7 @@ def set_hook_for_h2_receive_data(records: HTTPRecords, method: Callable):
         callargs = getcallargs(method, *args, **kwargs)
         self = callargs.get("self")
 
-        with httpdbg_initiator(
-            records, traceback.extract_stack(), method, *args, **kwargs
-        ) as initiator_and_group:
+        with httpdbg_initiator(records, method, *args, **kwargs) as initiator_and_group:
             initiator, group, _ = initiator_and_group
             ret = method(*args, **kwargs)
 

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/hooks/http.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from collections.abc import Callable
 from contextlib import contextmanager
 from typing import Generator

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/hooks/httpx.py

@@ -1,6 +1,5 @@
 from collections.abc import Callable
 from contextlib import contextmanager
-import traceback
 from typing import Generator
 
 from httpdbg.hooks.utils import getcallargs
@@ -15,7 +14,7 @@ def set_hook_for_httpx_async(records: HTTPRecords, method: Callable):
         initiator_and_group = None
         try:
             with httpdbg_initiator(
-                records, traceback.extract_stack(), method, *args, **kwargs
+                records, method, *args, **kwargs
             ) as initiator_and_group:
                 ret = await method(*args, **kwargs)
             return ret
@@ -39,7 +38,7 @@ def set_hook_for_httpx(records: HTTPRecords, method: Callable):
         initiator_and_group = None
         try:
             with httpdbg_initiator(
-                records, traceback.extract_stack(), method, *args, **kwargs
+                records, method, *args, **kwargs
             ) as initiator_and_group:
                 ret = method(*args, **kwargs)
             return ret

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/hooks/requests.py

@@ -1,7 +1,5 @@
-# -*- coding: utf-8 -*-
 from collections.abc import Callable
 from contextlib import contextmanager
-import traceback
 from typing import Generator
 
 from httpdbg.hooks.utils import getcallargs
@@ -16,7 +14,7 @@ def set_hook_for_requests(records: HTTPRecords, method: Callable):
         initiator_and_group = None
         try:
             with httpdbg_initiator(
-                records, traceback.extract_stack(), method, *args, **kwargs
+                records, method, *args, **kwargs
             ) as initiator_and_group:
                 ret = method(*args, **kwargs)
             return ret

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/hooks/socket.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import asyncio
 import asyncio.proactor_events
 from collections.abc import Callable
@@ -8,7 +7,6 @@ import platform
 import socket
 import ssl
 import sys
-import traceback
 from typing import Generator
 from typing import Union
 
@@ -193,7 +191,7 @@ def set_hook_for_socket_connect(records: HTTPRecords, method: Callable):
             ):  # BlockingIOError for async, OSError for ipv6
                 if records.client:
                     with httpdbg_initiator(
-                        records, traceback.extract_stack(), method, *args, **kwargs
+                        records, method, *args, **kwargs
                     ) as initiator_and_group:
                         initiator, group, is_new = initiator_and_group
                         if is_new:
@@ -221,7 +219,7 @@ def set_hook_for_ssl_wrap_socket(records: HTTPRecords, method: Callable):
         except Exception as ex:
             if records.client:
                 with httpdbg_initiator(
-                    records, traceback.extract_stack(), method, *args, **kwargs
+                    records, method, *args, **kwargs
                 ) as initiator_and_group:
                     initiator, group, is_new = initiator_and_group
                     if is_new:
@@ -256,7 +254,7 @@ def set_hook_for_sslcontext_wrap_socket(records: HTTPRecords, method: Callable):
         except Exception as ex:
             if records.client:
                 with httpdbg_initiator(
-                    records, traceback.extract_stack(), method, *args, **kwargs
+                    records, method, *args, **kwargs
                 ) as initiator_and_group:
                     initiator, group, is_new = initiator_and_group
                     if is_new:
@@ -291,7 +289,7 @@ def set_hook_for_socket_wrap_bio(records: HTTPRecords, method: Callable):
         except Exception as ex:
             if records.client:
                 with httpdbg_initiator(
-                    records, traceback.extract_stack(), method, *args, **kwargs
+                    records, method, *args, **kwargs
                 ) as initiator_and_group:
                     initiator, group, is_new = initiator_and_group
                     if is_new:
@@ -345,7 +343,6 @@ def set_hook_for_socket_recv_into(records: HTTPRecords, method: Callable):
                         )
                         with httpdbg_initiator(
                             records,
-                            traceback.extract_stack(),
                             method,
                             self,
                             buffer,
@@ -404,7 +401,6 @@ def set_hook_for_socket_recv(records: HTTPRecords, method: Callable):
                     logger().info("RECV - http detected")
                     with httpdbg_initiator(
                         records,
-                        traceback.extract_stack(),
                         method,
                         self,
                         bufsize,
@@ -459,7 +455,6 @@ def set_hook_for_socket_sendall(records: HTTPRecords, method: Callable):
                     logger().info("SENDALL - http detected")
                     with httpdbg_initiator(
                         records,
-                        traceback.extract_stack(),
                         method,
                         self,
                         data,
@@ -515,7 +510,6 @@ def set_hook_for_socket_send(records: HTTPRecords, method: Callable):
                 if http_detected:
                     with httpdbg_initiator(
                         records,
-                        traceback.extract_stack(),
                         method,
                         self,
                         data,
@@ -595,7 +589,6 @@ def set_hook_for_sslobject_write(records: HTTPRecords, method: Callable):
                 if http_detected:
                     with httpdbg_initiator(
                         records,
-                        traceback.extract_stack(),
                         method,
                         self,
                         buf,

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/hooks/urllib3.py

@@ -1,7 +1,5 @@
-# -*- coding: utf-8 -*-
 from collections.abc import Callable
 from contextlib import contextmanager
-import traceback
 from typing import Generator
 
 from httpdbg.hooks.utils import getcallargs
@@ -16,7 +14,7 @@ def set_hook_for_urllib3(records: HTTPRecords, method: Callable):
         initiator_and_group = None
         try:
             with httpdbg_initiator(
-                records, traceback.extract_stack(), method, *args, **kwargs
+                records, method, *args, **kwargs
             ) as initiator_and_group:
                 ret = method(*args, **kwargs)
             return ret

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/hooks/uvicorn.py

@@ -1,8 +1,6 @@
-# -*- coding: utf-8 -*-
 from collections.abc import Callable
 from contextlib import contextmanager
 import datetime
-import traceback
 import typing
 from typing import Generator
 
@@ -66,7 +64,6 @@ def set_hook_uvicorn_data_received(records: HTTPRecords, method: Callable):
                     logger().info("UVICORN - http detected")
                     with httpdbg_initiator(
                         records,
-                        traceback.extract_stack(),
                         method,
                         self,
                         data,

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg/initiator.py

@@ -2,7 +2,9 @@
 from collections.abc import Callable
 from contextlib import contextmanager
 import datetime
+import functools
 import inspect
+import linecache
 import os
 import platform
 import traceback
@@ -98,33 +100,27 @@ def in_lib(line: str, packages: list[str] = None):
 def get_current_instruction(
     extracted_stack: traceback.StackSummary,
 ) -> tuple[str, str, list[str]]:
-    instruction = ""
-    short_stack = ""
-    stack = []
+    instruction: str = ""
+    short_stack: str = ""
+    stack: list[str] = []
 
     try:
-        n_stack = -1
-        framesummary = extracted_stack[-2]
-        while "asyncio" in framesummary.filename:
-            n_stack -= 1
-            framesummary = extracted_stack[n_stack - 1]
+        n_stack = -2
+        framesummary = extracted_stack[-3]
 
-        while ("httpdbg/hooks" in framesummary.filename) or (
-            "httpdbg\\hooks" in framesummary.filename
+        while (
+            ("httpdbg/hooks" in framesummary.filename)
+            or ("httpdbg\\hooks" in framesummary.filename)
+            or ("asyncio" in framesummary.filename)
         ):
             n_stack -= 1
             framesummary = extracted_stack[n_stack - 1]
 
-        short_stack = f'File "{framesummary.filename}", line {framesummary.lineno}, in {framesummary.name}\n'
         if os.path.exists(framesummary.filename) and framesummary.lineno is not None:
-            instruction, s_stack = extract_short_stack_from_file(
-                framesummary.filename, framesummary.lineno, 0, 8
-            )
-            short_stack += s_stack
 
             # stack
             to_include = False
-            for i_stack in range(6, len(extracted_stack) + n_stack):
+            for i_stack in range(7, len(extracted_stack) + n_stack):
                 last_stack = i_stack == len(extracted_stack) + n_stack - 1
                 fs = extracted_stack[i_stack]
                 to_include = to_include or (
@@ -132,14 +128,20 @@ def get_current_instruction(
                     and ("importlib" not in fs.filename)
                 )  # remove the stack before to start the user part
                 if to_include:
-                    _, s_stack = extract_short_stack_from_file(
+                    instruction, s_stack, l_stack = extract_short_stack_from_file(
                         fs.filename,
                         fs.lineno if fs.lineno else 0,
-                        4 if last_stack else 0,
-                        8,
                         not last_stack,
                     )
-                    stack.append(f'File "{fs.filename}", line {fs.lineno}, \n{s_stack}')
+                    if last_stack:
+                        short_stack = (
+                            f'File "{fs.filename}", line {fs.lineno}, in {fs.name}\n'
+                        )
+                        short_stack += s_stack
+
+                    stack.append(
+                        f'File "{fs.filename}", line {fs.lineno}, \n{l_stack}\n'
+                    )
 
         else:
             instruction = framesummary.line if framesummary.line else "console"
@@ -153,52 +155,57 @@ def get_current_instruction(
     return instruction.replace("\n", " "), short_stack, stack
 
 
+@functools.cache
 def extract_short_stack_from_file(
     filename: str,
     lineno: int,
-    before: int,
-    after: int,
     stop_if_instruction_ends: bool = True,
-) -> tuple[str, str]:
-    instruction = ""
-    short_stack = ""
+) -> tuple[str, str, str]:
+    before: int = 4
+    after: int = 8
+    instruction: str = ""
+    short_stack: str = ""
+    long_stack: str = ""
 
     try:
         if os.path.exists(filename):
-            with open(filename, "r") as src:
-                lines = src.read().splitlines()
-
-                # copy the lines before
-                for i in range(
-                    max(0, lineno - 1 - before), min(lineno - 1, len(lines))
-                ):
-                    line = lines[i]
-                    short_stack += f" {i+1}. {line}\n"
-
-                # try to recompose the instruction if on multi-lines
-                end_of_instruction_found = False
-                for i in range(max(0, lineno - 1), min(lineno - 1 + after, len(lines))):
-                    line = lines[i]
-                    if not end_of_instruction_found:
-                        instruction += line.strip()
-                    short_stack += f" {i+1}. {line}{' <====' if (before > 0 and i + 1 == lineno) else ''}\n"
-                    nb_parenthesis = 0
-                    for c in instruction[instruction.find("(") :]:
-                        if c == "(":
-                            nb_parenthesis += 1
-                        if c == ")":
-                            nb_parenthesis -= 1
-                        if nb_parenthesis == 0:
-                            end_of_instruction_found = True
-                            break
-                    if end_of_instruction_found and stop_if_instruction_ends:
+            # copy the lines before, only for the "long" stack (if they are not empty)
+            copyit = False
+            for i in range(max(0, lineno - before), lineno):
+                line = linecache.getline(filename, i).removesuffix("\n").rstrip()
+                copyit = copyit or (line != "")
+                if copyit:
+                    long_stack += f" {i}. {line}\n"
+
+            # try to recompose the instruction if on multi-lines
+            end_of_instruction_found = False
+            for i in range(max(0, lineno), lineno + after):
+                line = linecache.getline(filename, i).removesuffix("\n").rstrip()
+                if not end_of_instruction_found:
+                    instruction += line.strip()
+                    short_stack += f" {i}. {line}\n"
+                long_stack += (
+                    f" {i}. {line}{' <====' if (before > 0 and i == lineno) else ''}\n"
+                )
+                nb_parenthesis = 0
+                for c in instruction[instruction.find("(") :]:
+                    if c == "(":
+                        nb_parenthesis += 1
+                    if c == ")":
+                        nb_parenthesis -= 1
+                    if nb_parenthesis == 0:
+                        end_of_instruction_found = True
                         break
+                if end_of_instruction_found and stop_if_instruction_ends:
+                    break
     except Exception as ex:
+        tb = traceback.extract_tb(ex.__traceback__)
+        _, lineno, _, _ = tb[-1]
         logger().info(
-            f"EXTRACT_SHORT_STACK_FROM_FILE {filename} lineno={lineno} before={before} after={after}- error - {str(ex)}"
+            f"EXTRACT_SHORT_STACK_FROM_FILE {filename} lineno={lineno} before={before} after={after}- error (line {lineno}) - {str(ex)}",
         )
 
-    return instruction, short_stack
+    return instruction, short_stack, long_stack
 
 
 def construct_call_str(original_method, *args, **kwargs):
@@ -237,16 +244,16 @@ def construct_call_str(original_method, *args, **kwargs):
 @contextmanager
 def httpdbg_initiator(
     records: "HTTPRecords",
-    extracted_stack: traceback.StackSummary,
     original_method: Callable,
     *args,
     **kwargs,
 ) -> Generator[tuple[Initiator, Group, bool], None, None]:
-
     try:
         if records.current_initiator is None:
             initiator_already_set = False
 
+            extracted_stack: traceback.StackSummary = traceback.extract_stack()
+
             # 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
@@ -346,7 +353,7 @@ def httpdbg_endpoint(
     filename = inspect.getsourcefile(original_method)
     if filename:
         _, lineno = inspect.getsourcelines(original_method)
-        instruction, s_stack = extract_short_stack_from_file(filename, lineno, 0, 8)
+        instruction, s_stack, _ = extract_short_stack_from_file(filename, lineno)
         full_label = (
             f'File "{filename}", line {lineno}, in {original_method.__name__}\n'
         )

{httpdbg-2.0.0 → httpdbg-2.0.2}/httpdbg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: httpdbg
-Version: 2.0.0
+Version: 2.0.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