httpdbg 0.29.1__tar.gz → 0.29.2__tar.gz

{httpdbg-0.29.1 → httpdbg-0.29.2}/PKG-INFO

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

{httpdbg-0.29.1 → httpdbg-0.29.2}/httpdbg/__init__.py

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

{httpdbg-0.29.1 → httpdbg-0.29.2}/httpdbg/__main__.py

@@ -35,7 +35,7 @@ def pyhttpdbg(params, subparams, test_mode=False):
             elif params.script:
                 run_script(subparams)
             else:
-                run_console(test_mode)
+                run_console(records, test_mode)
 
         if not (params.force_quit or test_mode):
             print_msg(f"  httpdbg - HTTP(S) requests available at {url}")

httpdbg-0.29.2/httpdbg/mode_console.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+import code
+from typing import List
+from typing import Union
+
+from httpdbg.records import HTTPRecords
+from httpdbg.initiator import httpdbg_group
+
+
+def console_exit():
+    raise SystemExit
+
+
+class InteractiveConsoleWithHistory(code.InteractiveConsole):
+
+    def __init__(self, records: HTTPRecords, locals=None):
+        self.records: HTTPRecords = records
+        self.history: List[str] = []
+        self.incomplete_block: bool = False
+        super().__init__(locals)
+
+    def push(self, line):
+        if line:  # if the line is empty, we don't add it in the history
+            if (
+                self.incomplete_block
+            ):  # if the latest instruction is part of a block, we group it with the previous one
+                self.history[-1] += (
+                    "\n          " + line
+                )  # to simulate the block indentation
+            else:
+                self.history.append(line)
+
+        # if the latest instruction is part of a block, the label is generic
+        label = self.history[-1] if not self.incomplete_block else "(block)"
+
+        # in the full label, we keep the last 5 instructions/blocks
+        latest_history = self.history[-5:]
+        if not self.incomplete_block:
+            # in case of a block, we don't know which line within the block is the initiator.
+            # this is why we do not mark it in that case.
+            # this information is displayed in the initiator tooltip of the requests (in console, line X,)
+            latest_history[-1] += " <===="
+
+        full_label = ">>> " + "\n>>> ".join(latest_history)
+
+        with httpdbg_group(self.records, label, full_label):
+            self.incomplete_block = super().push(line)
+
+        return self.incomplete_block
+
+
+def run_console(
+    records: HTTPRecords, test_mode: bool = False
+) -> Union[InteractiveConsoleWithHistory, None]:
+    try:
+        vars = globals()
+        vars.update(locals())
+
+        try:
+            # adds history and autocompletion capabilities
+            import readline
+            import rlcompleter
+
+            readline.set_completer(rlcompleter.Completer(vars).complete)
+            readline.parse_and_bind("tab: complete")
+        except ImportError:  # pragma: no cover
+            # readline is not available on Windows
+            pass
+
+        vars.update({"exit": console_exit})
+
+        new_console = InteractiveConsoleWithHistory(records, vars)
+        if not test_mode:
+            new_console.interact()  # pragma: no cover
+        else:
+            new_console.push("print('test_mode is on')")
+            return new_console
+    except SystemExit:  # pragma: no cover
+        pass
+
+    return None

{httpdbg-0.29.1 → httpdbg-0.29.2}/httpdbg.egg-info/PKG-INFO

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

{httpdbg-0.29.1 → httpdbg-0.29.2}/tests/test_mode_console.py

@@ -36,7 +36,7 @@ def test_run_console_from_pyhttpdbg_entry_point_default(
 def test_run_console(httpbin, httpdbg_host, httpdbg_port):
     with httpdbg_srv(httpdbg_host, httpdbg_port) as records:
         with httprecord(records):
-            new_console = run_console(test_mode=True)
+            new_console = run_console(records, test_mode=True)
             new_console.push("import requests")
             new_console.push(f"requests.get('{httpbin.url}/get')")
             with pytest.raises(SystemExit):
@@ -48,3 +48,31 @@ def test_run_console(httpbin, httpdbg_host, httpdbg_port):
 
     assert len(reqs) == 1
     assert reqs[list(reqs.keys())[0]]["url"] == httpbin.url + "/get"
+
+
+@pytest.mark.group
+def test_run_console_group(httpbin):
+
+    with httprecord() as records:
+        new_console = run_console(records, test_mode=True)
+        new_console.push("import requests")
+        new_console.push(f"requests.get('{httpbin.url}/get')")
+        new_console.push("if True:")
+        new_console.push(f"    requests.post('{httpbin.url}/post')")
+        new_console.push("")
+        with pytest.raises(SystemExit):
+            new_console.push("exit()")
+
+    assert len(records) == 2
+    assert (
+        records.groups[records[0].group_id].label
+        == f"requests.get('{httpbin.url}/get')"
+    )
+    assert records.groups[records[0].group_id].full_label.endswith(
+        f">>> requests.get('{httpbin.url}/get') <===="
+    )
+
+    assert records.groups[records[1].group_id].label == "(block)"
+    assert records.groups[records[1].group_id].full_label.endswith(
+        f">>> if True:\n              requests.post('{httpbin.url}/post')"
+    )

httpdbg-0.29.1/httpdbg/mode_console.py

@@ -1,37 +0,0 @@
-# -*- coding: utf-8 -*-
-import code
-from typing import Union
-
-
-def console_exit():
-    raise SystemExit
-
-
-def run_console(test_mode: bool = False) -> Union[code.InteractiveConsole, None]:
-    try:
-        vars = globals()
-        vars.update(locals())
-
-        try:
-            # adds history and autocompletion capabilities
-            import readline
-            import rlcompleter
-
-            readline.set_completer(rlcompleter.Completer(vars).complete)
-            readline.parse_and_bind("tab: complete")
-        except ImportError:  # pragma: no cover
-            # readline is not available on Windows
-            pass
-
-        vars.update({"exit": console_exit})
-
-        new_console = code.InteractiveConsole(vars)
-        if not test_mode:
-            new_console.interact()  # pragma: no cover
-        else:
-            new_console.push("print('test_mode is on')")
-            return new_console
-    except SystemExit:  # pragma: no cover
-        pass
-
-    return None