emtest 0.0.1__py3-none-any.whl

emtest/__init__.py

@@ -0,0 +1,7 @@
+from .pytest_utils import run_pytest, configure_pytest_reporter
+from .testing_utils import (
+    add_path_to_python,
+    assert_is_loaded_from_source,
+    polite_wait,
+    await_thread_cleanup,
+)

emtest/pytest_utils.py

@@ -0,0 +1,93 @@
+
+
+
+import os
+import sys
+from typing import Any, Optional
+from _pytest.terminal import TerminalReporter
+from _pytest.config import Config
+from _pytest.reports import TestReport
+from termcolor import colored
+
+class MinimalReporter(TerminalReporter):
+    """Custom pytest reporter that provides clean, minimal output with colored symbols.
+    
+    This reporter suppresses most default pytest output and displays only:
+    - ✓ for passed tests (green)
+    - ✗ for failed tests (red) 
+    - - for skipped tests (yellow)
+    """
+    def __init__(self, config: Config) -> None:
+        super().__init__(config)
+        self._tw.hasmarkup = True  # enables colored output safely
+
+    def _write_output(self, *args: Any, **kwargs: Any) -> None:
+        """Override default output methods to suppress them."""
+        pass  # override all default output methods
+
+    def _write_summary(self) -> None:
+        """Override summary writing to suppress it."""
+        pass
+
+    def pytest_sessionstart(self, session: Any) -> None:
+        """Override session start to suppress 'collected x items' message."""
+        # print("pytest_sessionstart")
+        pass  # suppress "collected x items"
+
+    def pytest_runtest_logstart(self, nodeid: str, location: Any) -> None:
+        """Override test start logging to suppress it."""
+        # print("pytest_runtest_logstart")
+        pass  # suppress test start lines
+
+    def pytest_runtest_logreport(self, report: TestReport) -> None:
+        """Display minimal test results with colored symbols."""
+        if report.when != "call":
+            return
+
+        test_name = report.nodeid.split("::")[-1]
+        if report.passed:
+            symbol = colored("✓", "green")
+        elif report.failed:
+            symbol = colored("✗", "red")
+        elif report.skipped:
+            symbol = colored("-", "yellow")
+        print(f"{symbol} {test_name}")
+
+    def summary_stats(self) -> None:
+        """Override result counts to suppress them."""
+        pass  # suppress result counts
+
+    def pytest_terminal_summary(self, terminalreporter: Any, exitstatus: int, config: Config) -> None:
+        """Override final summary output to suppress it."""
+        pass  # suppress final summary output
+
+
+def configure_pytest_reporter(config: Config) -> None:
+    """Configure the minimal reporter if terminalreporter plugin is disabled.
+    
+    Args:
+        config: Pytest configuration object
+    """
+    # if terminalreporter plugin is disabled
+    if "no:terminalreporter" in config.option.plugins:
+        pluginmanager = config.pluginmanager
+        pluginmanager.register(MinimalReporter(config), "minimal-reporter")
+
+
+def run_pytest(test_path: str, breakpoints: bool, deactivate_pytest_output: bool = False, enable_print: bool = False) -> None:
+    """Run pytest with customizable options for output control and debugging.
+    
+    Args:
+        test_path: Path to the test file or directory to run
+        breakpoints: If True, enables pytest debugger (--pdb) on failures
+        deactivate_pytest_output: If True, uses minimal reporter instead of default output
+        enable_print: If True, enables print statements in tests (-s flag)
+    """
+    args = []
+    if deactivate_pytest_output:
+        args += ["-p", "no:terminalreporter"]
+    if enable_print:
+        args.append("-s")  # -s disables output capturing
+    if breakpoints:
+        args.append("--pdb")
+    os.system(f"{sys.executable} -m pytest {test_path} {' '.join(args)}")

emtest/testing_utils.py

