httpdbg 0.32.0__tar.gz → 1.0.0__tar.gz

{httpdbg-0.32.0 → httpdbg-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: httpdbg
-Version: 0.32.0
+Version: 1.0.0
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0
@@ -23,12 +23,10 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Provides-Extra: pytest
-Requires-Dist: pytest-httpdbg>=0.6.0; extra == "pytest"
 
 # httpdbg
 
-`httpdbg` is a tool for Python developers to easily debug the HTTP(S) client requests in a Python program.
+`httpdbg` is a tool for Python developers to easily debug the HTTP(S) client and server requests in a Python program.
 
 To use it, execute your program using the `pyhttpdbg` command instead of `python` and that's it. Open a browser to `http://localhost:4909` to view the requests:
 
@@ -44,6 +42,8 @@ pip install httpdbg
 
 ## usage
 
+By default, both client and server requests are recorded. To record only client requests, use the `--only-client` command line argument.
+
 ### interactive console
 
 Open an interactive console using the command `pyhttpdbg`.
@@ -71,30 +71,26 @@ You can trace all the HTTP requests performed by a script
 pyhttpdbg --script filename.py [arg1 --arg2 ...]
 ```
 
-### pytest
-
-You can trace all the HTTP requests performed during your tests
+### module
 
-```console
-pyhttpdbg -m pytest [arg1 --arg2 ...]
-```
+You can trace all the HTTP requests performed by a library module run as a script using the `-m` command line argument.
 
-If you use the `pytest-xdist` plugin to execute your tests in parallel, then you must install the `pytest-httpdbg` plugin if you want to trace the requests done by the pytest workers.
+For example, you can view which HTTP requests are performed by `pip` when you install a package.
 
 ```console
-pip install httpdbg[pytest]
+pyhttpdbg -m pip install hookdns --upgrade
 ```
 
-### module
+### test frameworks
 
-You can trace all the HTTP requests performed by a library module run as a script using the `-m` command line argument.
-
-For example, you can view which HTTP requests are performed by `pip` when you install a package.
+You can trace all HTTP requests made during your tests (pytest, unittest).
 
 ```console
-pyhttpdbg -m pip install hookdns --upgrade
+pyhttpdbg -m pytest [arg1 --arg2 ...]
 ```
 
+In that case, the requests will be grouped by test, and any requests made within a fixture or the setup/teardown methods will be identified by a tag.
+
 ## Initiators
 
 An initiator is the function/method that is at the origin of the HTTP requests. By default, we already support some packages but you can add your own initiators. 
@@ -107,7 +103,7 @@ pyhttpdbg -i api_client_pck --script my_script.py
 
 You can use any package as an initiator, this is not limited to HTTP requests.
 
-### Already supported packages
+### Already supported packages for HTTP client
 
 | packages       | status                              | 
 |----------------|-------------------------------------|
@@ -126,7 +122,9 @@ No configuration is necessary to start but some few settings are available for p
 ### command line
 
 ```console
-usage: pyhttpdbg [-h] [--host HOST] [--port PORT] [--version] [--initiator INITIATOR] [--keep-up | --force-quit]
+usage: pyhttpdbg [-h] [--host HOST] [--port PORT] [--version]
+                 [--initiator INITIATOR] [--only-client]
+                 [--keep-up | --force-quit]                 
                  [--console | --module MODULE | --script SCRIPT]
 
 httdbg - a very simple tool to debug HTTP(S) client requests
@@ -138,6 +136,7 @@ options:
   --version, -v         print the httpdbg version
   --initiator INITIATOR, -i INITIATOR
                         add a new initiator (package)
+  --only-client         record only HTTP client requests
   --keep-up, -k         keep the server up even if the requests have been read
   --force-quit, -q      stop the server even if the requests have not been read
   --console             run a python console (default)
@@ -173,6 +172,12 @@ The requests:
  * are still available in the web page even if the python process stopped (except if you force quit before the requests have been loaded by the web page).
  * are automatically cleaned if a new execution is detected.
 
+## limitations
+
+Theoretically, if your HTTP client or server uses a standard Python socket, the HTTP requests will be recorded.
+
+Support for recording requests on the server side is new in `httpdbg 1.0.0` and is currently limited. For example, it doesn't work with `FastAPI`, which uses `uvloop`, but it does work with `Uvicorn` if the loop is `asyncio`. Work is in progress to improve this.
+
 ## documentation
 
 https://httpdbg.readthedocs.io

{httpdbg-0.32.0 → httpdbg-1.0.0}/README.md

@@ -1,6 +1,6 @@
 # httpdbg
 
-`httpdbg` is a tool for Python developers to easily debug the HTTP(S) client requests in a Python program.
+`httpdbg` is a tool for Python developers to easily debug the HTTP(S) client and server requests in a Python program.
 
 To use it, execute your program using the `pyhttpdbg` command instead of `python` and that's it. Open a browser to `http://localhost:4909` to view the requests:
 
@@ -16,6 +16,8 @@ pip install httpdbg
 
 ## usage
 
+By default, both client and server requests are recorded. To record only client requests, use the `--only-client` command line argument.
+
 ### interactive console
 
 Open an interactive console using the command `pyhttpdbg`.
@@ -43,30 +45,26 @@ You can trace all the HTTP requests performed by a script
 pyhttpdbg --script filename.py [arg1 --arg2 ...]
 ```
 
-### pytest
-
-You can trace all the HTTP requests performed during your tests
+### module
 
-```console
-pyhttpdbg -m pytest [arg1 --arg2 ...]
-```
+You can trace all the HTTP requests performed by a library module run as a script using the `-m` command line argument.
 
-If you use the `pytest-xdist` plugin to execute your tests in parallel, then you must install the `pytest-httpdbg` plugin if you want to trace the requests done by the pytest workers.
+For example, you can view which HTTP requests are performed by `pip` when you install a package.
 
 ```console
-pip install httpdbg[pytest]
+pyhttpdbg -m pip install hookdns --upgrade
 ```
 
-### module
+### test frameworks
 
-You can trace all the HTTP requests performed by a library module run as a script using the `-m` command line argument.
-
-For example, you can view which HTTP requests are performed by `pip` when you install a package.
+You can trace all HTTP requests made during your tests (pytest, unittest).
 
 ```console
-pyhttpdbg -m pip install hookdns --upgrade
+pyhttpdbg -m pytest [arg1 --arg2 ...]
 ```
 
+In that case, the requests will be grouped by test, and any requests made within a fixture or the setup/teardown methods will be identified by a tag.
+
 ## Initiators
 
 An initiator is the function/method that is at the origin of the HTTP requests. By default, we already support some packages but you can add your own initiators. 
@@ -79,7 +77,7 @@ pyhttpdbg -i api_client_pck --script my_script.py
 
 You can use any package as an initiator, this is not limited to HTTP requests.
 
-### Already supported packages
+### Already supported packages for HTTP client
 
 | packages       | status                              | 
 |----------------|-------------------------------------|
@@ -98,7 +96,9 @@ No configuration is necessary to start but some few settings are available for p
 ### command line
 
 ```console
-usage: pyhttpdbg [-h] [--host HOST] [--port PORT] [--version] [--initiator INITIATOR] [--keep-up | --force-quit]
+usage: pyhttpdbg [-h] [--host HOST] [--port PORT] [--version]
+                 [--initiator INITIATOR] [--only-client]
+                 [--keep-up | --force-quit]                 
                  [--console | --module MODULE | --script SCRIPT]
 
 httdbg - a very simple tool to debug HTTP(S) client requests
@@ -110,6 +110,7 @@ options:
   --version, -v         print the httpdbg version
   --initiator INITIATOR, -i INITIATOR
                         add a new initiator (package)
+  --only-client         record only HTTP client requests
   --keep-up, -k         keep the server up even if the requests have been read
   --force-quit, -q      stop the server even if the requests have not been read
   --console             run a python console (default)
@@ -145,6 +146,12 @@ The requests:
  * are still available in the web page even if the python process stopped (except if you force quit before the requests have been loaded by the web page).
  * are automatically cleaned if a new execution is detected.
 
+## limitations
+
+Theoretically, if your HTTP client or server uses a standard Python socket, the HTTP requests will be recorded.
+
+Support for recording requests on the server side is new in `httpdbg 1.0.0` and is currently limited. For example, it doesn't work with `FastAPI`, which uses `uvloop`, but it does work with `Uvicorn` if the loop is `asyncio`. Work is in progress to improve this.
+
 ## documentation
 
 https://httpdbg.readthedocs.io

{httpdbg-0.32.0 → httpdbg-1.0.0}/httpdbg/__init__.py

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

{httpdbg-0.32.0 → httpdbg-1.0.0}/httpdbg/__main__.py

@@ -29,7 +29,8 @@ def pyhttpdbg(params, subparams, test_mode=False):
     sys.path.insert(0, "")  # to mimic the default python command behavior
 
     with httpdbg_srv(params.host, params.port) as records:
-        with httprecord(records, params.initiator):
+        records.server = not params.only_client
+        with httprecord(records, params.initiator, server=records.server):
             if params.module:
                 run_module(subparams)
             elif params.script:

{httpdbg-0.32.0 → httpdbg-1.0.0}/httpdbg/args.py

@@ -36,6 +36,12 @@ def read_args(args: List[str]) -> Tuple[argparse.Namespace, List[str]]:
         "--initiator", "-i", action="append", help="add a new initiator (package)"
     )
 
