qa-testing-utils 0.0.9__py3-none-any.whl → 0.0.10__py3-none-any.whl

qa_testing_utils/__init__.py

@@ -1 +1 @@
-__version__ = '0.0.9'
+__version__ = '0.0.10'

qa_testing_utils/logger.py

@@ -2,14 +2,98 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+from dataclasses import dataclass
 import inspect
 import logging
 from functools import cached_property, wraps
-from typing import Callable, ParamSpec, TypeVar, cast, final
+from typing import Callable, ClassVar, ParamSpec, TypeVar, cast, final
 
 import allure
+from qa_testing_utils.object_utils import classproperty
 from qa_testing_utils.string_utils import EMPTY_STRING, LF
+from qa_testing_utils.thread_utils import ThreadLocal
 
+P = ParamSpec('P')
+R = TypeVar('R')
+
+@dataclass
+class Context:
+    """Per-thread context for reporting and logging, allowing dynamic formatting of messages."""
+    _local: ClassVar[ThreadLocal['Context']]
+    _context_fn: Callable[[str], str]
+
+    @classproperty
+    def _apply(cls) -> Callable[[str], str]:
+        return Context._local.get()._context_fn
+
+    @staticmethod
+    def set(context_fn: Callable[[str], str]) -> None:
+        """Sets per-thread context function to be used for formatting report and log messages."""
+        return Context._local.set(Context(context_fn))
+    
+    @staticmethod
+    def traced(func: Callable[P, R]) -> Callable[P, R]:
+        """
+        Decorator to log function entry, arguments, and return value at DEBUG level.
+
+        Also adds an Allure step for reporting. Use on methods where tracing is useful
+        for debugging or reporting.
+
+        Example:
+            @Context.traced
+            def my_method(self, x):
+                ...
+
+        Args:
+            func (Callable[P, R]): The function to be decorated.
+            *args (Any): Positional arguments to be passed to the function.
+            **kwargs (Any): Keyword arguments to be passed to the function.
+
+        Returns:
+            Callable[P, R]: The result of the function call.
+        """
+        @wraps(func)
+        def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+            # NOTE: each time a decorated function is called this logic will be
+            # re-evaluated.
+            signature = inspect.signature(func)
+            parameters = list(signature.parameters.keys())
+
+            if parameters and parameters[0] == 'self' and len(args) > 0:
+                instance = args[0]
+                logger = logging.getLogger(f"{instance.__class__.__name__}")
+                logger.debug(f">>> "
+                    + Context._apply(
+                        f"{func.__name__} "
+                        f"{", ".join([str(arg) for arg in args[1:]])} "
+                        f"{LF.join(
+                            f"{key}={str(value)}"
+                            for key, value in kwargs.items()) if kwargs else EMPTY_STRING}"))
+
+                with allure.step(  # type: ignore
+                    Context._apply(
+                        f"{func.__name__} "
+                        f"{', '.join([str(arg) for arg in args[1:]])}")):
+                    result = func(*args, **kwargs)
+
+                if result == instance:
+                    logger.debug(f"<<< " + Context._apply(f"{func.__name__}"))
+                else:
+                    logger.debug(f"<<< " + Context._apply(f"{func.__name__} {result}"))
+
+                return result
+            else:
+                logger = logging.getLogger(func.__name__)
+                logger.debug(f">>> {func.__name__} {args} {kwargs}")
+                result = func(*args, **kwargs)
+                logger.debug(f"<<< {func.__name__} {result}")
+                return result
+
+        return wrapper
+
+
+# NOTE: python does not support static initializers, so we init here.
+Context._local = ThreadLocal(Context(lambda _: _)) # type: ignore
 
 def trace[T](value: T) -> T:
     """Logs at debug level using the invoking module name as the logger."""
