debug-dojo 0.3.1__tar.gz → 0.4.0__tar.gz

{debug_dojo-0.3.1 → debug_dojo-0.4.0}/.gitignore

@@ -205,3 +205,4 @@ __marimo__/
 # IDE specific files
 .idea/
 .vscode/
+.DS_Store

{debug_dojo-0.3.1 → debug_dojo-0.4.0}/HISTORY.md

@@ -1,37 +1,37 @@
-## v0.3.0 (2025-07-20)
+## v0.4.0 (2025-08-10)
 
-*release tag*: [v0.3.0]
+*release tag*: [v0.4.0]
 
-### What's Changed
+- New configuration model `DebugDojoConfig` for better structure.
+- Added support for `debugger` configuration in `dojo.toml`.
+- Updated `dojo` command to include debugger type in command call.
+- Configuration versioning allows for in-flight migration of old configurations.
+- Improved error handling in configuration loading.
+- Improved catching errors from target execution.
+
+## v0.3.2 (2025-07-28)
+
+*release tag*: [v0.3.2]
 
 - New logo for the project.
 - Typer used for CLI implementation.
 - Dojo is configured via `dojo.toml` or `pyproject.toml`.
-
-#### Fixes
-
+- Support for `debugpy` and `ipdb` for debugging.
 - Fixed documentation and history.
 
 ## v0.2.0 (2025-07-20)
 
 *release tag*: [v0.2.0]
 
-### What's Changed
-
 - Added `dojo` command for easy debugging setup.
 - Added `p()` function for rich printing.
 - Added history file for tracking changes.
 - Moved to `hatch` for building and packaging.
-
-#### Fixes
-
 - Fixed `pyproject.toml` to point to GitHub repository as the homepage.
 
 ## v0.1.0 (2025-07-19)
 
 *release tag*: [v0.1.0]
 
-### What's Changed
-
 - Initial module to install debugging tools.
 - Debug mode utilities for PuDB, rich tracebacks, and object inspection.

