httpdbg 0.27.0__tar.gz → 0.28.0__tar.gz

{httpdbg-0.27.0 → httpdbg-0.28.0}/PKG-INFO

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

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/__init__.py

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

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/__main__.py

@@ -5,6 +5,7 @@ import time
 from httpdbg import __version__
 from httpdbg.args import read_args
 from httpdbg.hooks.all import httprecord
+from httpdbg.log import set_env_for_logging
 from httpdbg.server import httpdbg_srv
 from httpdbg.mode_console import run_console
 from httpdbg.mode_module import run_module
@@ -18,6 +19,9 @@ def print_msg(msg):
 
 
 def pyhttpdbg(params, subparams, test_mode=False):
+
+    set_env_for_logging(params.log_level, params.log)
+
     url = f"http://{params.host}:{params.port}/{'?hi=on' if params.console else ''}"
 
     print_msg(f"  httpdbg - HTTP(S) requests available at {url}")

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/args.py

@@ -1,7 +1,10 @@
 # -*- coding: utf-8 -*-
 import argparse
+from pathlib import Path
 from typing import List, Tuple
 
+from httpdbg.log import LogLevel
+
 
 def read_args(args: List[str]) -> Tuple[argparse.Namespace, List[str]]:
     httpdbg_args = args
@@ -49,6 +52,16 @@ def read_args(args: List[str]) -> Tuple[argparse.Namespace, List[str]]:
         help="stop the server even if the requests have not been read",
     )
 