@@ -91,65 +175,3 @@ class LoggerMixin:
         """
         self.log.debug(f"=== {value}")
         return value
-
-
-P = ParamSpec('P')
-R = TypeVar('R')
-
-
-def traced(func: Callable[P, R]) -> Callable[P, R]:
-    """
-    Decorator to log function entry, arguments, and return value at DEBUG level.
-
-    Also adds an Allure step for reporting. Use on methods where tracing is useful
-    for debugging or reporting.
-
-    Example:
-        @traced
-        def my_method(self, x):
-            ...
-
-    Args:
-        func (Callable[P, R]): The function to be decorated.
-        *args (Any): Positional arguments to be passed to the function.
-        **kwargs (Any): Keyword arguments to be passed to the function.
-
-    Returns:
-        Callable[P, R]: The result of the function call.
-    """
-    @wraps(func)
-    def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
-        # NOTE: each time a decorated function is called this logic will be
-        # re-evaluated.
-        signature = inspect.signature(func)
-        parameters = list(signature.parameters.keys())
-
-        if parameters and parameters[0] == 'self' and len(args) > 0:
-            instance = args[0]
-            logger = logging.getLogger(f"{instance.__class__.__name__}")
-            logger.debug(
-                f">>> {func.__name__} "
-                f"{", ".join([str(arg) for arg in args[1:]])} "
-                f"{LF.join(
-                    f"{key}={str(value)}"
-                    for key, value in kwargs.items()) if kwargs else EMPTY_STRING}")
-
-            with allure.step(  # type: ignore
-                    f"{func.__name__} "
-                    f"{', '.join([str(arg) for arg in args[1:]])}"):
-                result = func(*args, **kwargs)
-
-            if result == instance:
-                logger.debug(f"<<< {func.__name__}")
-            else:
-                logger.debug(f"<<< {func.__name__} {result}")
-
-            return result
-        else:
-            logger = logging.getLogger(func.__name__)
-            logger.debug(f">>> {func.__name__} {args} {kwargs}")
-            result = func(*args, **kwargs)
-            logger.debug(f"<<< {func.__name__} {result}")
-            return result
-
-    return wrapper

qa_testing_utils/object_utils.py

@@ -2,6 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+from typing import Callable, Any
 import threading
 from dataclasses import asdict, fields, is_dataclass, replace
 from enum import Enum
@@ -236,3 +237,11 @@ def require_not_none[T](
     if value is None:
         raise ValueError(message)
     return value
+
+
+class classproperty[T]:
+    def __init__(self, fget: Callable[[Any], T]) -> None:
+        self.fget = fget
+
+    def __get__(self, instance: Any, owner: Any) -> T:
+        return self.fget(owner)

qa_testing_utils/thread_utils.py

@@ -3,8 +3,10 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import concurrent.futures
+from threading import local
 import time
 from datetime import timedelta
+from typing import cast
 
 COMMON_EXECUTOR = concurrent.futures.ThreadPoolExecutor()
 
@@ -16,3 +18,15 @@ def sleep_for(duration: timedelta):
         duration (timedelta): The amount of time to sleep.
     """
     time.sleep(duration.total_seconds())
+
+
+class ThreadLocal[T]:
+    def __init__(self, default: T):
+        self._local = local()
+        self._local.value = default
+
+    def set(self, value: T) -> None:
+        self._local.value = value
+
+    def get(self) -> T:
+        return cast(T, self._local.value)

{qa_testing_utils-0.0.9.dist-info → qa_testing_utils-0.0.10.dist-info}/METADATA

@@ -1,15 +1,15 @@
 Metadata-Version: 2.1
 Name: qa-testing-utils
-Version: 0.0.9
+Version: 0.0.10
 Summary: QA testing utilities
 Author-Email: Adrian Herscu <adrian.herscu@gmail.com>
 License: Apache-2.0
 Requires-Python: >=3.13
-Requires-Dist: pytest==8.3.5
+Requires-Dist: pytest==8.4.0
 Requires-Dist: PyHamcrest==2.1.0
 Requires-Dist: pyfunctional==1.5.0
 Requires-Dist: ppretty==1.3