{debug_dojo-0.3.1 → debug_dojo-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: debug-dojo
-Version: 0.3.1
+Version: 0.4.0
 Summary: Debbugging dojo for Python developers
 Project-URL: Homepage, https://github.com/bwrob/debug-dojo
 Project-URL: Documentation, https://github.com/bwrob/debug-dojo/blob/main/README.md
@@ -8,6 +8,7 @@ Project-URL: Source, https://github.com/bwrob/debug-dojo/tree/main/src/debug_doj
 Project-URL: Changelog, https://github.com/bwrob/debug-dojo/blob/main/HISTORY.md
 Author-email: bwrob <bartosz.marcin.wroblewski@gmail.com>
 License-Expression: MIT
+License-File: LICENSE
 Keywords: debugging,inspection,pudb,rich,tools,traceback
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -30,7 +31,7 @@ Requires-Dist: typer>=0.15.0
 Description-Content-Type: text/markdown
 
 <p align="center">
-  <img src="https://github.com/bwrob/debug-dojo/blob/main/logo/logo_white.png?raw=true" alt="debug dojo" style="width:50%; max-width:400px;"/>
+  <img src="https://github.com/bwrob/debug-dojo/blob/main/logo/logo_python.png?raw=true" alt="debug dojo" style="width:50%; max-width:300px;"/>
 </p>
 
 <p align="center">
@@ -40,15 +41,17 @@ Description-Content-Type: text/markdown
 [![PyPi Version](https://img.shields.io/pypi/v/debug-dojo.svg?style=flat-square)](https://pypi.org/project/debug-dojo)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/debug-dojo.svg?style=flat-square)](https://pypi.org/pypi/debug-dojo/)
 
-**debug-dojo** is a Python package providing utilities for enhanced debugging and inspection in the terminal. It leverages [`rich`](https://github.com/Textualize/rich) for beautiful output and offers helpers for side-by-side object comparison, improved tracebacks from `rich`, and easy integration with different debuggers. All tools can be installed at once or individually, allowing for flexible debugging setups.
+**debug-dojo** is a Python package providing utilities for enhanced debugging and inspection in the terminal. 
+It leverages [`rich`](https://github.com/Textualize/rich) for beautiful output and offers helpers for side-by-side object comparison, improved tracebacks from `rich`, and easy integration with different debuggers -- `debugpy`, `pudb`, `pdb`, and `ipdb`.
 
 ## Features
 
 - **Convenient CLI** Quickly run your code with debugging tools enabled.
 - **Simple API:** Install all tools or only what you need.
-- **Debugger integration:** Quickly enable Debugpy, PuDB, PDB, or IPDB as your default debugger.
+- **Debugger integration:** Quickly enable Debugpy, PuDB, PDB, or IPDB as your default pre-configured debugger.
 - **Rich tracebacks:** Get readable, colorized tracebacks for easier debugging.
 - **Side-by-side object inspection:** Visually compare Python objects, their attributes, and methods in the terminal.
+- **Configuration:** Easily configure the debugging tools using `dojo.toml` or `pyproject.toml`.
 
 ## Usage
 
@@ -60,10 +63,10 @@ Run your Python script with debugging tools enabled using the `debug-dojo` comma
 dojo my_script.py
 ```
 
-You can optionally set configuration file and verbose mode:
+You can optionally set configuration, verbose mode, and specify the debugger type. Both script files and modules are supported:
 
 ```console
-dojo --config dojo.toml --verbose my_script.py
+dojo --debugger ipdb --config dojo.toml --verbose --module my_module
 ```
 
 ### From the code
@@ -71,19 +74,18 @@ dojo --config dojo.toml --verbose my_script.py
 In the `PuDB` style, you can install all debugging tools and enter the debugging mode with a single command:
 
 ```python
-import debug_dojo.install; b()
-
 object_1 = {"foo": 1, "bar": 2}
 object_2 = [1, 2, 3]
 
+import debug_dojo.install; b()
 p(object_1)  # Pretty print an object with Rich
-i(object_1)  # Inspect an object
-c(object_1, object_2)  # Compare two objects side-by-side
 ```
 
-Where:
+### Features in debugging mode
+
+The following functions are available in the debugging mode, injected into builtins:
 
-- `b()` is a builtin-injected function that sets a breakpoint using PuDB's `set_trace()`.
+- `b()` is a hook that sets a breakpoint using the configured debugger.
 - `p(object_1)` is pretty printing of an object using Rich.
 - `i(object_1)` to inspect an object using Rich.
 - `c(object_1, object_2)` to compare two objects side-by-side.
@@ -95,12 +97,23 @@ You can configure the debugging tools using a `dojo.toml` or `pyproject.toml` fi
 **Example `dojo.toml`:**
 
 ```toml
-debugger = "ipdb"
+[debuggers]
+    default = "ipdb"
+
+    debugpy = { port = 1992 }
+    ipdb    = { context_lines = 20 }
+
+[exceptions]
+    locals_in_traceback = false
+    post_mortem         = true
+    rich_traceback      = true
 
 [features]
-  rich_inspect = true
-  rich_print = true
-  comparer = false
+    breakpoint   = "b"
+    # Empty string means disable the feature
+    comparer     = ""
+    rich_inspect = "i"
+    rich_print   = "p"
 ```
 
 ## Installation
@@ -130,45 +143,50 @@ Note that dojo most likely will not work when installed via `pipx` or `uvx`, as
 ```console
 ruff check src/debug_dojo --fix
 basedpyright src/debug_dojo
+
+poe code-quality
 ```
 
+### Tests
+
+TBA
 
 ## Changelog
 
-## v0.3.0 (2025-07-20)
+## v0.4.0 (2025-08-10)
 
-*release tag*: [v0.3.0]
+*release tag*: [v0.4.0]
 
-### What's Changed
+- New configuration model `DebugDojoConfig` for better structure.
+- Added support for `debugger` configuration in `dojo.toml`.
+- Updated `dojo` command to include debugger type in command call.
+- Configuration versioning allows for in-flight migration of old configurations.
+- Improved error handling in configuration loading.
+- Improved catching errors from target execution.
+
+## v0.3.2 (2025-07-28)
+
+*release tag*: [v0.3.2]
 
 - New logo for the project.
 - Typer used for CLI implementation.
 - Dojo is configured via `dojo.toml` or `pyproject.toml`.
-
-#### Fixes
-
+- Support for `debugpy` and `ipdb` for debugging.
 - Fixed documentation and history.
 
 ## v0.2.0 (2025-07-20)
 
 *release tag*: [v0.2.0]
 
-### What's Changed
-
 - Added `dojo` command for easy debugging setup.
 - Added `p()` function for rich printing.
 - Added history file for tracking changes.
 - Moved to `hatch` for building and packaging.
-
-#### Fixes
-
 - Fixed `pyproject.toml` to point to GitHub repository as the homepage.
 
 ## v0.1.0 (2025-07-19)
 
 *release tag*: [v0.1.0]
 
-### What's Changed
-
 - Initial module to install debugging tools.
 - Debug mode utilities for PuDB, rich tracebacks, and object inspection.

{debug_dojo-0.3.1 → debug_dojo-0.4.0}/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://github.com/bwrob/debug-dojo/blob/main/logo/logo_white.png?raw=true" alt="debug dojo" style="width:50%; max-width:400px;"/>
+  <img src="https://github.com/bwrob/debug-dojo/blob/main/logo/logo_python.png?raw=true" alt="debug dojo" style="width:50%; max-width:300px;"/>
 </p>
 
 <p align="center">
@@ -9,15 +9,17 @@
 [![PyPi Version](https://img.shields.io/pypi/v/debug-dojo.svg?style=flat-square)](https://pypi.org/project/debug-dojo)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/debug-dojo.svg?style=flat-square)](https://pypi.org/pypi/debug-dojo/)
 
-**debug-dojo** is a Python package providing utilities for enhanced debugging and inspection in the terminal. It leverages [`rich`](https://github.com/Textualize/rich) for beautiful output and offers helpers for side-by-side object comparison, improved tracebacks from `rich`, and easy integration with different debuggers. All tools can be installed at once or individually, allowing for flexible debugging setups.
+**debug-dojo** is a Python package providing utilities for enhanced debugging and inspection in the terminal. 
+It leverages [`rich`](https://github.com/Textualize/rich) for beautiful output and offers helpers for side-by-side object comparison, improved tracebacks from `rich`, and easy integration with different debuggers -- `debugpy`, `pudb`, `pdb`, and `ipdb`.
 
 ## Features
 
 - **Convenient CLI** Quickly run your code with debugging tools enabled.
 - **Simple API:** Install all tools or only what you need.
-- **Debugger integration:** Quickly enable Debugpy, PuDB, PDB, or IPDB as your default debugger.
+- **Debugger integration:** Quickly enable Debugpy, PuDB, PDB, or IPDB as your default pre-configured debugger.
 - **Rich tracebacks:** Get readable, colorized tracebacks for easier debugging.
 - **Side-by-side object inspection:** Visually compare Python objects, their attributes, and methods in the terminal.
+- **Configuration:** Easily configure the debugging tools using `dojo.toml` or `pyproject.toml`.
 
 ## Usage
 
@@ -29,10 +31,10 @@ Run your Python script with debugging tools enabled using the `debug-dojo` comma
 dojo my_script.py
 ```
 
-You can optionally set configuration file and verbose mode:
+You can optionally set configuration, verbose mode, and specify the debugger type. Both script files and modules are supported:
 
 ```console
-dojo --config dojo.toml --verbose my_script.py
+dojo --debugger ipdb --config dojo.toml --verbose --module my_module
 ```
 
 ### From the code
@@ -40,19 +42,18 @@ dojo --config dojo.toml --verbose my_script.py
 In the `PuDB` style, you can install all debugging tools and enter the debugging mode with a single command:
 
 ```python
-import debug_dojo.install; b()
-
 object_1 = {"foo": 1, "bar": 2}
 object_2 = [1, 2, 3]
 
+import debug_dojo.install; b()
 p(object_1)  # Pretty print an object with Rich
-i(object_1)  # Inspect an object
-c(object_1, object_2)  # Compare two objects side-by-side
 ```
 
-Where:
+### Features in debugging mode
 
-- `b()` is a builtin-injected function that sets a breakpoint using PuDB's `set_trace()`.
+The following functions are available in the debugging mode, injected into builtins:
+
+- `b()` is a hook that sets a breakpoint using the configured debugger.
 - `p(object_1)` is pretty printing of an object using Rich.
 - `i(object_1)` to inspect an object using Rich.
 - `c(object_1, object_2)` to compare two objects side-by-side.
@@ -64,12 +65,23 @@ You can configure the debugging tools using a `dojo.toml` or `pyproject.toml` fi
 **Example `dojo.toml`:**
 
 ```toml
-debugger = "ipdb"
+[debuggers]
+    default = "ipdb"
+
+    debugpy = { port = 1992 }
+    ipdb    = { context_lines = 20 }
+
+[exceptions]
+    locals_in_traceback = false
+    post_mortem         = true
+    rich_traceback      = true
 
 [features]
-  rich_inspect = true
-  rich_print = true
-  comparer = false
+    breakpoint   = "b"
+    # Empty string means disable the feature
+    comparer     = ""
+    rich_inspect = "i"
+    rich_print   = "p"
 ```
 
 ## Installation
@@ -99,4 +111,10 @@ Note that dojo most likely will not work when installed via `pipx` or `uvx`, as
 ```console
 ruff check src/debug_dojo --fix
 basedpyright src/debug_dojo
+
+poe code-quality
 ```
+
+### Tests
+
+TBA

{debug_dojo-0.3.1 → debug_dojo-0.4.0}/pyproject.toml

@@ -13,7 +13,7 @@
         "rich>=12.0.0",
         "tomlkit>=0.13.3",
         "typer>=0.15.0",
-]
+    ]
     license = 'MIT'
     license-files = ['LICENSE']
     keywords = [
@@ -36,7 +36,7 @@
         "Topic :: Software Development :: Debuggers",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ]
-version = "0.3.1"
+    version = "0.4.0"
     dynamic = ['readme']
 
     [project.urls]
@@ -46,8 +46,6 @@ version = "0.3.1"
         Changelog     = "https://github.com/bwrob/debug-dojo/blob/main/HISTORY.md"
 
     [project.scripts]
-        # This defines your command-line script!
-        # It points to the 'main' function in your 'cli' module.
         "dojo" = "debug_dojo._cli:main"
 
 [dependency-groups]
@@ -56,7 +54,7 @@ version = "0.3.1"
         "jupyter>=1.1.1",
         "poethepoet>=0.36.0",
         "ruff>=0.12.4",
-]
+    ]
 
 [build-system]
     requires = [
@@ -65,10 +63,6 @@ version = "0.3.1"
     ]
     build-backend = "hatchling.build"
 
-
-[tool.hatch.version]
-    path = "src/debug_dojo/version.py"
-
 [tool.hatch.metadata]
     allow-direct-references = true
 
@@ -81,15 +75,28 @@ version = "0.3.1"
             { path = 'HISTORY.md' },
         ]
 
