httpdbg 0.10.0__tar.gz → 0.11.0__tar.gz

{httpdbg-0.10.0 → httpdbg-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.10.0
+Version: 0.11.0
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0
@@ -19,11 +19,13 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 
 [![Build Status](https://github.com/cle-b/httpdbg/workflows/Build/badge.svg?branch=main)](https://github.com/cle-b/httpdbg/actions?query=workflow%3ABuild) [![PyPI version](https://badge.fury.io/py/httpdbg.svg)](https://badge.fury.io/py/httpdbg) [![Coverage Status](https://coveralls.io/repos/github/cle-b/httpdbg/badge.svg?branch=main)](https://coveralls.io/github/cle-b/httpdbg?branch=main)
+
 # httpdbg
 
 A very simple tool to debug HTTP(S) client requests.
 
-![ui](ui.png)
+![](ui.png)
+
 ## installation 
 
 ```
@@ -79,15 +81,28 @@ For example, you can view which HTTP requests are performed by `pip` when you in
 pyhttpdbg -m pip install httpdbg --upgrade
 ```
 
+## 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. 
+
+To add a new package in the list of initiators, you can use the `-i` command line argument:
+
+```sh
+pyhttpdbg -i api_client_pck --script my_script.py
+```
+
+You can use any package as an initiator, this is not limited to HTTP requests.
 
-## Supported libraries
+### Already supported packages
 
-| library    | status      | 
-|------------|-------------|
-| requests   | supported   |
-| urllib3    | supported   |
-| httpx      | supported   |
-| aiohttp    | supported   |
+| packages       | status                              | 
+|----------------|-------------------------------------|
+| requests       | supported                           |
+| urllib3        | supported                           |
+| httpx          | supported                           |
+| aiohttp        | supported                           |
+| pytest         | supported                           |
+| _your_package_ | yes, with the arg _-i your_package_ |
 
 ## configuration
 
@@ -96,20 +111,19 @@ No configuration is necessary to start but some few settings are available for p
 ### command line
 
 ```
-usage: pyhttpdbg [-h] [--port PORT] [--version] [--keep-up | --force-quit]
+usage: pyhttpdbg [-h] [--port PORT] [--version] [--initiator INITIATOR] [--keep-up | --force-quit]
                  [--console | --module MODULE | --script SCRIPT]
 
 httdbg - a very simple tool to debug HTTP(S) client requests
 
 options:
   -h, --help            show this help message and exit
-  --version, -v         print the httpdbg version
-
   --port PORT, -p PORT  the web interface port
-  
+  --version, -v         print the httpdbg version
+  --initiator INITIATOR, -i INITIATOR
+                        add a new initiator (package)
   --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)
   --module MODULE, -m MODULE
                         run library module as a script (the next args are passed to pytest as is)

{httpdbg-0.10.0 → httpdbg-0.11.0}/README.md

@@ -1,9 +1,11 @@
 [![Build Status](https://github.com/cle-b/httpdbg/workflows/Build/badge.svg?branch=main)](https://github.com/cle-b/httpdbg/actions?query=workflow%3ABuild) [![PyPI version](https://badge.fury.io/py/httpdbg.svg)](https://badge.fury.io/py/httpdbg) [![Coverage Status](https://coveralls.io/repos/github/cle-b/httpdbg/badge.svg?branch=main)](https://coveralls.io/github/cle-b/httpdbg?branch=main)
+
 # httpdbg
 
 A very simple tool to debug HTTP(S) client requests.
 
-![ui](ui.png)
+![](ui.png)
+
 ## installation 
 
 ```
@@ -59,15 +61,28 @@ For example, you can view which HTTP requests are performed by `pip` when you in
 pyhttpdbg -m pip install httpdbg --upgrade
 ```
 
+## 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. 
+
+To add a new package in the list of initiators, you can use the `-i` command line argument:
+
+```sh
+pyhttpdbg -i api_client_pck --script my_script.py
+```
+
+You can use any package as an initiator, this is not limited to HTTP requests.
 
-## Supported libraries
+### Already supported packages
 
-| library    | status      | 
-|------------|-------------|
-| requests   | supported   |
-| urllib3    | supported   |
-| httpx      | supported   |
-| aiohttp    | supported   |
+| packages       | status                              | 
+|----------------|-------------------------------------|
+| requests       | supported                           |
+| urllib3        | supported                           |
+| httpx          | supported                           |
+| aiohttp        | supported                           |
+| pytest         | supported                           |
+| _your_package_ | yes, with the arg _-i your_package_ |
 
 ## configuration
 
@@ -76,20 +91,19 @@ No configuration is necessary to start but some few settings are available for p
 ### command line
 
 ```
-usage: pyhttpdbg [-h] [--port PORT] [--version] [--keep-up | --force-quit]
+usage: pyhttpdbg [-h] [--port PORT] [--version] [--initiator INITIATOR] [--keep-up | --force-quit]
                  [--console | --module MODULE | --script SCRIPT]
 
 httdbg - a very simple tool to debug HTTP(S) client requests
 
 options:
   -h, --help            show this help message and exit
-  --version, -v         print the httpdbg version
-
   --port PORT, -p PORT  the web interface port
-  
+  --version, -v         print the httpdbg version
+  --initiator INITIATOR, -i INITIATOR
+                        add a new initiator (package)
   --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)
   --module MODULE, -m MODULE
                         run library module as a script (the next args are passed to pytest as is)

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/__init__.py

@@ -2,6 +2,6 @@
 from httpdbg.hooks.all import httpdbg
 from httpdbg.utils import logger
 
-VERSION = "0.10.0"
+VERSION = "0.11.0"
 
 __all__ = ["httpdbg", "logger"]

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/__main__.py

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

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/args.py

@@ -23,6 +23,10 @@ def read_args(args: List[str]) -> Tuple[argparse.Namespace, List[str]]:
         "--version", "-v", action="store_true", help="print the httpdbg version"
     )
 
+    parser.add_argument(
+        "--initiator", "-i", action="append", help="add a new initiator (package)"
+    )
+
     server_state = parser.add_mutually_exclusive_group()
 
     server_state.add_argument(

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/hooks/aiohttp.py

@@ -1,12 +1,14 @@
 # -*- coding: utf-8 -*-
 from contextlib import contextmanager
 import traceback
+from typing import Generator
 
 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):
@@ -36,7 +38,7 @@ def set_hook_for_aiohttp_async(records, method):
 
 
 @contextmanager
-def hook_aiohttp(records):
+def hook_aiohttp(records: HTTPRecords) -> Generator[None, None, None]:
     hooks = False
     try:
         import aiohttp

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/hooks/all.py

@@ -1,7 +1,11 @@
 # -*- coding: utf-8 -*-
 from contextlib import contextmanager
+from typing import Generator
+from typing import List
+from typing import Union
 
 from httpdbg.hooks.aiohttp import hook_aiohttp
+from httpdbg.hooks.generic import hook_generic
 from httpdbg.hooks.httpx import hook_httpx
 from httpdbg.hooks.requests import hook_requests
 from httpdbg.hooks.socket import hook_socket
@@ -10,7 +14,9 @@ from httpdbg.records import HTTPRecords
 
 
 @contextmanager
-def httpdbg(records=None):
+def httpdbg(
+    records: HTTPRecords = None, initiators: Union[List[str], None] = None
+) -> Generator[HTTPRecords, None, None]:
     if records is None:
         records = HTTPRecords()
 
@@ -19,4 +25,5 @@ def httpdbg(records=None):
             with hook_requests(records):
                 with hook_urllib3(records):
                     with hook_aiohttp(records):
-                        yield records
+                        with hook_generic(records, initiators):
+                            yield records

httpdbg-0.11.0/httpdbg/hooks/generic.py

@@ -0,0 +1,158 @@
+# -*- coding: utf-8 -*-
+from contextlib import contextmanager
+import glob
+import importlib
+import inspect
+from pathlib import Path
+import traceback
+from typing import Generator
+from typing import List
+from typing import Union
+
+from httpdbg.hooks.utils import decorate
+from httpdbg.hooks.utils import undecorate
+from httpdbg.initiator import httpdbg_initiator
+from httpdbg.records import HTTPRecords
+from httpdbg.utils import logger
+
+
+def set_hook_for_generic_async(records, method):
+    async def hook(*args, **kwargs):
+        with httpdbg_initiator(
+            records, traceback.extract_stack(), method, *args, **kwargs
+        ):
+            ret = await method(*args, **kwargs)
+
+        return ret
+
+    return hook
+
+
+def set_hook_for_generic(records, method):
+    def hook(*args, **kwargs):
+        with httpdbg_initiator(
+            records, traceback.extract_stack(), method, *args, **kwargs
+        ):
+            ret = method(*args, **kwargs)
+
+        return ret
+
+    return hook
+
+
+@contextmanager
+def hook_generic(
+    records: HTTPRecords, initiators: Union[List[str], None] = None
+) -> Generator[None, None, None]:
+    hooks = []
+
+    if not initiators:
+        initiators = []
+
+    for initiator in initiators:
+        logger.debug(f"HOOK_GENERIC add package - {initiator}")
+        try:
+            hooks += list_callables_from_package(records, initiator)
+        except Exception as ex:
+            logger.debug(f"HOOK_GENERIC exception - {str(ex)}")
+
+    yield
+
+    if hooks:
+        for fnc in hooks:
+            fnc = undecorate(fnc)
+
+
+def list_callables_from_package(records, package):
+    callables = []
+
+    callables += list_callables_from_module(records, package)
+
+    try:
+        imported_package = importlib.import_module(package)
+        for p in glob.glob(f"{list(imported_package.__path__)[0]}/*"):
+            file_or_dir = Path(p)
+            if file_or_dir.is_file():
+                if file_or_dir.name.endswith(".py"):
+                    callables += list_callables_from_module(
+                        records, f"{package}.{file_or_dir.name[:-3]}"
+                    )
+            elif file_or_dir.is_dir():
+                if not file_or_dir.name.startswith("__"):  # __pycache__
+                    callables += list_callables_from_package(
+                        records, f"{package}.{file_or_dir.name}"
+                    )
+    except ImportError:
+        pass
+
+    return callables
+
+
+def list_callables_from_module(records, module):
+    callables = []
+
+    imported_module = importlib.import_module(module)
+
+    for name in imported_module.__dict__.keys():
+        # hook must be applied only on function/method defined in the current module (not imported)
+        from_module = getattr(imported_module.__dict__[name], "__module__", "")
+        if from_module and from_module.startswith(module):
+            # a coroutine is a function so this condition must be checked first
+            if inspect.iscoroutinefunction(imported_module.__dict__[name]):
+                imported_module.__dict__[name] = decorate(
+                    records,
+                    imported_module.__dict__[name],
+                    set_hook_for_generic_async,
+                )
+                callables.append(imported_module.__dict__[name])
+
+            elif inspect.isfunction(imported_module.__dict__[name]):
+                imported_module.__dict__[name] = decorate(
+                    records,
+                    imported_module.__dict__[name],
+                    set_hook_for_generic,
+                )
+                callables.append(imported_module.__dict__[name])
+
+            elif inspect.isclass(imported_module.__dict__[name]):
+                callables += list_callables_from_class(
+                    records, imported_module, module, name
+                )
+
+    return callables
+
+
+def list_callables_from_class(records, imported_module, module, classname):
+    callables = []
+
+    for name in imported_module.__dict__[classname].__dict__.keys():
+        from_module = getattr(
+            imported_module.__dict__[classname].__dict__[name], "__module__", ""
+        )
+        if from_module and from_module.startswith(module):
+            if not name.startswith("__"):
+                if inspect.iscoroutinefunction(
+                    imported_module.__dict__[classname].__dict__[name]
+                ):
+                    hook = decorate(
+                        records,
+                        imported_module.__dict__[classname].__dict__[name],
+                        set_hook_for_generic_async,
+                    )
+                    setattr(
+                        imported_module.__dict__[classname], name, hook
+                    )  # TypeError: 'mappingproxy' object does not support item assignment
+                    callables.append(hook)
+
+                elif inspect.isfunction(
+                    imported_module.__dict__[classname].__dict__[name]
+                ):
+                    hook = decorate(
+                        records,
+                        imported_module.__dict__[classname].__dict__[name],
+                        set_hook_for_generic,
+                    )
+                    setattr(imported_module.__dict__[classname], name, hook)
+                    callables.append(hook)
+
+    return callables

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/hooks/httpx.py

@@ -1,12 +1,14 @@
 # -*- coding: utf-8 -*-
 from contextlib import contextmanager
 import traceback
+from typing import Generator
 
 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):
