makcu 0.1.4__py3-none-any.whl → 0.2.0__py3-none-any.whl

makcu/__init__.py

@@ -1,16 +1,78 @@
-from .controller import MakcuController
+"""
+Makcu Python Library v2.0
+
+High-performance library for controlling Makcu devices with async support,
+zero-delay command execution, and automatic reconnection.
+"""
+
+from typing import List
+
+# Import main components
+from .controller import MakcuController, create_controller, create_async_controller
 from .enums import MouseButton
-from .errors import MakcuError, MakcuConnectionError
+from .errors import (
+    MakcuError, 
+    MakcuConnectionError, 
+    MakcuCommandError,
+    MakcuTimeoutError,
+    MakcuResponseError
+)
 
-def create_controller(fallback_com_port="", debug=False, send_init=True):
-    makcu = MakcuController(fallback_com_port, debug=debug, send_init=send_init)
-    makcu.connect()
-    return makcu
+# Version info
+__version__: str = "2.0.0"
+__author__: str = "SleepyTotem"
+__license__: str = "GPL"
 
-__all__ = [
+# Public API
+__all__: List[str] = [
+    # Main controller
     "MakcuController",
+    "create_controller",
+    "create_async_controller",
+    
+    # Enums
     "MouseButton",
+    
+    # Errors
     "MakcuError",
     "MakcuConnectionError",
-    "create_controller",
-]
+    "MakcuCommandError", 
+    "MakcuTimeoutError",
+    "MakcuResponseError",
+]
+
+# Convenience imports for backward compatibility
+from .controller import MakcuController as Controller
+
+# Package metadata
+__doc__ = """
+Makcu Python Library provides a high-performance interface for controlling
+Makcu USB devices. Features include:
+
+- Full async/await support for modern Python applications
+- Zero-delay command execution with intelligent tracking
+- Automatic device reconnection on disconnect
+- Human-like mouse movement and clicking patterns
+- Comprehensive button and axis locking
+- Real-time button event monitoring
+
+Quick Start:
+    >>> from makcu import create_controller, MouseButton
+    >>> makcu = create_controller()
+    >>> makcu.click(MouseButton.LEFT)
+    >>> makcu.move(100, 50)
+    >>> makcu.disconnect()
+
+Async Usage:
+    >>> import asyncio
+    >>> from makcu import create_async_controller, MouseButton
+    >>> 
+    >>> async def main():
+    ...     async with await create_async_controller() as makcu:
+    ...         await makcu.click(MouseButton.LEFT)
+    ...         await makcu.move(100, 50)
+    >>> 
+    >>> asyncio.run(main())
+
+For more information, visit: https://github.com/SleepyTotem/makcu-py-lib
+"""

makcu/__main__.py

@@ -1,9 +1,12 @@
 import sys
-import webbrowser
 import os
 from pathlib import Path
+from typing import List, NoReturn
 import pytest
-from makcu import create_controller, MakcuConnectionError
+import time
+from makcu import create_controller, MakcuConnectionError, MakcuController
+import json
+import re
 
 def debug_console():
     controller = create_controller()
@@ -13,6 +16,8 @@ def debug_console():
     print("Type a raw command (e.g., km.version()) and press Enter.")
     print("Type 'exit' or 'quit' to leave.")
 
+    command_counter = 0
+
     while True:
         try:
             cmd = input(">>> ").strip()
@@ -21,8 +26,21 @@ def debug_console():
             if not cmd:
                 continue
 
+            command_counter += 1
+            
+            # Send command and expect response for most commands
             response = transport.send_command(cmd, expect_response=True)
-            print(f"{response or '(no response)'}")
+            
+            # Handle the response properly
+            if response and response.strip():
+                # If response is just the command echoed back, that means success
+                if response.strip() == cmd:
+                    print(f"{cmd}")
+                else:
+                    # This is actual response data (like "km.MAKCU" for version)
+                    print(f"{response}")
+            else:
+                print("(no response)")
 
         except Exception as e:
             print(f"⚠️ Error: {e}")
@@ -30,48 +48,247 @@ def debug_console():
     controller.disconnect()
     print("Disconnected.")
 