+
+[tool.hatch.build.targets.sdist]
+    include = [
+        "/README.md",
+        "/HISTORY.md",
+        "/src/debug_dojo",
+    ]
+
 [tool.basedpyright]
-    typeCheckingMode = "all"
+    typeCheckingMode = "basic"
     pythonVersion    = "3.10"
     strict           = ["src/debug_dojo/*"]
     ignore           = ["examples"]
 
 [tool.poe.tasks]
-    # Define your tasks here
     lint = "ruff check --fix src"
     format = "ruff format src"
-    type-check = "basedpyright"
+    type-check = "basedpyright --project pyproject.toml src/debug_dojo"
     code-quality = ["format", "lint", "type-check"]
+    publish = [
+        "code-quality",
+        { cmd = "rm -rf dist" },
+        { cmd = "uv build" },
+        { cmd = "uv publish" },
+    ]

{debug_dojo-0.3.1 → debug_dojo-0.4.0}/src/debug_dojo/_cli.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import os
 import runpy
 import sys
 from bdb import BdbQuit
@@ -10,10 +9,9 @@ from pathlib import Path
 from typing import Annotated
 
 import typer
-from pydantic import ValidationError
 from rich import print as rich_print
 
-from ._config import DebugDojoConfig, load_config
+from ._config import DebugDojoConfig, DebuggerType, load_config
 from ._installers import install_by_config
 
 cli = typer.Typer(
@@ -23,11 +21,13 @@ cli = typer.Typer(
 )
 
 
-def execute_with_debug(
+def execute_with_debug(  # noqa: C901
     target_name: str,
     target_args: list[str],
     *,
+    target_is_module: bool,
     verbose: bool,
+    config: DebugDojoConfig,
 ) -> None:
     """Execute a target script or module with installation of debugging tools."""
     sys.argv = [target_name, *target_args]
@@ -36,21 +36,37 @@ def execute_with_debug(
         rich_print(f"[blue]Installing debugging tools for {target_name}.[/blue]")
         rich_print(f"[blue]Arguments for target: {target_args}[/blue]")
 
-    config = load_config()
     install_by_config(config)
 
-    if (
-        Path(target_name).exists()
-        or target_name.endswith(".py")
-        or os.sep in target_name
-    ):
+    if target_is_module:
+        runner = runpy.run_module
+    else:
         if not Path(target_name).exists():
             sys.exit(1)
         runner = runpy.run_path
-    else:
-        runner = runpy.run_module
 
-    _ = runner(target_name, run_name="__main__")
+    try:
+        _ = runner(target_name, run_name="__main__")
+    except ImportError as e:
+        rich_print(f"[red]Error importing {target_name}:[/red]\n{e}")
+        sys.exit(1)
+    except BdbQuit:
+        rich_print("[red]Debugging session terminated by user.[/red]")
+        sys.exit(0)
+    except KeyboardInterrupt:
+        rich_print("[red]Execution interrupted by user.[/red]")
+        sys.exit(0)
+    except SystemExit as e:
+        if e.code:
+            rich_print(f"[red]Script exited with code {e.code}.[/red]")
+    except Exception as e:  # noqa: BLE001
+        rich_print(f"[red]Error while running {target_name}:[/red]\n{e}")
+        if config.exceptions.post_mortem:
+            import pdb  # noqa: PLC0415, T100
+
+            rich_print("[blue]Entering post-mortem debugging session...[/blue]")
+            pdb.post_mortem(e.__traceback__)
+        sys.exit(1)
 
 
 def display_config(config: DebugDojoConfig) -> None:
@@ -64,36 +80,42 @@ def display_config(config: DebugDojoConfig) -> None:
     no_args_is_help=True,
     context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
 )
-def run_debug(
+def run_debug(  # noqa: PLR0913
     ctx: typer.Context,
     target_name: Annotated[
         str | None, typer.Argument(help="The target script or module to debug.")
     ] = None,
+    *,
     config_path: Annotated[
         Path | None, typer.Option("--config", "-c", help="Show configuration")
     ] = None,
-    *,
+    debugger: Annotated[
+        DebuggerType | None,
+        typer.Option("--debugger", "-d", help="Specify the debugger to use"),
+    ] = None,
     verbose: Annotated[
         bool,
         typer.Option("--verbose", "-v", is_flag=True, help="Enable verbose output"),
     ] = False,
+    module: Annotated[
+        bool,
+        typer.Option("--module", "-m", is_flag=True, help="Run as a module"),
+    ] = False,
 ) -> None:
     """Run the command-line interface."""
-    try:
-        config = load_config(config_path, verbose=verbose)
-    except ValidationError as e:
-        rich_print(f"[red]Configuration error:\n{e}[/red]")
-        sys.exit(1)
+    config = load_config(config_path, verbose=verbose, debugger=debugger)
 
     if verbose:
         display_config(config)
 
     if target_name:
-        try:
-            execute_with_debug(target_name, ctx.args, verbose=verbose)
-        except BdbQuit:
-            rich_print("[red]Debugging session terminated by user.[/red]")
-            sys.exit(0)
+        execute_with_debug(
+            target_name=target_name,
+            target_is_module=module,
+            target_args=ctx.args,
+            verbose=verbose,
+            config=config,
+        )
 
 
 def main() -> None:

debug_dojo-0.4.0/src/debug_dojo/_config.py

@@ -0,0 +1,136 @@
+"""Debug Dojo configuration module.
+
+It includes configurations for different debuggers, exception handling,
+and features that can be enabled or disabled.
+"""
+
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+from typing import Any, cast
+
+from pydantic import ValidationError
+from rich import print as rich_print
+from tomlkit import parse
+from tomlkit.exceptions import TOMLKitError
+
+from ._config_models import (
+    DebugDojoConfig,
+    DebugDojoConfigV1,
+    DebugDojoConfigV2,
+    DebuggerType,
+)
+
+
+def __filter_pydantic_error_msg(error: ValidationError) -> str:
+    """Filter out specific lines from a Pydantic validation error."""
+    return "\n".join(
+        line
+        for line in str(error).splitlines()
+        if not line.startswith("For further information visit")
+    )
+
+
+def resolve_config_path(config_path: Path | None) -> Path | None:
+    """Resolve the configuration path, returning a default if none is provided."""
+    if config_path:
+        if not config_path.exists():
+            msg = f"Configuration file not found:\n{config_path.resolve()}"
+            raise FileNotFoundError(msg)
+        return config_path.resolve()
+
+    # Default configuration path
+    for path in (Path("dojo.toml"), Path("pyproject.toml")):
+        if path.exists():
+            return path.resolve()
+    return None
+
+
+def load_raw_config(
+    config_path: Path,
+) -> dict[str, Any]:  # pyright: ignore[reportExplicitAny]
+    """Load the Debug Dojo configuration from a file.
+
+    Currently supports 'dojo.toml' or 'pyproject.toml'.
+    If no path is provided, it checks the current directory for these files.
+    """
+    config_str = config_path.read_text(encoding="utf-8")
+
+    try:
+        config_data = parse(config_str).unwrap()
+    except TOMLKitError as e:
+        msg = f"Error parsing configuration file {config_path.resolve()}."
+        raise ValueError(msg) from e
+
+    # If config is in [tool.debug_dojo] (pyproject.toml), extract it.
+    if config_path.name == "pyproject.toml":
+        try:
+            dojo_config = cast("dict[str, Any]", config_data["tool"]["debug_dojo"])
+        except KeyError:
+            return {}
+        else:
+            return dojo_config
+
+    return config_data
+
+
+def load_config(  # noqa: C901
+    config_path: Path | None = None,
+    *,
+    verbose: bool = False,
+    debugger: DebuggerType | None = None,
+) -> DebugDojoConfig:
+    """Load the Debug Dojo configuration and return a DebugDojoConfig instance."""
+    resolved_path = resolve_config_path(config_path)
+
+    if verbose:
+        if resolved_path:
+            msg = f"Using configuration file: {resolved_path}."
+        else:
+            msg = "No configuration file found, using default settings."
+        rich_print(f"[blue]{msg}[/blue]")
+
+    if not resolved_path:
+        return DebugDojoConfig()
+
+    raw_config = load_raw_config(resolved_path)
+
+    config = None
+    for model in (DebugDojoConfigV2, DebugDojoConfigV1):
+        model_name = model.__name__
+        try:
+            config = model.model_validate(raw_config)
+        except ValidationError as e:
+            if verbose:
+                msg = (
+                    f"[yellow]Configuration validation error for {model_name}:\n"
+                    f"{__filter_pydantic_error_msg(e)}\n\n"
+                    f"Please check your configuration file {resolved_path}.[/yellow]"
+                )
+                rich_print(msg)
+        else:
+            if verbose or model_name != DebugDojoConfig.__name__:
+                msg = (
+                    f"[blue]Using configuration model: {model_name}.\n"
+                    f"Current configuration model {DebugDojoConfig.__name__}. [/blue]"
+                )
+                rich_print(msg)
+            break
+
+    if not config:
+        msg = (
+            f"[red]Unsupported configuration version in {resolved_path.resolve()}.\n"
+            "Please update your configuration file.[/red]"
+        )
+        rich_print(msg)
+        sys.exit(1)
+
+    while not isinstance(config, DebugDojoConfig):
+        config = config.update()
+
+    # If a debugger is specified, update the config.
+    if debugger:
+        config.debuggers.default = debugger
+
+    return config