@@ -62,7 +64,7 @@ def set_hook_for_httpx(records, method):
 
 
 @contextmanager
-def hook_httpx(records):
+def hook_httpx(records: HTTPRecords) -> Generator[None, None, None]:
     hooks = False
     try:
         import httpx
@@ -88,6 +90,9 @@ def hook_httpx(records):
         httpx.AsyncClient.options = decorate(
             records, httpx.AsyncClient.options, set_hook_for_httpx_async
         )
+        httpx.AsyncClient.request = decorate(
+            records, httpx.AsyncClient.request, set_hook_for_httpx_async
+        )
 
         httpx.get = decorate(records, httpx.get, set_hook_for_httpx)
         httpx.post = decorate(records, httpx.post, set_hook_for_httpx)
@@ -96,6 +101,7 @@ def hook_httpx(records):
         httpx.delete = decorate(records, httpx.delete, set_hook_for_httpx)
         httpx.head = decorate(records, httpx.head, set_hook_for_httpx)
         httpx.options = decorate(records, httpx.options, set_hook_for_httpx)
+        httpx.request = decorate(records, httpx.request, set_hook_for_httpx)
 
         hooks = True
     except ImportError:
@@ -111,6 +117,7 @@ def hook_httpx(records):
         httpx.AsyncClient.delete = undecorate(httpx.AsyncClient.delete)
         httpx.AsyncClient.head = undecorate(httpx.AsyncClient.head)
         httpx.AsyncClient.options = undecorate(httpx.AsyncClient.options)