+    parser.add_argument(
+        "--only-client",
+        action="store_true",
+        help="record only HTTP client requests",
+    )
+
     server_state = parser.add_mutually_exclusive_group()
 
     server_state.add_argument(

{httpdbg-0.32.0 → httpdbg-1.0.0}/httpdbg/hooks/all.py

@@ -2,6 +2,7 @@
 from contextlib import contextmanager
 from typing import Generator
 from typing import List
+from typing import Tuple
 from typing import Union
 
 from httpdbg.hooks.aiohttp import hook_aiohttp
@@ -18,12 +19,16 @@ from httpdbg.records import HTTPRecords
 
 @contextmanager
 def httprecord(
-    records: HTTPRecords = None, initiators: Union[List[str], None] = None
+    records: HTTPRecords = None,
+    initiators: Union[List[str], None] = None,
+    client: bool = True,
+    server: bool = False,
+    ignore: Union[List[Tuple[str, int]], None] = None,
 ) -> Generator[HTTPRecords, None, None]:
     if records is None:
-        records = HTTPRecords()
+        records = HTTPRecords(client=client, server=server, ignore=ignore)
 
-    with watcher_external(records):
+    with watcher_external(records, initiators, server):
         with hook_socket(records):
             with hook_httpx(records):
                 with hook_requests(records):

{httpdbg-0.32.0 → httpdbg-1.0.0}/httpdbg/hooks/external.py

@@ -4,10 +4,11 @@ from typing import Generator
 import glob
 import os
 import pickle
-import shutil
 import tempfile
 import time
 import threading
+from typing import List
+from typing import Union
 
 from httpdbg.env import HTTPDBG_MULTIPROCESS_DIR
 from httpdbg.log import logger
@@ -15,7 +16,11 @@ from httpdbg.records import HTTPRecords
 
 
 @contextmanager
-def watcher_external(records: HTTPRecords) -> Generator[HTTPRecords, None, None]:
+def watcher_external(
+    records: HTTPRecords,
+    initiators: Union[List[str], None] = None,
+    server: bool = False,
+) -> Generator[HTTPRecords, None, None]:
     if HTTPDBG_MULTIPROCESS_DIR not in os.environ:
         with tempfile.TemporaryDirectory(prefix="httpdbg_") as httpdbg_multiprocess_dir:
 
@@ -31,7 +36,20 @@ def watcher_external(records: HTTPRecords) -> Generator[HTTPRecords, None, None]
             )
             sitecustomize = os.path.join(httpdbg_multiprocess_dir, "sitecustomize.py")
 
-            shutil.copy(template, sitecustomize)
+            with open(template) as f:
+                template_content = f.read()
+
+            if initiators:
+                template_content = template_content.replace(
+                    "HTTPDBG_INITIATORS = []", f"HTTPDBG_INITIATORS = {initiators}", 1
+                )
+
+            template_content = template_content.replace(
+                "HTTPDBG_RECORD_SERVER = False", f"HTTPDBG_RECORD_SERVER = {server}", 1
+            )
+
+            with open(sitecustomize, "w") as f:
+                f.write(template_content)
 
             if "PYTHONPATH" in os.environ:
                 os.environ["PYTHONPATH"] = (