+    parser.add_argument(
+        "--log-level",
+        type=LogLevel,
+        choices=LogLevel,
+        default=LogLevel.WARNING,
+        help="The log level",
+    )
+
+    parser.add_argument("--log", type=Path, help="Path to the log file.")
+
     actions = parser.add_mutually_exclusive_group()
 
     actions.add_argument(

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/env.py

@@ -1,4 +1,6 @@
 HTTPDBG_CURRENT_INITIATOR = "HTTPDBG_CURRENT_INITIATOR"
 HTTPDBG_CURRENT_TAG = "HTTPDBG_CURRENT_TAG"
-HTTPDBG_LOG = "HTTPDBG_LOG"
 HTTPDBG_SUBPROCESS_DIR = "HTTPDBG_SUBPROCESS_DIR"
+
+HTTPDBG_LOG_LEVEL = "HTTPDBG_LOG_LEVEL"
+HTTPDBG_LOG_PATH = "HTTPDBG_LOG_PATH"

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/hooks/generic.py

@@ -15,11 +15,11 @@ 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
+from httpdbg.log import logger
 
 
 def set_hook_for_generic_async(records: HTTPRecords, method: Any):
-    logger.info(f"SET_HOOK_FOR_GENERIC_ASYNC {method}")
+    logger().info(f"SET_HOOK_FOR_GENERIC_ASYNC {method}")
 
     async def hook(*args, **kwargs):
         with httpdbg_initiator(
@@ -33,7 +33,7 @@ def set_hook_for_generic_async(records: HTTPRecords, method: Any):
 
 
 def set_hook_for_generic(records: HTTPRecords, method: Any):
-    logger.info(f"SET_HOOK_FOR_GENERIC {method}")
+    logger().info(f"SET_HOOK_FOR_GENERIC {method}")
 
     def hook(*args, **kwargs):
         with httpdbg_initiator(
@@ -56,11 +56,11 @@ def hook_generic(
         initiators = []
 
     for initiator in initiators:
-        logger.info(f"HOOK_GENERIC add initiator - {initiator}")
+        logger().info(f"HOOK_GENERIC add initiator - {initiator}")
         hooks += list_callables_from_package(records, initiator)
 
     try:
-        logger.info(
+        logger().info(
             f"HOOK_GENERIC add initiator - hooks - {[hook.__httpdbg__.__name__ for hook in hooks]}"
         )
     except Exception:
@@ -77,7 +77,7 @@ def list_callables_from_package(records: HTTPRecords, package: str) -> List[Any]
     callables = []
 
     try:
-        logger.info(f"LIST_CALLABLES_FROM_PACKAGE {package}")
+        logger().info(f"LIST_CALLABLES_FROM_PACKAGE {package}")
 
         callables += list_callables_from_module(records, package)
 
@@ -96,7 +96,7 @@ def list_callables_from_package(records: HTTPRecords, package: str) -> List[Any]
                             records, f"{package}.{file_or_dir.name}"
                         )
     except Exception as ex:
-        logger.info(f"LIST_CALLABLES_FROM_PACKAGE {package} - error - {str(ex)}")
+        logger().info(f"LIST_CALLABLES_FROM_PACKAGE {package} - error - {str(ex)}")
 
     return callables
 
@@ -105,7 +105,7 @@ def list_callables_from_module(records: HTTPRecords, module: str) -> List[Any]:
     callables = []
 
     try:
-        logger.info(f"LIST_CALLABLES_FROM_MODULE {module}")
+        logger().info(f"LIST_CALLABLES_FROM_MODULE {module}")
 
         imported_module = importlib.import_module(module)
 
@@ -141,7 +141,7 @@ def list_callables_from_module(records: HTTPRecords, module: str) -> List[Any]:
                         records, imported_module, module, name
                     )
     except Exception as ex:
-        logger.info(f"LIST_CALLABLES_FROM_MODULE {module} - error - {str(ex)}")
+        logger().info(f"LIST_CALLABLES_FROM_MODULE {module} - error - {str(ex)}")
 
     return callables
 
@@ -155,7 +155,7 @@ def list_callables_from_class(
     callables = []
 
     try:
-        logger.info(f"LIST_CALLABLES_FROM_CLASS {module}.{classname}")
+        logger().info(f"LIST_CALLABLES_FROM_CLASS {module}.{classname}")
         for name in imported_module.__dict__[classname].__dict__.keys():
             from_module = getattr(
                 imported_module.__dict__[classname].__dict__[name], "__module__", ""
@@ -192,7 +192,7 @@ def list_callables_from_class(
                         setattr(imported_module.__dict__[classname], name, hook)
                         callables.append(hook)
     except Exception as ex:
-        logger.info(
+        logger().info(
             f"LIST_CALLABLES_FROM_CLASS {module}.{classname} - error - {str(ex)}"
         )
 

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/hooks/socket.py

@@ -13,7 +13,7 @@ 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
+from httpdbg.log import logger
 
 
 def set_hook_for_socket_init(records, method):
@@ -29,7 +29,7 @@ def set_hook_for_socket_connect(records, method):
     def hook(self, address):
         socketdata = records.get_socket_data(self, force_new=True)
         if socketdata:
-            logger.info(
+            logger().info(
                 f"CONNECT - self={self} id={id(self)} socketdata={socketdata} address={address}"
             )
 
@@ -67,13 +67,13 @@ def set_hook_for_ssl_wrap_socket(records, method):
 
             raise
 
-        logger.info(
+        logger().info(
             f"WRAP_SOCKET - {type(sock)}={id(sock)} {type(sslsocket)}={id(sslsocket)}"
         )
 
         socketdata = records.move_socket_data(sslsocket, sock)
         if socketdata:
-            logger.info(f"WRAP_SOCKET * - socketdata={socketdata}")
+            logger().info(f"WRAP_SOCKET * - socketdata={socketdata}")
 
         return sslsocket
 
@@ -94,13 +94,13 @@ def set_hook_for_sslcontext_wrap_socket(records, method):
 
             raise
 
-        logger.info(
+        logger().info(
             f"WRAP_SOCKET (SSLContext) - {type(self)}={id(self)}  {type(sock)}={id(sock)} {type(sslsocket)}={id(sslsocket)}"
         )
 
         socketdata = records.move_socket_data(sslsocket, sock)
         if socketdata:
-            logger.info(f"WRAP_SOCKET (SSLContext) * - socketdata={socketdata}")
+            logger().info(f"WRAP_SOCKET (SSLContext) * - socketdata={socketdata}")
 
         return sslsocket
 
@@ -121,13 +121,13 @@ def set_hook_for_socket_wrap_bio(records, method):
 
             raise
 
-        logger.info(
+        logger().info(
             f"WRAP_SOCKET_BIO - {type(self)}={id(self)} {type(sslobject)}={id(sslobject)}"
         )
 
         socketdata = records.get_socket_data(sslobject, self)
         if socketdata:
-            logger.info(f"WRAP_SOCKET_BIO * - socketdata={socketdata}")
+            logger().info(f"WRAP_SOCKET_BIO * - socketdata={socketdata}")
 
         return sslobject
 
@@ -138,7 +138,7 @@ def set_hook_for_socket_recv_into(records, method):
     def hook(self, buffer, *args, **kwargs):
         socketdata = records.get_socket_data(self)
         if socketdata:
-            logger.info(
+            logger().info(
                 f"RECV_INTO - self={self} id={id(self)} socketdata={socketdata} args={args} kwargs={kwargs}"
             )
 
@@ -150,7 +150,9 @@ def set_hook_for_socket_recv_into(records, method):
             raise
 
         if socketdata and socketdata.record:
-            logger.info(f"RECV_INTO (after) - id={id(self)} buffer={(b''+buffer)[:20]}")
+            logger().info(
+                f"RECV_INTO (after) - id={id(self)} buffer={(b''+buffer)[:20]}"
+            )
             socketdata.record.response.rawdata += buffer[:nbytes]
 
         return nbytes
@@ -162,7 +164,7 @@ def set_hook_for_socket_recv(records, method):
     def hook(self, bufsize, *args, **kwargs):
         socketdata = records.get_socket_data(self)
         if socketdata:
-            logger.info(
+            logger().info(
                 f"RECV - self={self} id={id(self)} socketdata={socketdata} bufsize={bufsize} args={args} kwargs={kwargs}"
             )
 
@@ -185,7 +187,7 @@ def set_hook_for_socket_sendall(records, method):
     def hook(self, bytes, *args, **kwargs):
         socketdata = records.get_socket_data(self, request=True)
         if socketdata:
-            logger.info(
+            logger().info(
                 f"SENDALL - self={self} id={id(self)} socketdata={socketdata} bytes={(b''+bytes)[:20]} type={type(bytes)} len={len(bytes)} args={args} kwargs={kwargs}"
             )
 
@@ -196,7 +198,7 @@ def set_hook_for_socket_sendall(records, method):
                 socketdata.rawdata += bytes
                 http_detected = socketdata.http_detected()
                 if http_detected:
-                    logger.info("SENDALL - http detected")
+                    logger().info("SENDALL - http detected")
                     socketdata.record = HTTPRecord(tbegin=socketdata.tbegin)
                     socketdata.record.initiator = records.get_initiator()
                     socketdata.record.address = socketdata.address
@@ -220,7 +222,7 @@ def set_hook_for_socket_send(records, method):
     def hook(self, bytes, *args, **kwargs):
         socketdata = records.get_socket_data(self, request=True)
         if socketdata:
-            logger.info(
+            logger().info(
                 f"SEND - self={self} id={id(self)} socketdata={socketdata} bytes={(b''+bytes)[:20]} args={args} kwargs={kwargs}"
             )
 
@@ -253,7 +255,7 @@ def set_hook_for_socket_send(records, method):
 
 def set_hook_for_asyncio_create_connection(records, method):
     async def hook(self, *args, **kwargs):
-        logger.info(
+        logger().info(
             f"CREATE_CONNECTION - self={self} id={id(self)} args={args} kwargs={kwargs}"
         )
         r = await method(self, *args, **kwargs)
@@ -266,7 +268,7 @@ def set_hook_for_asyncio_create_connection(records, method):
                 socketdata = records.get_socket_data(
                     ssl_object, sock, force_new=True
                 )  # to link the cnx info to the sslobject
-                logger.info(
+                logger().info(
                     f"CREATE_CONNECTION - ssl_object ssl_object={ssl_object} ssl_objectid={id(ssl_object)} socketdata={socketdata}"
                 )
         return r
@@ -276,10 +278,10 @@ def set_hook_for_asyncio_create_connection(records, method):
 
 def set_hook_for_sslobject_write(records, method):
     def hook(self, buf, *args, **kwargs):
-        logger.info(f"WRITE - {type(self)}={id(self)} buf={(b'' + buf)[:20]}")
+        logger().info(f"WRITE - {type(self)}={id(self)} buf={(b'' + buf)[:20]}")
         socketdata = records.get_socket_data(self, request=True)
         if socketdata:
-            logger.info(f"WRITE * - socketdata={socketdata}")
+            logger().info(f"WRITE * - socketdata={socketdata}")
 
         try:
             size = method(self, buf, *args, **kwargs)
@@ -310,10 +312,10 @@ def set_hook_for_sslobject_write(records, method):
 
 def set_hook_for_sslobject_read(records, method):
     def hook(self, *args, **kwargs):
-        logger.info(f"READ - {type(self)}={id(self)}")
+        logger().info(f"READ - {type(self)}={id(self)}")
         socketdata = records.get_socket_data(self)
         if socketdata:
-            logger.info(f"READ * - socketdata={socketdata}")
+            logger().info(f"READ * - socketdata={socketdata}")
 
         try:
             r = method(self, *args, **kwargs)

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/hooks/utils.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 import inspect
 
-from httpdbg.utils import logger
+from httpdbg.log import logger
 
 
 def getcallargs(original_method, *args, **kwargs):
@@ -15,7 +15,7 @@ def getcallargs(original_method, *args, **kwargs):
             inspect.signature(original_method).bind_partial(*args, **kwargs).arguments
         )
     except Exception as ex:
-        logger.info(f"getcallargs - exception {str(ex)}")
+        logger().info(f"getcallargs - exception {str(ex)}")
         # TypeError('too many positional arguments') may occur when using pytest (seems related to teardown_method)
         callargs = {}
         i = 0
@@ -24,7 +24,7 @@ def getcallargs(original_method, *args, **kwargs):
             callargs[f"_positional_argument{i}"] = arg
 
     callargs.update(kwargs)
-    logger.info(f"getcallargs {original_method} - {[arg for arg in callargs]}")
+    logger().info(f"getcallargs {original_method} - {[arg for arg in callargs]}")
     return callargs
 
 

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/initiator.py

@@ -12,7 +12,7 @@ from httpdbg.env import HTTPDBG_CURRENT_INITIATOR
 from httpdbg.env import HTTPDBG_CURRENT_TAG
 from httpdbg.hooks.utils import getcallargs
 from httpdbg.utils import get_new_uuid
-from httpdbg.utils import logger
+from httpdbg.log import logger
 
 
 class Initiator(object):
@@ -127,7 +127,7 @@ def get_current_instruction(
             short_stack += f"{instruction}\n"
             stack = []
     except Exception as ex:
-        logger.info(
+        logger().info(
             f"GET_CURRENT_INSTRUCTION [{str(extracted_stack)}] - error - {str(ex)}"
         )
 
@@ -175,7 +175,7 @@ def extract_short_stack_from_file(
                     if end_of_instruction_found and stop_if_instruction_ends:
                         break
     except Exception as ex:
-        logger.info(
+        logger().info(
             f"EXTRACT_SHORT_STACK_FROM_FILE {filename} lineno={lineno} before={before} after={after}- error - {str(ex)}"
         )
 

httpdbg-0.28.0/httpdbg/log.py

@@ -0,0 +1,59 @@
+from enum import Enum
+from functools import cache
+import logging
+import os
+from pathlib import Path
+from typing import Union
+
+from httpdbg.env import HTTPDBG_LOG_LEVEL
+from httpdbg.env import HTTPDBG_LOG_PATH
+
+
+class LogLevel(Enum):
+    NOTSET = "notset"
+    DEBUG = "debug"
+    INFO = "info"
+    WARNING = "warning"
+    ERROR = "error"
+    CRITICAL = "critical"
+
+
+def set_env_for_logging(log_level: LogLevel, path: Union[Path, None]):
+
+    os.environ[HTTPDBG_LOG_LEVEL] = str(
+        {
+            "NOTSET": logging.NOTSET,
+            "DEBUG": logging.DEBUG,
+            "INFO": logging.INFO,
+            "WARNING": logging.WARNING,
+            "ERROR": logging.ERROR,
+            "CRITICAL": logging.CRITICAL,
+        }[log_level.value.upper()]
+    )
+
+    if path:
+        os.environ[HTTPDBG_LOG_PATH] = str(path)
+
+
+@cache
+def logger() -> logging.Logger:
+
+    logger = logging.getLogger()
+    log_level = int(os.environ.get(HTTPDBG_LOG_LEVEL, logging.WARNING))
+    logger.setLevel(log_level)
+
+    formatter = logging.Formatter(
+        "¤ %(asctime)s.%(msecs)03d (%(process)d) [%(levelname)s] %(message)s",
+        datefmt="%H:%M:%S",
+    )
+
+    if HTTPDBG_LOG_PATH in os.environ:
+        file_handler = logging.FileHandler(os.environ[HTTPDBG_LOG_PATH])
+        file_handler.setFormatter(formatter)
+        logger.addHandler(file_handler)
+    else:
+        console_handler = logging.StreamHandler()
+        console_handler.setFormatter(formatter)
+        logger.addHandler(console_handler)
+
+    return logger

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/records.py

@@ -20,7 +20,7 @@ from httpdbg.utils import get_new_uuid
 from httpdbg.utils import chunked_to_bytes
 from httpdbg.utils import list_cookies_headers_request_simple_cookies
 from httpdbg.utils import list_cookies_headers_response_simple_cookies
-from httpdbg.utils import logger
+from httpdbg.log import logger
 
 
 class SocketRawData(object):
@@ -38,7 +38,7 @@ class SocketRawData(object):
 
     @rawdata.setter
     def rawdata(self, value: bytes) -> None:
-        logger.info(
+        logger().info(
             f"SocketRawData id={self.id} newdata={value[:20]!r} len={len(value)}"
         )
         self._rawdata = value
@@ -407,6 +407,6 @@ class HTTPRecords:
 
     def del_socket_data(self, obj):
         if id(obj) in self._sockets:
-            logger.info(f"SocketRawData del id={id(obj)}")
+            logger().info(f"SocketRawData del id={id(obj)}")
             self._sockets[id(obj)] = None
             del self._sockets[id(obj)]

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/utils.py

@@ -1,20 +1,9 @@
 # -*- coding: utf-8 -*-
 from http.cookies import SimpleCookie
-import logging
-import os
 import secrets
 import string
 from typing import List
 
-from httpdbg.env import HTTPDBG_LOG
-
-logger = logging.getLogger("httpdbg")
-logger.setLevel(100)
-log_level = os.environ.get(HTTPDBG_LOG)
-if log_level is not None:
-    logging.basicConfig(level=int(log_level), format="%(message)s")
-    logger.setLevel(int(log_level))
-
 
 def get_new_uuid() -> str:
     # important - the uuid must be compatible with method naming rules

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg/webapp/app.py

@@ -9,7 +9,7 @@ import re
 from urllib.parse import urlparse, parse_qs
 
 from httpdbg import __version__
-from httpdbg.utils import logger
+from httpdbg.log import logger
 from httpdbg.webapp.api import RequestListPayload, RequestPayload
 
 
@@ -18,7 +18,7 @@ def silently_catch_error():
     try:
         yield
     except Exception as ex:
-        logger.info(f"HttpbgHTTPRequestHandler - silently_catch_error - {str(ex)}")
+        logger().info(f"HttpbgHTTPRequestHandler - silently_catch_error - {str(ex)}")
 
 
 class HttpbgHTTPRequestHandler(BaseHTTPRequestHandler):

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg.egg-info/PKG-INFO

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

{httpdbg-0.27.0 → httpdbg-0.28.0}/httpdbg.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ httpdbg/args.py
 httpdbg/env.py
 httpdbg/exception.py
 httpdbg/initiator.py
+httpdbg/log.py
 httpdbg/mode_console.py
 httpdbg/mode_module.py
 httpdbg/mode_script.py