+        httpx.AsyncClient.request = undecorate(httpx.AsyncClient.request)
 
         httpx.get = undecorate(httpx.get)
         httpx.post = undecorate(httpx.post)
@@ -119,3 +126,4 @@ def hook_httpx(records):
         httpx.delete = undecorate(httpx.delete)
         httpx.head = undecorate(httpx.head)
         httpx.options = undecorate(httpx.options)
+        httpx.request = undecorate(httpx.request)

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/hooks/requests.py

@@ -1,12 +1,14 @@
 # -*- coding: utf-8 -*-
 from contextlib import contextmanager
 import traceback
+from typing import Generator
 
 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):
@@ -36,7 +38,7 @@ def set_hook_for_requests(records, method):
 
 
 @contextmanager
-def hook_requests(records):
+def hook_requests(records: HTTPRecords) -> Generator[None, None, None]:
     hooks = False
     try:
         import requests

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/hooks/socket.py

@@ -6,11 +6,13 @@ import platform
 import socket
 import ssl
 import sys
+from typing import Generator
 
 from httpdbg.hooks.utils import getcallargs
 from httpdbg.hooks.utils import decorate
 from httpdbg.hooks.utils import undecorate
 from httpdbg.records import HTTPRecord
+from httpdbg.records import HTTPRecords
 from httpdbg.utils import logger
 
 