@@ -0,0 +1,98 @@
+
+
+import os
+import sys
+import threading
+import time
+from time import sleep
+from typing import List
+from tqdm import TMonitor, tqdm
+
+from types import ModuleType
+
+
+def add_path_to_python(src_path: str) -> None:
+    """Add a directory to the Python path for importing modules.
+    
+    Removes the path if it already exists, then inserts it at the beginning
+    of sys.path to ensure it takes priority over installed packages.
+    
+    Args:
+        src_path: Directory path to add to Python path
+        
+    Raises:
+        FileNotFoundError: If the path doesn't exist
+        NotADirectoryError: If the path is not a directory
+    """
+    src_path = os.path.abspath(src_path)
+    if not os.path.exists(src_path):
+        raise FileNotFoundError(f"The path doesn't exist: {src_path}")
+    if not os.path.isdir(src_path):
+        raise NotADirectoryError(f"The path doesn't exist: {src_path}")
+
+    if src_path in sys.path:
+        sys.path.remove(src_path)
+    sys.path.insert(0, src_path)
+
+
+def assert_is_loaded_from_source(
+    source_dir: str, module: ModuleType, print_confirmation=False
+) -> None:
+    """Assert a module is loaded from source code, not an installation.
+
+    Asserts that the loaded module's source code is located within the given
+    directory, regardless of whether it's file is located in that folder or is
+    nested in subfolders.
+
+    Args:
+        source_dir: a directory in which the module's source should be
+        module: the module to check
+    """
+    module_path = os.path.abspath(module.__file__)
+    source_path = os.path.abspath(source_dir)
+    assert (
+        source_path in module_path
+    ), (
+        f"The module `{module.__name__}` has been loaded from an installion, "
+        "not this source code!\n"
+        f"Desired source dir: {source_path}\n"
+        f"Loaded module path: {module_path}\n"
+    )
+    if print_confirmation:
+        print(f"Using module {module.__name__} from {module_path}")
+
+
+def polite_wait(n_sec: int) -> None:
+    """Wait for the given duration, displaying a progress bar.
+    
+    Args:
+        n_sec: Number of seconds to wait
+    """
+    # print(f"{n_sec}s patience...")
+    for i in tqdm(range(n_sec), leave=False):
+        time.sleep(1)
+
+
+def await_thread_cleanup(timeout: int = 5) -> bool:
+    """Wait for all threads to exit, with a timeout and progress bar.
+    
+    Args:
+        timeout: Maximum seconds to wait for thread cleanup
+        
+    Returns:
+        True if only the main thread remains, False if other threads persist
+    """
+    def get_threads() -> List[threading.Thread]:
+        """Get all active threads except tqdm monitor threads."""
+        return [
+            x for x in threading.enumerate() if not isinstance(x, TMonitor)
+        ]
+
+    for i in tqdm(range(timeout), leave=False):
+        if len(get_threads()) == 1:
+            break
+        sleep(1)
+
+    return len(get_threads()) == 1
+
+

emtest-0.0.1.dist-info/METADATA

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: emtest
+Version: 0.0.1
+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.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+emtest/__init__.py,sha256=tC-Hx6hKUVswMSIik-RwLF4fO4rDaZXi05DzDkixoCE,195
+emtest/pytest_utils.py,sha256=0vVNw6P4FdS7BsX18GMXK7bne-hfSNWiLtRS0sLiZOA,3486
+emtest/testing_utils.py,sha256=uZeEw4EKhy_2sUIzUPF1kvfVfyis3mF7Q5SSj9uxzCU,2899
+emtest-0.0.1.dist-info/licenses/LICENCE,sha256=bUia9ikmYtnjbTTOSUI3hJhKX25B17WPSbASZN9Z-gM,7047
+emtest-0.0.1.dist-info/METADATA,sha256=UWQ9-OOa4u74B_kwP8BG2-2c77u1Mjod5mXS71TnGOM,1570
+emtest-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+emtest-0.0.1.dist-info/top_level.txt,sha256=8yXylA__VmNeIDW3MBOmSiOpUCZoEprrys-qdB54CLo,7
+emtest-0.0.1.dist-info/RECORD,,

emtest-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

emtest-0.0.1.dist-info/licenses/LICENCE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent 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,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    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.

emtest-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+emtest