-Requires-Dist: allure-pytest==2.14.2
+Requires-Dist: allure-pytest==2.14.3
 Requires-Dist: more-itertools==10.7.0
 Requires-Dist: returns==0.25.0
 Description-Content-Type: text/markdown

{qa_testing_utils-0.0.9.dist-info → qa_testing_utils-0.0.10.dist-info}/RECORD

@@ -1,17 +1,17 @@
-qa_testing_utils-0.0.9.dist-info/METADATA,sha256=FEqqeR5_qM1chBwuVr-RtgDyGg3TptUXtK5OLWpqFpU,479
-qa_testing_utils-0.0.9.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
-qa_testing_utils-0.0.9.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-qa_testing_utils/__init__.py,sha256=lZoBoCrPmDHiztV57wRru9CSJWCzBJ4qzAHBIoqWxZQ,21
+qa_testing_utils-0.0.10.dist-info/METADATA,sha256=mz_7SpeT4TUL3rGDpNvD9ZuT8RQsJiKLcz-R_4fvuLs,480
+qa_testing_utils-0.0.10.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
+qa_testing_utils-0.0.10.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+qa_testing_utils/__init__.py,sha256=r2Dgx1vmkvInceHz-V7SeB1ZwQnQHbcShDPVM9grMpw,22
 qa_testing_utils/conftest_helpers.py,sha256=Hcpbc1CFNANFfVDyu9Elf5TB5tX4zSHzHSrRhlsHGsM,1408
 qa_testing_utils/exception_utils.py,sha256=iPa-EE1gvKLxzEB3KzNMWGHaS7xEH_B3Yxd8KWiMROA,1340
 qa_testing_utils/exceptions.py,sha256=_s7es20G9-ET2HeLqU0yhuDAXpnQQs_ecjBmztz94Pk,441
 qa_testing_utils/file_utils.py,sha256=a6VPIbSZQVuOEnrprzlj-YTtfMskNzuClnhECRN2CPw,6444
-qa_testing_utils/logger.py,sha256=840RhoO5AHewqEBNa6A2WbWb8DF-AFrasMPDSPH6JNM,4625
+qa_testing_utils/logger.py,sha256=oOwYIKEXphFfjDW_vF_CTZhQOwr30UW4GAaFQtMS8V0,5822
 qa_testing_utils/logging.ini,sha256=ZcCKCnUiRl3IVB0ZK9fe79PsAXEMag7QwRpxmO4yBHE,834
 qa_testing_utils/matchers.py,sha256=WOPqtCPt5tFdn6JpyDDqPfPSHQvRMpv0uXCv6-2IqNE,12558
-qa_testing_utils/object_utils.py,sha256=CNbRVB3RAmjeGDRQe9cDsSF_iuZY6vENvZj2pwB_mS0,7393
+qa_testing_utils/object_utils.py,sha256=xeh0bO1xoqo55dsx272_qTcKGx-DuirK0FWpdC5XmfY,7623
 qa_testing_utils/stream_utils.py,sha256=zYa2UDfrWsXwRP6nrG87uGkkUZPBLATHXBgu7GUk3Aw,1536
 qa_testing_utils/string_utils.py,sha256=tU1VfmzcS_Zqj4hqzdr6kWdM5dpdlRhiBNiwJAbBDVg,2617
-qa_testing_utils/thread_utils.py,sha256=3Ecyg-bnkcPyT_r9xVWS79uv1BTgXxeIJJZhT3tXorM,416
+qa_testing_utils/thread_utils.py,sha256=h9h0ocUV1aBkl6pAqgWtLrTH94db_umjBkXLrtok4xE,733
 qa_testing_utils/tuple_utils.py,sha256=pIcJntr-PNvaOIP0Pv4sBwO7oIbTVFmGwr9Ic5nJDA0,1851
-qa_testing_utils-0.0.9.dist-info/RECORD,,
+qa_testing_utils-0.0.10.dist-info/RECORD,,