emtest 0.0.4__py3-none-any.whl → 0.0.5__py3-none-any.whl

emtest/log_recording.py

@@ -0,0 +1,154 @@
+"""In-memory log recording utilities for Python's logging framework.
+
+This module provides a `RecordingHandler` and helper methods to
+dynamically attach and detach in-memory log recorders to standard
+`logging.Logger` instances. It allows recording log output programmatically
+for testing, debugging, or analysis without relying on files or streams.
+
+Example:
+    >>> import logging
+    >>> import emtest.log_recording
+    >>> logger = logging.getLogger("demo")
+    >>> logger.setLevel(logging.INFO)
+    >>> logger.start_recording()  # Start recording logs
+    >>> logger.info("Hello world")
+    >>> logs = logger.get_recording()
+    >>> print(logs)
+    ['2025-10-18 10:00:00,000 [INFO] Hello world']
+    >>> logger.stop_recording()  # Stop and remove recorder
+"""
+
+import logging
+
+
+class RecordingHandler(logging.Handler):
+    """A logging handler that buffers formatted log records in memory.
+
+    This handler captures each emitted log record, formats it,
+    and stores the resulting string in an internal list.
+    It is useful for unit tests or scenarios where log output
+    needs to be inspected programmatically.
+
+    Attributes:
+        formatter (logging.Formatter): The formatter used to format log messages.
+        _records (list[str]): Internal buffer of recorded log messages.
+    """
+
+    def __init__(self, formatter: logging.Formatter):
+        """Initialize the handler with a specific formatter.
+
+        Args:
+            formatter (logging.Formatter): Formatter to apply to each log record.
+        """
+        super().__init__()
+        self.formatter = formatter
+        self._records: list[str] = []
+
+    def emit(self, record: logging.LogRecord):
+        """Store a formatted log record in the internal buffer.
+
+        Args:
+            record (logging.LogRecord): The log record to handle.
+        """
+        self._records.append(self.format(record))
+
+    def get_records(self) -> list[str]:
+        """Retrieve the recorded log messages.
+
+        Returns:
+            list[str]: A copy of the list of formatted log messages.
+        """
+        return list(self._records)
+
+    def clear(self):
+        """Clear all recorded log messages from the buffer."""
+        self._records.clear()
+
+
+def start_recording(self: logging.Logger, name: str | None = None):
+    """Start recording logs to a named recorder.
+
+    This function dynamically attaches a `RecordingHandler` to the logger.
+    If a recorder with the given name already exists, it does nothing.
+
+    The recorder uses the formatter from the first existing handler
+    if available, or falls back to a default formatter.
+
+    Args:
+        self (logging.Logger): The logger instance.
+        name (str | None): Optional name of the recorder. Defaults to `"__default__"`.
+
+    Example:
+        >>> logger.start_recording("test")
+        >>> logger.info("Message")
+    """
+    if name is None:
+        name = "__default__"
+
+    # Ensure the logger has a dict of recording handlers attached
+    if not hasattr(self, "_recording_handlers"):
+        self._recording_handlers = {}
+    if name in self._recording_handlers:
+        return  # already recording under this name
+
+    # Use same formatter as first handler, or fallback
+    if self.handlers:
+        formatter = self.handlers[0].formatter
+    else:
+        formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(message)s")
+
+    handler = RecordingHandler(formatter)
+    self.addHandler(handler)
+    self._recording_handlers.update({name: handler})
+
+
+def stop_recording(self: logging.Logger, name: str | None = None):
+    """Stop and remove a named recorder from the logger.
+
+    If no recorder exists for the given name, the function does nothing.
+
+    Args:
+        self (logging.Logger): The logger instance.
+        name (str | None): Optional name of the recorder to stop.
+            Defaults to `"__default__"`.
+
+    Example:
+        >>> logger.stop_recording("test")
+    """
+    if name is None:
+        name = "__default__"
+
+    handler = self._recording_handlers.get(name, None)
+    if handler:
+        self.removeHandler(handler)
+
+
+def get_recording(self: logging.Logger, name: str | None = None) -> list[str]:
+    """Retrieve the recorded log messages for a named recorder.
+
+    Args:
+        self (logging.Logger): The logger instance.
+        name (str | None): Optional name of the recorder. Defaults to `"__default__"`.
+
+    Returns:
+        list[str]: A list of formatted log messages recorded so far.
+            Returns an empty list if no handler is found for the name.
+
+    Raises:
+        KeyError: If the recorder with the specified name does not exist.
+
+    Example:
+        >>> messages = logger.get_recording("test")
+        >>> print(messages)
+    """
+    if name is None:
+        name = "__default__"
+
+    handler = self._recording_handlers[name]
+    return handler.get_records() if handler else []
+
+
+# Monkey-patch Logger with recording methods
+logging.Logger.start_recording = start_recording
+logging.Logger.stop_recording = stop_recording
+logging.Logger.get_recording = get_recording