@@ -334,7 +336,7 @@ def set_hook_for_sslobject_read(records, method):
 
 
 @contextmanager
-def hook_socket(records):
+def hook_socket(records: HTTPRecords) -> Generator[None, None, None]:
     socket.socket.__init__ = decorate(
         records, socket.socket.__init__, set_hook_for_socket_init
     )
@@ -386,9 +388,9 @@ def hook_socket(records):
 
     # only for async HTTP requests (not HTTPS) on Windows
     if (platform.system().lower() == "windows") and (sys.version_info >= (3, 7)):
-        asyncio.proactor_events._ProactorReadPipeTransport._data_received = decorate(
+        asyncio.proactor_events._ProactorReadPipeTransport._data_received = decorate(  # type: ignore
             records,
-            asyncio.proactor_events._ProactorReadPipeTransport._data_received,
+            asyncio.proactor_events._ProactorReadPipeTransport._data_received,  # type: ignore
             set_hook_for_socket_recv_into,
         )
         asyncio.proactor_events._ProactorBaseWritePipeTransport.write = decorate(
@@ -426,8 +428,8 @@ def hook_socket(records):
 
     # only for async HTTP requests (not HTTPS) on Windows
     if (platform.system().lower() == "windows") and (sys.version_info >= (3, 7)):
-        asyncio.proactor_events._ProactorReadPipeTransport._data_received = undecorate(
-            asyncio.proactor_events._ProactorReadPipeTransport._data_received
+        asyncio.proactor_events._ProactorReadPipeTransport._data_received = undecorate(  # type: ignore
+            asyncio.proactor_events._ProactorReadPipeTransport._data_received  # type: ignore
         )
         asyncio.proactor_events._ProactorBaseWritePipeTransport.write = undecorate(
             asyncio.proactor_events._ProactorBaseWritePipeTransport.write

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/hooks/urllib3.py

@@ -1,12 +1,14 @@
 # -*- coding: utf-8 -*-
 from contextlib import contextmanager
 import traceback
+from typing import Generator
 
 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):
@@ -36,7 +38,7 @@ def set_hook_for_urllib3(records, method):
 
 
 @contextmanager
-def hook_urllib3(records):
+def hook_urllib3(records: HTTPRecords) -> Generator[None, None, None]:
     hooks = False
     try:
         import urllib3
@@ -56,3 +58,6 @@ def hook_urllib3(records):
 
     if hooks:
         urllib3.PoolManager.request = undecorate(urllib3.PoolManager.request)
+        urllib3.HTTPConnectionPool.request = undecorate(
+            urllib3.HTTPConnectionPool.request
+        )

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg/initiator.py

@@ -82,9 +82,10 @@ def get_current_instruction(
 
     n_stack = -1
     framesummary = extracted_stack[-2]
-    if framesummary.name == "__aenter__":
-        n_stack = -2
-        framesummary = extracted_stack[-3]
+    if "asyncio" in framesummary.filename:
+        while "asyncio" in framesummary.filename:
+            n_stack -= 1
+            framesummary = extracted_stack[n_stack - 1]
 
     instruction = ""
     short_stack = f'File "{framesummary.filename}", line {framesummary.lineno}, in {framesummary.name}\n'

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.10.0
+Version: 0.11.0
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0
@@ -19,11 +19,13 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 
 [![Build Status](https://github.com/cle-b/httpdbg/workflows/Build/badge.svg?branch=main)](https://github.com/cle-b/httpdbg/actions?query=workflow%3ABuild) [![PyPI version](https://badge.fury.io/py/httpdbg.svg)](https://badge.fury.io/py/httpdbg) [![Coverage Status](https://coveralls.io/repos/github/cle-b/httpdbg/badge.svg?branch=main)](https://coveralls.io/github/cle-b/httpdbg?branch=main)
+
 # httpdbg
 
 A very simple tool to debug HTTP(S) client requests.
 
-![ui](ui.png)
+![](ui.png)
+
 ## installation 
 
 ```
@@ -79,15 +81,28 @@ For example, you can view which HTTP requests are performed by `pip` when you in
 pyhttpdbg -m pip install httpdbg --upgrade
 ```
 
+## 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. 
+
+To add a new package in the list of initiators, you can use the `-i` command line argument:
+
+```sh
+pyhttpdbg -i api_client_pck --script my_script.py
+```
+
+You can use any package as an initiator, this is not limited to HTTP requests.
 
-## Supported libraries
+### Already supported packages
 
-| library    | status      | 
-|------------|-------------|
-| requests   | supported   |
-| urllib3    | supported   |
-| httpx      | supported   |
-| aiohttp    | supported   |
+| packages       | status                              | 
+|----------------|-------------------------------------|
+| requests       | supported                           |
+| urllib3        | supported                           |
+| httpx          | supported                           |
+| aiohttp        | supported                           |
+| pytest         | supported                           |
+| _your_package_ | yes, with the arg _-i your_package_ |
 
 ## configuration
 
@@ -96,20 +111,19 @@ No configuration is necessary to start but some few settings are available for p
 ### command line
 
 ```
-usage: pyhttpdbg [-h] [--port PORT] [--version] [--keep-up | --force-quit]
+usage: pyhttpdbg [-h] [--port PORT] [--version] [--initiator INITIATOR] [--keep-up | --force-quit]
                  [--console | --module MODULE | --script SCRIPT]
 
 httdbg - a very simple tool to debug HTTP(S) client requests
 
 options:
   -h, --help            show this help message and exit
-  --version, -v         print the httpdbg version
-
   --port PORT, -p PORT  the web interface port
-  
+  --version, -v         print the httpdbg version
+  --initiator INITIATOR, -i INITIATOR
+                        add a new initiator (package)
   --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)
   --module MODULE, -m MODULE
                         run library module as a script (the next args are passed to pytest as is)

{httpdbg-0.10.0 → httpdbg-0.11.0}/httpdbg.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ httpdbg.egg-info/top_level.txt
 httpdbg/hooks/__init__.py
 httpdbg/hooks/aiohttp.py
 httpdbg/hooks/all.py
+httpdbg/hooks/generic.py
 httpdbg/hooks/httpx.py
 httpdbg/hooks/requests.py
 httpdbg/hooks/socket.py

{httpdbg-0.10.0 → httpdbg-0.11.0}/pyproject.toml

@@ -39,4 +39,5 @@ version = {attr = "httpdbg.VERSION"}
 
 [tool.mypy]
 no_implicit_optional = false
+disable_error_code= ["method-assign",]
 files = ["httpdbg"]

{httpdbg-0.10.0 → httpdbg-0.11.0}/tests/test_hook_aiohttp.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+import platform
 import sys
 
 import aiohttp
@@ -213,6 +214,10 @@ async def test_aiohttp_cookies_secure(httpbin_secure):
 
 @pytest.mark.aiohttp
 @pytest.mark.asyncio
+@pytest.mark.xfail(
+    platform.system().lower() == "windows",
+    reason="flaky on Windows (sometimes only one request is recorded)",
+)
 async def test_aiohttp_redirect(httpbin_both):
     with httpdbg() as records:
         async with aiohttp.ClientSession(

httpdbg-0.11.0/tests/test_initiator.py

@@ -0,0 +1,168 @@
+# -*- coding: utf-8 -*-
+import asyncio
+import platform
+import sys
+
+import pytest
+import requests
+
+from httpdbg.hooks.all import httpdbg
+
+
+@pytest.mark.xfail(
+    platform.system().lower() == "windows",
+    reason="problem with stack view in windows",
+)
+@pytest.mark.initiator
+def test_initiator_script(httpbin, monkeypatch):
+    with monkeypatch.context() as m:
+        m.delenv("PYTEST_CURRENT_TEST")
+        with httpdbg() as records:
+            requests.get(f"{httpbin.url}/get")
+
+    assert len(records) == 1
+    http_record = records[0]
+
+    assert http_record.initiator.short_label == 'requests.get(f"{httpbin.url}/get")'
+    assert http_record.initiator.long_label is None
+
+    assert (
+        """test_initiator.py", line 21, in test_initiator_script
+ 21.             requests.get(f"{httpbin.url}/get")
+----------
+requests.api.get(
+    url="""
+        + f"{httpbin.url}/get"
+        + """
+)"""
+        in http_record.initiator.short_stack
+    )
+
+    assert (
+        """test_initiator.py", line 21, 
+ 17. def test_initiator_script(httpbin, monkeypatch):
+ 18.     with monkeypatch.context() as m:
+ 19.         m.delenv("PYTEST_CURRENT_TEST")
+ 20.         with httpdbg() as records:
+ 21.             requests.get(f"{httpbin.url}/get") <====
+ 22. 
+ 23.     assert len(records) == 1
+ 24.     http_record = records[0]
+ 25. 
+ 26.     assert http_record.initiator.short_label == \'requests.get(f"{httpbin.url}/get")\'
+ 27.     assert http_record.initiator.long_label is None
+ 28."""  # noqa W291
+        in http_record.initiator.stack[0]
+    )
+
+
+@pytest.mark.initiator
+def test_initiator_same_line_different_initiators(httpbin, monkeypatch):
+    with monkeypatch.context() as m:
+        m.delenv("PYTEST_CURRENT_TEST")
+        with httpdbg() as records:
+            for i in range(2):
+                requests.get(f"{httpbin.url}/get")
+
+    assert len(records) == 2
+
+    assert records[0].initiator is not records[1].initiator
+    assert records[0].initiator.id != records[1].initiator.id
+    assert records[0].initiator == records[1].initiator
+
+
+@pytest.mark.initiator
+def test_initiator_redirection_same_initiator(httpbin, monkeypatch):
+    with monkeypatch.context() as m:
+        m.delenv("PYTEST_CURRENT_TEST")
+        with httpdbg() as records:
+            requests.get(
+                f"{httpbin.url}/redirect-to?url={httpbin.url}/get", verify=False
+            )
+
+    assert len(records) == 2
+
+    assert records[0].initiator is records[1].initiator
+
+
+@pytest.mark.initiator
+@pytest.mark.xfail(
+    platform.system().lower() == "windows",
+    reason="problem with stack view in windows",
+)
+def test_initiator_pytest(httpbin):
+    with httpdbg() as records:
+        requests.get(f"{httpbin.url}/get")
+
+    assert len(records) == 1
+
+    assert records[0].initiator.short_label == "test_initiator_pytest"
+    assert (
+        records[0].initiator.long_label
+        == "tests/test_initiator.py::test_initiator_pytest"
+    )
+    assert 'requests.get(f"{httpbin.url}/get")' in records[0].initiator.short_stack
+    assert 'requests.get(f"{httpbin.url}/get") <===' in records[0].initiator.stack[0]
+
+
+@pytest.mark.initiator
+def test_initiator_add_package_fnc(httpbin, monkeypatch):
+    with monkeypatch.context() as m:
+        m.delenv("PYTEST_CURRENT_TEST")
+
+        # all cases must be tested in the same test
+        with httpdbg(initiators=["initiator_pck"]) as records:
+            from initiator_pck.initiator2.mod2 import fnc_in_subpackage
+            from initiator_pck.mod1 import fnc_in_package
+            from initiator_pck import fnc_async
+            from initiator_pck.initiator2.initiator3 import fnc_in_init
+            from initiator_pck.initiator2.mod2 import FakeClient
+
+            fnc_in_package(f"{httpbin.url}/get")
+            fnc_in_subpackage(f"{httpbin.url}/get")
+            fnc_in_init(f"{httpbin.url}/get")
+            FakeClient().navigate(f"{httpbin.url}/get")
+            if sys.version_info >= (3, 7):
+                asyncio.run(fnc_async(f"{httpbin.url}/get"))
+
+        # function in a package
+        assert (
+            records[0].initiator.short_label == 'fnc_in_package(f"{httpbin.url}/get")'
+        )
+
+        # function in a sub package (no __init__)
+        assert (
+            records[1].initiator.short_label
+            == 'fnc_in_subpackage(f"{httpbin.url}/get")'
+        )
+
+        # function in a __init__.py file
+        assert records[2].initiator.short_label == 'fnc_in_init(f"{httpbin.url}/get")'
+
+        # method
+        assert (
+            records[3].initiator.short_label
+            == 'FakeClient().navigate(f"{httpbin.url}/get")'
+        )
+
+        # async function in a package
+        if sys.version_info >= (3, 7):
+            assert (
+                records[4].initiator.short_label
+                == 'asyncio.run(fnc_async(f"{httpbin.url}/get"))'
+            )
+
+        with httpdbg() as records:
+            fnc_in_package(f"{httpbin.url}/get")
+            fnc_in_subpackage(f"{httpbin.url}/get")
+            fnc_in_init(f"{httpbin.url}/get")
+            FakeClient().navigate(f"{httpbin.url}/get")
+            if sys.version_info >= (3, 7):
+                asyncio.run(fnc_async(f"{httpbin.url}/get"))
+
+        assert records[0].initiator.short_label == "requests.get(url)"
+        assert records[1].initiator.short_label == "requests.get(url)  # subpackage"
+        assert records[2].initiator.short_label == "requests.get(url)  # init"
+        assert records[3].initiator.short_label == "requests.get(url)  # method"
+        if sys.version_info >= (3, 7):
+            assert records[4].initiator.short_label == "await client.get(url)"

httpdbg-0.10.0/tests/test_initiator.py

@@ -1,103 +0,0 @@
-# -*- coding: utf-8 -*-
-import platform
-
-import pytest
-import requests
-
-from httpdbg.hooks.all import httpdbg
-
-
-@pytest.mark.xfail(
-    platform.system().lower() == "windows",
-    reason="problem with stack view in windows",
-)
-@pytest.mark.initiator
-def test_initiator_script(httpbin, monkeypatch):
-    with monkeypatch.context() as m:
-        m.delenv("PYTEST_CURRENT_TEST")
-        with httpdbg() as records:
-            requests.get(f"{httpbin.url}/get")
-
-    assert len(records) == 1
-    http_record = records[0]
-
-    assert http_record.initiator.short_label == 'requests.get(f"{httpbin.url}/get")'
-    assert http_record.initiator.long_label is None
-
-    assert (
-        """test_initiator.py", line 19, in test_initiator_script
- 19.             requests.get(f"{httpbin.url}/get")
-----------
-requests.api.get(
-    url="""
-        + f"{httpbin.url}/get"
-        + """
-)"""
-        in http_record.initiator.short_stack
-    )
-
-    assert (
-        """test_initiator.py", line 19, 
- 15. def test_initiator_script(httpbin, monkeypatch):
- 16.     with monkeypatch.context() as m:
- 17.         m.delenv("PYTEST_CURRENT_TEST")
- 18.         with httpdbg() as records:
- 19.             requests.get(f"{httpbin.url}/get") <====
- 20. 
- 21.     assert len(records) == 1
- 22.     http_record = records[0]
- 23. 
- 24.     assert http_record.initiator.short_label == \'requests.get(f"{httpbin.url}/get")\'
- 25.     assert http_record.initiator.long_label is None
- 26."""  # noqa W291
-        in http_record.initiator.stack[0]
-    )
-
-
-@pytest.mark.initiator
-def test_initiator_same_line_different_initiators(httpbin, monkeypatch):
-    with monkeypatch.context() as m:
-        m.delenv("PYTEST_CURRENT_TEST")
-        with httpdbg() as records:
-            for i in range(2):
-                requests.get(f"{httpbin.url}/get")
-
-    assert len(records) == 2
-
-    assert records[0].initiator is not records[1].initiator
-    assert records[0].initiator.id != records[1].initiator.id
-    assert records[0].initiator == records[1].initiator
-
-
-@pytest.mark.initiator
-def test_initiator_redirection_same_initiator(httpbin, monkeypatch):
-    with monkeypatch.context() as m:
-        m.delenv("PYTEST_CURRENT_TEST")
-        with httpdbg() as records:
-            requests.get(
-                f"{httpbin.url}/redirect-to?url={httpbin.url}/get", verify=False
-            )
-
-    assert len(records) == 2
-
-    assert records[0].initiator is records[1].initiator
-
-
-@pytest.mark.initiator
-@pytest.mark.xfail(
-    platform.system().lower() == "windows",
-    reason="problem with stack view in windows",
-)
-def test_initiator_pytest(httpbin):
-    with httpdbg() as records:
-        requests.get(f"{httpbin.url}/get")
-
-    assert len(records) == 1
-
-    assert records[0].initiator.short_label == "test_initiator_pytest"
-    assert (
-        records[0].initiator.long_label
-        == "tests/test_initiator.py::test_initiator_pytest"
-    )
-    assert 'requests.get(f"{httpbin.url}/get")' in records[0].initiator.short_stack
-    assert 'requests.get(f"{httpbin.url}/get") <===' in records[0].initiator.stack[0]