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

_auto_run_with_pytest/__init__.py

@@ -1,11 +1,11 @@
 """Rerun the orignially executed python script in pytest instead of python."""
+
 import os
 import sys
 
 from emtest import run_pytest
 
 # Configuration for standalone execution
-BREAKPOINTS = False  # Set to True to enable debugger on test failures
 
 path_parts = sys.argv[0].split(os.sep)
 if not (
@@ -17,15 +17,13 @@ if not (
     )
 ):
     test_file = os.path.abspath(sys.argv[0])
-    pytest_args=sys.argv[1:]
+    pytest_args = sys.argv[1:]
     # print("RERUNNING IN PYTEST:", test_file)
 
     # Use emtest's custom test runner with specific settings:
     run_pytest(
-        test_path=test_file,              # Run tests in this file
-        breakpoints=BREAKPOINTS,         # Enable/disable debugger on failures
-        enable_print=True,               # Show print statements in tests
-        pytest_args=pytest_args
+        test_path=test_file,  # Run tests in this file
+        pytest_args=pytest_args,
     )
 
     sys.exit(-1)

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.5.dist-info/METADATA

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: emtest
+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
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE-CC0
+Requires-Dist: tqdm
+Dynamic: license-file
+
+# emtest - Python Testing Utilities
+
+A Python package providing testing utilities.
+
+## Features
+
+### 🎨 Clean Test Output for Pytest
+- **MinimalReporter**: Custom pytest reporter with clean, colored output using simple symbols (✓/✗/-)
+- **Configurable Output**: Toggle between minimal and standard pytest output modes
+
+### 🔧 Development Utilities  
+- **Source Path Management**: Dynamically add directories to Python path for testing source code
+- **Module Source Validation**: Ensure modules are loaded from source directories (not installed packages)
+- **Thread Cleanup Monitoring**: Wait for and verify proper thread cleanup in tests
+
+### ⚡ Enhanced Test Execution
+- **Dual Execution Pattern**: Run tests both as pytest tests and standalone Python scripts
+- **Breakpoint Integration**: Easy debugging with pytest's `--pdb` integration
+- **Progress Indicators**: Visual progress bars for waiting operations
+
+## Installation
+
+```sh
+pip install emtest
+```
+
+## Usage
+
+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
+
+## Contributing
+
+### Get Involved
+
+- GitHub Discussions: if you want to share ideas
+- 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!
+
+### Donate
+
+To support me in my work on this and other projects, you can make donations with the following currencies:
+
+- **Bitcoin:** `BC1Q45QEE6YTNGRC5TSZ42ZL3MWV8798ZEF70H2DG0`
+- **Ethereum:** `0xA32C3bBC2106C986317f202B3aa8eBc3063323D4`
+- [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 resources
+
+## About the Developer
+
+This project is developed by a human one-man team, publishing under the name _Emendir_.  
+I build open technologies trying to improve our world;
+learning, working and sharing under the principle:
+
+> _Freely I have received, freely I give._
+
+Feel welcome to join in with code contributions, discussions, ideas and more!
+
+## Open-Source in the Public Domain
+
+I dedicate this project to the public domain.
+It is open source and free to use, share, modify, and build upon without restrictions or conditions.
+
+I make no patent or trademark claims over this project.  
+
+Formally, you may use this project under either the: 
+- [MIT No Attribution (MIT-0)](https://choosealicense.com/licenses/mit-0/) or
+- [Creative Commons Zero (CC0)](https://choosealicense.com/licenses/cc0-1.0/)
+licence at your choice.  
+
+

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.5.dist-info/licenses/LICENSE

@@ -0,0 +1,18 @@
+MIT No Attribution
+
+Copyright [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

emtest-0.0.3.dist-info/licenses/LICENCE → emtest-0.0.5.dist-info/licenses/LICENSE-CC0

@@ -101,7 +101,7 @@ express Statement of Purpose.
 
 4. Limitations and Disclaimers.
 
- a. No trademark or patent rights held by Affirmer are waived, abandoned,
+ a. No trademark rights held by Affirmer are waived, abandoned,
     surrendered, licensed or otherwise affected by this document.
  b. Affirmer offers the Work as-is and makes no representations or
     warranties of any kind concerning the Work, express, implied,
@@ -118,4 +118,4 @@ express Statement of Purpose.
     Work.
  d. Affirmer understands and acknowledges that Creative Commons is not a
     party to this document and has no duty or obligation with respect to
-    this CC0 or use of the Work.
+    this CC0 or use of the Work.

emtest-0.0.3.dist-info/METADATA

@@ -1,49 +0,0 @@
-Metadata-Version: 2.4
-Name: emtest
-Version: 0.0.3
-Summary: Testing utilities which I find useful.
-Author-email: Emendir <dev@emendir.tech>
-License-Expression: CC0-1.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENCE
-Requires-Dist: tqdm
-Dynamic: license-file
-
-# emtest - Python Testing Utilities
-
-A Python package providing testing utilities.
-
-## Features
-
-### 🎨 Clean Test Output for Pytest
-- **MinimalReporter**: Custom pytest reporter with clean, colored output using simple symbols (✓/✗/-)
-- **Configurable Output**: Toggle between minimal and standard pytest output modes
-
-### 🔧 Development Utilities  
-- **Source Path Management**: Dynamically add directories to Python path for testing source code
-- **Module Source Validation**: Ensure modules are loaded from source directories (not installed packages)
-- **Thread Cleanup Monitoring**: Wait for and verify proper thread cleanup in tests
-
-### ⚡ Enhanced Test Execution
-- **Dual Execution Pattern**: Run tests both as pytest tests and standalone Python scripts
-- **Breakpoint Integration**: Easy debugging with pytest's `--pdb` integration
-- **Progress Indicators**: Visual progress bars for waiting operations
-
-## Installation
-
-```sh
-pip install emtest
-```
-
-## Usage
-
-See the `examples/` directory for complete working examples showing:
-- Basic test setup with `conftest.py`
-- Dual execution pattern implementation
-- Source loading validation
-- Thread cleanup testing
-
-

emtest-0.0.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-_auto_run_with_pytest/__init__.py,sha256=XfdKb4Kz-BHojNZdUn_m1RJbgGM65-qUIUe-tLlc8S4,985
-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.3.dist-info/licenses/LICENCE,sha256=bUia9ikmYtnjbTTOSUI3hJhKX25B17WPSbASZN9Z-gM,7047
-emtest-0.0.3.dist-info/METADATA,sha256=4GAMKLottAS-zatp4qyF1e40U4vY_HtUIoZjAVYwdmE,1570
-emtest-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-emtest-0.0.3.dist-info/top_level.txt,sha256=sfToBhqMjk35PDheZ42yiMGYNYatT3V5Mwhb79fp5dE,29
-emtest-0.0.3.dist-info/RECORD,,