debug-dojo 0.7.0__tar.gz → 0.9.0__tar.gz

{debug_dojo-0.7.0/src/debug_dojo.egg-info → debug_dojo-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: debug-dojo
-Version: 0.7.0
+Version: 0.9.0
 Summary: 🏣 debug dojo, a place for zen debugging
 Author-email: bwrob <bartosz.marcin.wroblewski@gmail.com>
 License-Expression: MIT
@@ -64,8 +64,9 @@ Dynamic: license-file
 ## ✨ Features
 
 *   **Unified Debugging Interface:** Easily launch your scripts or modules with your preferred debugger (`debugpy`, `pudb`, `pdb`, `ipdb`).
+*   **Dojo Belts Gamification:** Earn belts based on your debugging experience and track your progress.
 *   **Enhanced Output with Rich:** Leverages [`rich`](https://github.com/Textualize/rich) for stunning, syntax-highlighted code, pretty-printed objects, and improved tracebacks.
-*   **Side-by-Side Object Comparison:** Quickly identify differences between two Python objects.
+*   **Side-by-side Object Comparison:** Quickly identify differences between two Python objects.
 *   **Interactive Object Inspection:** Dive deep into object structures with a powerful `inspect` utility.
 *   **Simplified Breakpoints:** Set breakpoints effortlessly with a concise helper function.
 
@@ -85,22 +86,28 @@ pip install "debug-dojo[all-debuggers]"
 
 ## 💻 CLI Usage
 
-Run your Python script or module with `debug-dojo`:
+Run your Python script or module with `dojo run`:
 
 ```console
-dojo my_script.py
+dojo run my_script.py
+```
+
+Check your progress and current belt with:
+
+```console
+dojo belt
 ```
 
 Specify a debugger, configuration file, or enable verbose output:
 
 ```console
-dojo --debugger ipdb --config dojo.toml --verbose --module my_module
+dojo run --debugger ipdb --config dojo.toml --verbose --module my_module
 ```
 
 Run an executable command with debugging tools:
 
 ```console
-dojo --exec pytest
+dojo run --exec pytest
 ```
 
 ## 🐍 Usage in Code

{debug_dojo-0.7.0 → debug_dojo-0.9.0}/README.md

@@ -31,8 +31,9 @@
 ## ✨ Features
 
 *   **Unified Debugging Interface:** Easily launch your scripts or modules with your preferred debugger (`debugpy`, `pudb`, `pdb`, `ipdb`).
+*   **Dojo Belts Gamification:** Earn belts based on your debugging experience and track your progress.
 *   **Enhanced Output with Rich:** Leverages [`rich`](https://github.com/Textualize/rich) for stunning, syntax-highlighted code, pretty-printed objects, and improved tracebacks.
-*   **Side-by-Side Object Comparison:** Quickly identify differences between two Python objects.
+*   **Side-by-side Object Comparison:** Quickly identify differences between two Python objects.
 *   **Interactive Object Inspection:** Dive deep into object structures with a powerful `inspect` utility.
 *   **Simplified Breakpoints:** Set breakpoints effortlessly with a concise helper function.
 
@@ -52,22 +53,28 @@ pip install "debug-dojo[all-debuggers]"
 
 ## 💻 CLI Usage
 
-Run your Python script or module with `debug-dojo`:
+Run your Python script or module with `dojo run`:
 
 ```console
-dojo my_script.py
+dojo run my_script.py
+```
+
+Check your progress and current belt with:
+
+```console
+dojo belt
 ```
 
 Specify a debugger, configuration file, or enable verbose output:
 
 ```console
-dojo --debugger ipdb --config dojo.toml --verbose --module my_module
+dojo run --debugger ipdb --config dojo.toml --verbose --module my_module
 ```
 
 Run an executable command with debugging tools:
 
 ```console
-dojo --exec pytest
+dojo run --exec pytest
 ```
 
 ## 🐍 Usage in Code

{debug_dojo-0.7.0 → debug_dojo-0.9.0}/pyproject.toml

@@ -31,7 +31,7 @@
     name = "debug-dojo"
     readme = "README.md"
     requires-python = ">=3.10,<3.15"
-    version = "0.7.0"
+    version = "0.9.0"
 
     [project.urls]
         Changelog     = "https://bwrob.github.io/debug-dojo/changelog/"
@@ -54,6 +54,7 @@
 
     dev = [
         "basedpyright>=1.31.2",
+        "complexipy>=5.2.0",
         "coverage>=7.10.4",
         "debug-dojo[all-debuggers]",
         "diff-cover>=9.6.0",
@@ -62,8 +63,7 @@
         "pytest-cov>=6.2.1",
         "ruff>=0.12.9",
         "tach>=0.29.0",
-    ]
-    docs = [
+        "ty>=0.0.15",
         "mkdocs>=1.6.1",
         "mkdocs-git-authors-plugin>=0.10.0",
         "mkdocs-git-committers-plugin-2>=2.5.0",
@@ -73,12 +73,13 @@
         "mkdocstrings-python>=1.17.0",
         "pymdown-extensions>=10.16.1",
         "typst>=0.14.2",
-    ]
+        "refurb>=2.3.0",
+]
 
 
 [tool.uv]
     package          = true
-    required-version = ">=0.8.0"
+    required-version = ">=0.10.0,<0.12.0"
 
     [tool.uv.workspace]
         members = ["."]

{debug_dojo-0.7.0 → debug_dojo-0.9.0}/src/debug_dojo/__main__.py

@@ -1,6 +1,6 @@
 """Entry point for the debug_dojo package."""
 
 if __name__ == "__main__":
-    from ._cli import main
+    from debug_dojo._cli import main
 
     main()

{debug_dojo-0.7.0 → debug_dojo-0.9.0}/src/debug_dojo/_cli.py

@@ -2,30 +2,19 @@
 
 from __future__ import annotations
 
-import runpy
+import contextlib
 import sys
-import traceback
-from bdb import BdbQuit
-from enum import Enum
+import time
 from pathlib import Path
-from shutil import which
 from typing import Annotated
 
 import typer
 from rich import print as rich_print
 
-from ._config import load_config
-from ._config_models import DebugDojoConfig, DebuggerType  # noqa: TC001
-from ._installers import install_by_config
-
-
-class ExecMode(Enum):
-    """Execution mode for the target."""
-
-    FILE = "file"
-    MODULE = "module"
-    EXECUTABLE = "executable"
-
+from debug_dojo._config import load_config
+from debug_dojo._config_models import DebuggerType  # noqa: TC001
+from debug_dojo._execution import ExecMode, execute_with_debug
+from debug_dojo._gamification import GamificationManager
 
 cli = typer.Typer(
     name="debug_dojo",
@@ -34,73 +23,25 @@ cli = typer.Typer(
 )
 
 
-def __execute_with_debug(  # noqa: C901
-    target_name: str,
-    target_args: list[str],
-    *,
-    target_mode: ExecMode,
-    verbose: bool,
-    config: DebugDojoConfig,
+@cli.command(help="Show your current Dojo Belt and stats.")
+def belt(
+    config_path: Annotated[
+        Path | None, typer.Option("--config", "-c", help="Show configuration")
+    ] = None,
 ) -> None:
-    """Execute a target script or module with installed debugging tools.
+    """Display the current user's Dojo Belt status."""
+    config = load_config(config_path)
 
-    Args:
-        target_name (str): The name of the script, module, or executable to run.
-        target_args (list[str]): Arguments to pass to the target.
-        target_mode (ExecMode): The execution mode (FILE, MODULE, or EXECUTABLE).
-        verbose (bool): If True, print verbose output.
-        config (DebugDojoConfig): The debug-dojo configuration.
+    if not config.gamification:
+        rich_print("[yellow]Gamification is disabled in your configuration.[/yellow]")
+        return
 
-    Raises:
-        typer.Exit: If the target file is not found, or if an import error occurs,
-                    or if the script exits with a non-zero code.
-
-    """
-    sys.argv = [target_name, *target_args]
-
-    if verbose:
-        rich_print(f"[blue]Installing debugging tools for {target_name}.[/blue]")
-        rich_print(f"[blue]Arguments for target: {target_args}[/blue]")
-
-    install_by_config(config)
-
-    if target_mode is ExecMode.MODULE:
-        runner = runpy.run_module
-    else:
-        if target_mode is ExecMode.EXECUTABLE:
-            target_name = which(target_name) or target_name
-
-        if not Path(target_name).exists():
-            raise typer.Exit(1)
-
-        runner = runpy.run_path
-
-    try:
-        _ = runner(target_name, run_name="__main__")
-    except ImportError as e:
-        rich_print(f"[red]Error importing {target_name}:[/red]\n{e}")
-        raise typer.Exit(1) from e
-    except BdbQuit:
-        rich_print("[red]Debugging session terminated by user.[/red]")
-        raise typer.Exit(0) from None
-    except KeyboardInterrupt:
-        rich_print("[red]Execution interrupted by user.[/red]")
-        raise typer.Exit(0) from None
-    except SystemExit as e:
-        if e.code:
-            rich_print(f"[red]Script exited with code {e.code}.[/red]")
-    except Exception as e:
-        rich_print(f"[red]Error while running {target_name}:[/red]\n{e}")
-        rich_print(traceback.format_exc())
-        if config.exceptions.post_mortem:
-            import ipdb  # pyright: ignore[reportMissingTypeStubs]  # noqa: PLC0415, T100
-
-            rich_print("[blue]Entering post-mortem debugging session...[/blue]")
-            ipdb.post_mortem(e.__traceback__)  # pyright: ignore[reportUnknownMemberType]
-        raise typer.Exit(1) from e
+    manager = GamificationManager()
+    manager.display_status()
 
 
 @cli.command(
+    name="run",
     help="Run a Python script or module with debugging tools installed.",
     no_args_is_help=True,
     context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
@@ -108,7 +49,8 @@ def __execute_with_debug(  # noqa: C901
 def run_debug(  # noqa: PLR0913
     ctx: typer.Context,
     target_name: Annotated[
-        str | None, typer.Argument(help="The target script or module to debug.")
+        str | None,
+        typer.Argument(help="The target script or module to debug.", metavar="target"),
     ] = None,
     *,
     config_path: Annotated[
@@ -178,7 +120,9 @@ def run_debug(  # noqa: PLR0913
         rich_print(f"[blue]Using debug-dojo configuration: {config} [/blue]")
 
     if target_name:
-        __execute_with_debug(
+        start_time = time.perf_counter()
+
+        execute_with_debug(
             target_name=target_name,
             target_mode=mode,
             target_args=ctx.args,
@@ -186,6 +130,17 @@ def run_debug(  # noqa: PLR0913
             config=config,
         )
 
+        duration = time.perf_counter() - start_time
+
+        # Gamification: Increment session count if enabled
+        if config.gamification:
+            with contextlib.suppress(Exception):
+                command = " ".join(sys.argv)
+                GamificationManager().increment_session(
+                    duration_seconds=duration,
+                    command=command,
+                )
+
 
 def main() -> None:
     """Run the command-line interface."""

debug_dojo-0.9.0/src/debug_dojo/_compare.py

@@ -0,0 +1,205 @@
+"""Utilities for side-by-side inspection and comparison of Python objects.
+
+This module provides functions to display attributes and methods of two objects in a
+visually appealing, side-by-side format in the terminal.
+"""
+
+from __future__ import annotations
+
+import contextlib
+from typing import TYPE_CHECKING, Any
+
+from rich.console import Console
+from rich.panel import Panel
+from rich.table import Table
+from rich.text import Text
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+
+def _get_members(
+    obj: object,
+    predicate: Callable[[str, Any], bool],  # pyright: ignore[reportExplicitAny]
+    formatter: Callable[[str, Any], str],  # pyright: ignore[reportExplicitAny]
+) -> list[str]:
+    members: list[str] = []
+    for name in sorted(dir(obj)):
+        try:
+            value = getattr(obj, name)  # pyright: ignore[reportAny]
+        except Exception:  # noqa: S112, BLE001
+            continue
+
+        if predicate(name, value):
+            with contextlib.suppress(Exception):
+                members.append(formatter(name, value))
+    return members
+
+
+def get_object_attributes(obj: object) -> list[str]:
+    """Extract and format non-callable attributes of an object.
+
+    Args:
+        obj (object): The object to extract attributes from.
+
+    Returns:
+        list[str]: A list of formatted strings, each representing an attribute.
+
+    """
+    return _get_members(
+        obj,
+        lambda n, v: not n.startswith("__") and not callable(v),  # pyright: ignore[reportAny]
+        lambda n, v: f"{n}={v!r}",  # pyright: ignore[reportAny]
+    )
+
+
+def get_object_methods(obj: object) -> list[str]:
+    """Extract and format public callable methods of an object.
+
+    Args:
+        obj (object): The object to extract methods from.
+
+    Returns:
+        list[str]: A list of method names.
+
+    """
+    return _get_members(
+        obj,
+        lambda n, v: not n.startswith("_") and callable(v),  # pyright: ignore[reportAny]
+        lambda n, _v: n,  # pyright: ignore[reportAny]
+    )
+
+
+def _is_basic_type(obj: object) -> bool:
+    """Check if the object is a basic Python type.
+
+    Returns:
+        bool: True if the object is a basic Python type, False otherwise.
+
+    """
+    return (
+        isinstance(obj, (str, int, float, list, dict, tuple, set, bool)) or obj is None
+    )
+
+
+def _get_basic_info(obj: object) -> list[Text]:
+    """Get information for basic types.
+
+    Returns:
+        list[Text]: A list of Rich Text objects representing the basic info.
+
+    """
+    return [
+        Text("Value:", style="bold"),
+        Text(f"  {obj!r}", style="yellow"),
+        Text(""),
+        Text("No attributes or methods to display for this type.", style="dim"),
+    ]
+
+
+def _format_section(title: str, items: list[str], empty_message: str) -> list[Text]:
+    """Format a section of the inspection output.
+
+    Returns:
+        list[Text]: A list of Rich Text objects for the formatted section.
+
+    """
+    lines: list[Text] = []
+    if items:
+        lines.append(Text(title, style="bold"))
+        lines.extend([Text(f"  {item}") for item in items])
+    else:
+        lines.append(Text(empty_message, style="dim"))
+    lines.append(Text(""))
+    return lines
+
+
+def _get_attributes_section(obj: object) -> list[Text]:
+    """Get the attributes section for the object info.
+
+    Returns:
+        list[Text]: A list of Rich Text objects for the attributes section.
+
+    """
+    return _format_section(
+        "Attributes:",
+        get_object_attributes(obj),
+        "No attributes found.",
+    )
+
+
+def _get_methods_section(obj: object) -> list[Text]:
+    """Get the methods section for the object info.
+
+    Returns:
+        list[Text]: A list of Rich Text objects for the methods section.
+
+    """
+    return _format_section(
+        "Methods:",
+        [f"{method}()" for method in get_object_methods(obj)],
+        "No public methods found.",
+    )
+
+
+def get_simplified_object_info(obj: object) -> list[Text]:
+    """Generate a simplified, Rich-formatted inspection output for an object.
+
+    Handles basic Python types by displaying their value directly. For other objects, it
+    lists their attributes and public methods.
+
+    Args:
+        obj (object): The object to generate info for.
+
+    Returns:
+        list[Text]: A list of Rich Text objects representing the object's information.
+
+    """
+    info_lines: list[Text] = []
+    obj_type: str = type(obj).__name__
+    info_lines.extend((Text(f"<class '{obj_type}'>", style="cyan bold"), Text("")))
+
+    if _is_basic_type(obj):
+        info_lines.extend(_get_basic_info(obj))
+        return info_lines
+
+    info_lines.extend(_get_attributes_section(obj))
+    info_lines.extend(_get_methods_section(obj))
+
+    return info_lines
+
+
+def inspect_objects_side_by_side(
+    obj1: object,
+    obj2: object,
+) -> None:
+    """Display two Python objects side-by-side in the terminal using Rich.
+
+    Showing their attributes and methods in a simplified, aligned format.
+
+    Args:
+        obj1 (object): The first object to display.
+        obj2 (object): The second object to display.
+
+    """
+    main_console: Console = Console()
+
+    # Get info for both objects
+    lines1: list[Text] = get_simplified_object_info(obj1)
+    lines2: list[Text] = get_simplified_object_info(obj2)
+
+    # Convert list of Text to a single Renderable for Panel
+    inspect_text1: Text = Text("\n").join(lines1)
+    inspect_text2: Text = Text("\n").join(lines2)
+
+    # Create Panels for each object's info
+    panel1: Panel = Panel(inspect_text1, border_style="green", expand=True)
+    panel2: Panel = Panel(inspect_text2, border_style="green", expand=True)
+
+    # Use a Table to display panels side-by-side
+    table = Table(show_header=False, show_lines=False, expand=True)
+    table.add_column(width=main_console.width // 2 - 1)
+    table.add_column(width=main_console.width // 2 - 1)
+    table.add_row(panel1, panel2)
+
+    main_console.print(table)

{debug_dojo-0.7.0 → debug_dojo-0.9.0}/src/debug_dojo/_config.py

@@ -16,7 +16,7 @@ from tomlkit import parse
 from tomlkit.exceptions import TOMLKitError
 from typer import Exit
 
-from ._config_models import (
+from debug_dojo._config_models import (
     DACITE_CONFIG,
     DebugDojoConfig,
     DebugDojoConfigV1,
@@ -33,6 +33,20 @@ def _validate_model(
     model: type[DebugDojoConfigV1 | DebugDojoConfigV2],
     raw_config: JSON,
 ) -> DebugDojoConfigV1 | DebugDojoConfigV2:
+    """Validate the raw configuration against a specific model.
+
+    Args:
+        model (type[DebugDojoConfigV1 | DebugDojoConfigV2]): The model class to use
+            for validation.
+        raw_config (JSON): The raw configuration data.
+
+    Returns:
+        DebugDojoConfigV1 | DebugDojoConfigV2: The validated configuration object.
+
+    Raises:
+        DaciteError: If the configuration does not match the model.
+
+    """
     if not isinstance(raw_config, dict):
         msg = "Configuration must be a dictionary."
         raise DaciteError(msg)
@@ -100,29 +114,29 @@ def load_raw_config(config_path: Path) -> JSON:
 
     # If config is in [tool.debug_dojo] (pyproject.toml), extract it.
     try:
-        dojo_config = cast("JSON", config_data["tool"]["debug_dojo"])
+        dojo_config = cast(JSON, config_data["tool"]["debug_dojo"])
     except KeyError:
         return {}
     else:
         return dojo_config
 
 
-def validated_and_updated_config(raw_config: JSON, *, verbose: bool) -> DebugDojoConfig:
-    """Validate and update the raw configuration to the latest DebugDojoConfig version.
+def _try_validate_config(
+    raw_config: JSON,
+    *,
+    verbose: bool,
+) -> DebugDojoConfigV1 | DebugDojoConfigV2 | None:
+    """Try to validate the raw configuration against known configuration models.
 
     Args:
-        raw_config (JSON): The raw configuration data loaded from a file.
-        verbose (bool): If True, print verbose messages during validation and update.
+        raw_config (JSON): The raw configuration data.
+        verbose (bool): If True, print verbose messages during validation.
 
     Returns:
-        DebugDojoConfig: A validated and updated DebugDojoConfig instance.
-
-    Raises:
-        typer.Exit: If the configuration cannot be validated against any known version.
+        DebugDojoConfigV1 | DebugDojoConfigV2 | None: The validated configuration
+            model, or None if validation fails for all models.
 
     """
-    config: DebugDojoConfigV1 | DebugDojoConfigV2 | None = None
-
     for model in (DebugDojoConfigV2, DebugDojoConfigV1):
         model_name = model.__name__
         try:
@@ -140,7 +154,29 @@ def validated_and_updated_config(raw_config: JSON, *, verbose: bool) -> DebugDoj
                     f"Current configuration model {DebugDojoConfig.__name__}. [/blue]"
                 )
                 rich_print(msg)
-            break
+            return config
+    return None
+
+
+def validated_and_updated_config(
+    raw_config: JSON,
+    *,
+    verbose: bool,
+) -> DebugDojoConfig:
+    """Validate and update the raw configuration to the latest DebugDojoConfig version.
+
+    Args:
+        raw_config (JSON): The raw configuration data loaded from a file.
+        verbose (bool): If True, print verbose messages during validation and update.
+
+    Returns:
+        DebugDojoConfig: A validated and updated DebugDojoConfig instance.
+
+    Raises:
+        typer.Exit: If the configuration cannot be validated against any known version.
+
+    """
+    config = _try_validate_config(raw_config, verbose=verbose)
 
     if not config:
         msg = "[red]Unsupported configuration version or error.[/red]"

{debug_dojo-0.7.0 → debug_dojo-0.9.0}/src/debug_dojo/_config_models.py

@@ -140,6 +140,8 @@ class DebugDojoConfigV2:
     """Default debugger and configs."""
     features: FeaturesConfig = field(default_factory=FeaturesConfig)
     """Features mnemonics."""
+    gamification: bool = True
+    """Enable or disable gamification (Dojo Belts)."""
 
 
 @dataclass
@@ -152,7 +154,12 @@ class DebugDojoConfigV1:
     """Features to install for debugging."""
 
     def update(self) -> DebugDojoConfigV2:
-        """Update the configuration to the latest version."""
+        """Update the configuration to the latest version.
+
+        Returns:
+            DebugDojoConfigV2: The updated configuration object.
+
+        """
         v2_exceptions = ExceptionsConfig(
             rich_traceback=self.features.rich_traceback,
         )