-def test_port(port):
+def test_port(port: str) -> None:
     try:
-        print(f"Trying to connect to {port} (without init command)...")
-        controller = create_controller(fallback_com_port=port, send_init=False)
-        print(f"✅ Successfully connected to {port}")
-        controller.disconnect()
+        print(f"Trying to connect to {port}...")
+        makcu = MakcuController(fallback_com_port=port, send_init=False, override_port=True)
+        makcu.connect()
+        if makcu.is_connected:
+            print(f"✅ Successfully connected to {port}.")
+        makcu.disconnect()
     except MakcuConnectionError as e:
-        print(f"❌ Failed to connect to {port}: {e}")
+        if "FileNotFoundError" in str(e):
+            print(f"❌ Port {port} does not exist. Please check the port name.")
+        else:
+            print(f"❌ Failed to connect to {port}: ") 
     except Exception as e:
         print(f"❌ Unexpected error: {e}")
 
-def run_tests():
-    print("🧪 Running Pytest Suite...")
-
-    package_dir = Path(__file__).resolve().parent
-    test_file = package_dir / "test_suite.py"
-
-    result = pytest.main([
-        str(test_file),
-        "--rootdir", str(package_dir),
-        "-v", "--tb=short",
-        "--capture=tee-sys",
-        "--html=latest_pytest.html",
-        "--self-contained-html"
-    ])
-
-    report_path = os.path.abspath("latest_pytest.html")
-    if os.path.exists(report_path):
-        print(f"📄 Opening test report: {report_path}")
-        webbrowser.open(f"file://{report_path}")
-    else:
-        print("❌ Report not found. Something went wrong.")
+def parse_html_results(html_file: Path):
+    """Parse test results from the pytest HTML report"""
+    if not html_file.exists():
+        raise FileNotFoundError(f"HTML report not found: {html_file}")
+    
+    with open(html_file, 'r', encoding='utf-8') as f:
+        content = f.read()
+    
+    # Extract the JSON data from the HTML file
+    match = re.search(r'data-jsonblob="([^"]*)"', content)
+    if not match:
+        raise ValueError("Could not find JSON data in HTML report")
+    
+    # Decode HTML entities in the JSON string
+    json_str = match.group(1)
+    json_str = json_str.replace('"', '"').replace(''', "'").replace('&', '&')
+    
+    try:
+        data = json.loads(json_str)
+    except json.JSONDecodeError as e:
+        raise ValueError(f"Failed to parse JSON data: {e}")
+    
+    test_results = []
+    total_ms = 0
+    
+    # Filter out the connect_to_port test from display
+    skip_tests = {'test_connect_to_port'}
+    
+    for test_id, test_data_list in data.get('tests', {}).items():
+        test_name = test_id.split('::')[-1]  # Get just the test function name
+        
+        # Skip connection test from display
+        if test_name in skip_tests:
+            continue
+            
+        for test_data in test_data_list:
+            status = test_data.get('result', 'UNKNOWN')
+            duration_str = test_data.get('duration', '0 ms')
+            
+            # Parse duration (format: "X ms")
+            duration_match = re.search(r'(\d+)\s*ms', duration_str)
+            duration_ms = int(duration_match.group(1)) if duration_match else 0
+            total_ms += duration_ms
+            
+            test_results.append((test_name, status, duration_ms))
+    
+    return test_results, total_ms
 
-    if result != 0:
-        print("❌ Some tests failed.")
-    else:
-        print("✅ All tests passed.")
+def run_tests() -> NoReturn:
+    """Run tests with beautiful console output"""
+    try:
+        from rich.console import Console
+        from rich.table import Table
+        from rich.progress import Progress, SpinnerColumn, TextColumn, BarColumn, TimeElapsedColumn
+        from rich.panel import Panel
+        from rich.align import Align
+        from rich import print as rprint
+        from rich.text import Text
+        import subprocess
+
+        console = Console()
+
+        header = Panel.fit(
+            "[bold cyan]🧪 Makcu Test Suite v2.0[/bold cyan]\n[dim]High-Performance Python Library[/dim]",
+            border_style="bright_blue"
+        )
+        console.print(Align.center(header))
+        console.print()
+
+        package_dir: Path = Path(__file__).resolve().parent
+        test_file: Path = package_dir / "test_suite.py"
+        html_file: Path = package_dir.parent / "latest_pytest.html"
+
+        start_time = time.time()
+
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            BarColumn(),
+            TextColumn("[progress.percentage]{task.percentage:>3.0f}%"),
+            TimeElapsedColumn(),
+            console=console,
+            transient=True
+        ) as progress:
+            task = progress.add_task("[cyan]Running tests...", total=100)
+
+            # Run pytest with minimal output, generating HTML report
+            result = subprocess.run(
+                [
+                    sys.executable, "-m", "pytest",
+                    str(test_file),
+                    "--rootdir", str(package_dir),
+                    "-q",  # Quiet mode
+                    "--tb=no",  # No traceback
+                    "--html", str(html_file),
+                    "--self-contained-html"
+                ],
+                stdout=subprocess.DEVNULL,  # Hide stdout completely
+                stderr=subprocess.DEVNULL,  # Hide stderr completely
+                text=True
+            )
+
+            progress.update(task, completed=100)
+
+        # Parse results from HTML file
+        try:
+            test_results, total_ms = parse_html_results(html_file)
+        except (FileNotFoundError, ValueError) as e:
+            console.print(f"[red]❌ Failed to parse test results: {e}[/red]")
+            console.print(f"[yellow]⚠️ pytest exit code: {result.returncode}[/yellow]")
+            sys.exit(1)
+
+        elapsed_time = time.time() - start_time
+
+        # Table rendering
+        table = Table(title="[bold]Test Results[/bold]", show_header=True, header_style="bold magenta")
+        table.add_column("Test", style="cyan", no_wrap=True)
+        table.add_column("Status", justify="center")
+        table.add_column("Time", justify="right", style="yellow")
+        table.add_column("Performance", justify="center")
+
+        passed = failed = skipped = 0
+
+        for test_name, status, duration_ms in test_results:
+            display_name = test_name.replace("test_", "").replace("_", " ").title()
+
+            if status.upper() == "PASSED":
+                status_text = "[green]✅ PASSED[/green]"
+                passed += 1
+            elif status.upper() == "FAILED":
+                status_text = "[red]❌ FAILED[/red]"
+                failed += 1
+            elif status.upper() == "SKIPPED":
+                status_text = "[yellow]⏭️ SKIPPED[/yellow]"
+                skipped += 1
+            else:
+                status_text = status
+
+            time_str = f"{duration_ms}ms" if duration_ms else "-"
+            if duration_ms < 3:
+                perf = "[green]⚡ Excellent[/green]"
+            elif duration_ms < 5:
+                perf = "[cyan]🚀 Great[/cyan]"
+            elif duration_ms < 10:
+                perf = "[yellow]👍 Good[/yellow]"
+            elif duration_ms > 0:
+                perf = "[red]🐌 Needs work[/red]"
+            else:
+                perf = "-"
+
+            table.add_row(display_name, status_text, time_str, perf)
+
+        console.print("\n")
+        console.print(table)
+        console.print()
+
+        summary = Table.grid(padding=1)
+        summary.add_column(style="bold cyan", justify="right")
+        summary.add_column(justify="left")
+        summary.add_row("Total Tests:", str(len(test_results)))
+        summary.add_row("Passed:", f"[green]{passed}[/green]")
+        summary.add_row("Failed:", f"[red]{failed}[/red]" if failed else str(failed))
+        summary.add_row("Skipped:", f"[yellow]{skipped}[/yellow]" if skipped else str(skipped))
+        summary.add_row("Total Time:", f"{elapsed_time:.2f}s")
+        summary.add_row("Avg Time/Test:", f"{total_ms/len(test_results):.1f}ms" if test_results else "0ms")
+
+        console.print(Align.center(Panel(summary, title="[bold]Summary[/bold]", border_style="blue", expand=False)))
+        console.print()
+
+        if test_results:
+            avg_time = total_ms / len(test_results)
+            if avg_time < 3:
+                perf_text = Text("Performance: ELITE - Ready for 360Hz+ gaming!", style="bold bright_green")
+            elif avg_time < 5:
+                perf_text = Text("Performance: EXCELLENT - Ready for 240Hz+ gaming!", style="bold green")
+            elif avg_time < 10:
+                perf_text = Text("Performance: GREAT - Ready for 144Hz gaming!", style="bold cyan")
+            else:
+                perf_text = Text("Performance: GOOD - Suitable for standard gaming", style="bold yellow")
+        else:
+            perf_text = Text("⚠️ No test results parsed. Check your test suite.", style="bold red")
+
+        console.print(Align.center(Panel(perf_text, border_style="green")))
+        sys.exit(0 if failed == 0 else 1)
+
+    except ImportError:
+        print("📦 Rich not installed. Install it via `pip install rich` for enhanced output.")
+        print("\nFallback to raw pytest output...\n")
+
+        package_dir: Path = Path(__file__).resolve().parent
+        test_file: Path = package_dir / "test_suite.py"
+        html_file: Path = package_dir.parent / "latest_pytest.html"
+
+        result = pytest.main([
+            str(test_file),
+            "--rootdir", str(package_dir),
+            "-q",
+            "--tb=no",
+            "--html", str(html_file),
+            "--self-contained-html"
+        ])
+
+        # Try to parse HTML results even in fallback mode
+        try:
+            test_results, total_ms = parse_html_results(html_file)
+            passed = sum(1 for _, status, _ in test_results if status.upper() == "PASSED")
+            failed = sum(1 for _, status, _ in test_results if status.upper() == "FAILED")
+            skipped = sum(1 for _, status, _ in test_results if status.upper() == "SKIPPED")
+            
+            print(f"\n📊 Results: {passed} passed, {failed} failed, {skipped} skipped")
+            if test_results:
+                avg_time = total_ms / len(test_results)
+                print(f"⏱️ Average time per test: {avg_time:.1f}ms")
+        except (FileNotFoundError, ValueError):
+            print("\n⚠️ Could not parse HTML results for summary")
+
+        if result != 0:
+            print("\n❌ Some tests failed.")
+        else:
+            print("\n✅ All tests passed.")
 
-    sys.exit(result)
+        sys.exit(result)
     
-def main():
-    args = sys.argv[1:]
+def main() -> None:
+    args: List[str] = sys.argv[1:]
 
     if not args:
         print("Usage:")

makcu/conftest.py

@@ -1,22 +1,32 @@
 import pytest
-from makcu import create_controller
 import time
+from makcu import MakcuController, MouseButton
 
 @pytest.fixture(scope="session")
-def makcu():
-    ctrl = create_controller()
-    yield ctrl
-    ctrl.disconnect()
-    time.sleep(0.2)
+def makcu(request):
+    """Session-scoped fixture with final cleanup at end of all tests"""
+    ctrl = MakcuController(fallback_com_port="COM1", debug=False)
 
-@pytest.fixture(autouse=True)
-def ensure_clean_exit(makcu):
-    yield
-    makcu.mouse.lock_left(False)
-    makcu.mouse.lock_right(False)
-    makcu.mouse.lock_middle(False)
-    makcu.mouse.lock_side1(False)
-    makcu.mouse.lock_side2(False)
-    makcu.mouse.lock_x(False)
-    makcu.mouse.lock_y(False)
-    makcu.enable_button_monitoring(False)
+    def cleanup():
+        if ctrl.is_connected():
+            ctrl.lock_left(False)
+            ctrl.lock_right(False)
+            ctrl.lock_middle(False)
+            ctrl.lock_side1(False)
+            ctrl.lock_side2(False)
+            ctrl.lock_x(False)
+            ctrl.lock_y(False)
+
+            ctrl.release(MouseButton.LEFT)
+            ctrl.release(MouseButton.RIGHT)
+            ctrl.release(MouseButton.MIDDLE)
+            ctrl.release(MouseButton.MOUSE4)
+            ctrl.release(MouseButton.MOUSE5)
+
+            ctrl.enable_button_monitoring(False)
+
+        ctrl.disconnect()
+
+    request.addfinalizer(cleanup)
+
+    return ctrl