{emtest-0.0.4.dist-info → emtest-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: emtest
-Version: 0.0.4
+Version: 0.0.5
 Summary: Testing utilities which I find useful.
 Author-email: Emendir <dev@emendir.tech>
 License-Expression: MIT-0 OR CC0-1.0
@@ -41,17 +41,21 @@ pip install emtest
 
 ## Usage
 
-See the `examples/` directory for complete working examples showing:
+See the [Usage docs](docs/Usage/PytestUtils.md) for explanations and a complete working example showing:
 - Basic test setup with `conftest.py`
+- Showing and hiding logs
 - Dual execution pattern implementation
 - Source loading validation
 - Thread cleanup testing
-
+- Options like minising output, python-debugger breakpoints and more
 
 ## Documentation
 
 - [Full Documentation](docs/README.md):
   - [API-Reference](docs/API-Reference/README.html)
+  - Usage:
+    - [PytestUtils](docs/Usage/PytestUtils.md)
+    - [LogRecording](docs/Usage/LogRecording.md)
 
 ## Roadmap
 
@@ -63,18 +67,17 @@ See the `examples/` directory for complete working examples showing:
 - GitHub Issues: if you find bugs, other issues, or would like to submit feature requests
 - GitHub Merge Requests: if you think you know what you're doing, you're very welcome!
 
-### Donations
+### Donate
 
 To support me in my work on this and other projects, you can make donations with the following currencies:
 
 - **Bitcoin:** `BC1Q45QEE6YTNGRC5TSZ42ZL3MWV8798ZEF70H2DG0`
 - **Ethereum:** `0xA32C3bBC2106C986317f202B3aa8eBc3063323D4`
-- [**Fiat** (via Credit or Debit Card, Apple Pay, Google Pay, Revolut Pay)](https://checkout.revolut.com/pay/4e4d24de-26cf-4e7d-9e84-ede89ec67f32)
+- [Credit Card, Debit Card, Bank Transfer, Apple Pay, Google Pay, Revolut Pay)](https://checkout.revolut.com/pay/4e4d24de-26cf-4e7d-9e84-ede89ec67f32)
 
 Donations help me:
 - dedicate more time to developing and maintaining open-source projects
-- cover costs for IT infrastructure
-- finance projects requiring additional hardware & compute
+- cover costs for IT resources
 
 ## About the Developer
 

emtest-0.0.5.dist-info/RECORD

@@ -0,0 +1,11 @@
+_auto_run_with_pytest/__init__.py,sha256=P2Tgn9TbVJvNiyOygCrBso4uAd7Og9suuHmKE0-CEtU,753
+emtest/__init__.py,sha256=G_EnVC57IL_OjVJAjaz75y9owlCcdbvXfvR-ncO1icU,344
+emtest/log_recording.py,sha256=vNBRHmjTbYPv2JNj8QPbWzLKabDHZI7G5JDXOG79FnI,5062
+emtest/pytest_utils.py,sha256=qGKGlQTIgKi3BjmUTfcqzPE_0QfWkWfefy8Oitq3sdQ,4844
+emtest/testing_utils.py,sha256=lzXRXwA50YQBHO35Y2s6NcbvgrdTcwGJjJ79CkzJKkk,4780
+emtest-0.0.5.dist-info/licenses/LICENSE,sha256=i720OgyQLs68DSskm7ZLzaGKMnfskBIIHOuPWfwT2q4,907
+emtest-0.0.5.dist-info/licenses/LICENSE-CC0,sha256=kXBMw0w0VVXQAbLjqMKmis4OngrPaK4HY9ScH6MdtxM,7038
+emtest-0.0.5.dist-info/METADATA,sha256=m-lFcX-8XVye2BuMPg2u8Ohcnvsn83myKm0-vaO1hVI,3569
+emtest-0.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+emtest-0.0.5.dist-info/top_level.txt,sha256=sfToBhqMjk35PDheZ42yiMGYNYatT3V5Mwhb79fp5dE,29
+emtest-0.0.5.dist-info/RECORD,,

emtest-0.0.4.dist-info/RECORD

@@ -1,10 +0,0 @@
-_auto_run_with_pytest/__init__.py,sha256=P2Tgn9TbVJvNiyOygCrBso4uAd7Og9suuHmKE0-CEtU,753
-emtest/__init__.py,sha256=G_EnVC57IL_OjVJAjaz75y9owlCcdbvXfvR-ncO1icU,344
-emtest/pytest_utils.py,sha256=qGKGlQTIgKi3BjmUTfcqzPE_0QfWkWfefy8Oitq3sdQ,4844
-emtest/testing_utils.py,sha256=lzXRXwA50YQBHO35Y2s6NcbvgrdTcwGJjJ79CkzJKkk,4780
-emtest-0.0.4.dist-info/licenses/LICENSE,sha256=i720OgyQLs68DSskm7ZLzaGKMnfskBIIHOuPWfwT2q4,907
-emtest-0.0.4.dist-info/licenses/LICENSE-CC0,sha256=kXBMw0w0VVXQAbLjqMKmis4OngrPaK4HY9ScH6MdtxM,7038
-emtest-0.0.4.dist-info/METADATA,sha256=Brr2oyYeArMDrP0K17UTUELzQ-LiUURmAQgDlfXMUXE,3395
-emtest-0.0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-emtest-0.0.4.dist-info/top_level.txt,sha256=sfToBhqMjk35PDheZ42yiMGYNYatT3V5Mwhb79fp5dE,29
-emtest-0.0.4.dist-info/RECORD,,