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

{debug_dojo-0.8.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.8.0
+Version: 0.9.0
 Summary: 🏣 debug dojo, a place for zen debugging
 Author-email: bwrob <bartosz.marcin.wroblewski@gmail.com>
 License-Expression: MIT
@@ -22,7 +22,6 @@ Requires-Python: <3.15,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: dacite>=1.0.0
-Requires-Dist: pyscn>=1.5.2
 Requires-Dist: rich>=10.0.0
 Requires-Dist: tomlkit>=0.7.0
 Requires-Dist: typer>=0.3.0

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

@@ -15,7 +15,6 @@
     ]
     dependencies = [
         "dacite>=1.0.0",
-        "pyscn>=1.5.2",
         "rich>=10.0.0",
         "tomlkit>=0.7.0",
         "typer>=0.3.0",
@@ -32,7 +31,7 @@
     name = "debug-dojo"
     readme = "README.md"
     requires-python = ">=3.10,<3.15"
-    version = "0.8.0"
+    version = "0.9.0"
 
     [project.urls]
         Changelog     = "https://bwrob.github.io/debug-dojo/changelog/"
@@ -74,7 +73,8 @@
         "mkdocstrings-python>=1.17.0",
         "pymdown-extensions>=10.16.1",
         "typst>=0.14.2",
-    ]
+        "refurb>=2.3.0",
+]
 
 
 [tool.uv]

{debug_dojo-0.8.0 → debug_dojo-0.9.0}/src/debug_dojo/_compare.py

@@ -71,14 +71,24 @@ def get_object_methods(obj: object) -> list[str]:
 
 
 def _is_basic_type(obj: object) -> bool:
-    """Check if the object is a basic Python type."""
+    """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."""
+    """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"),
@@ -88,7 +98,12 @@ def _get_basic_info(obj: object) -> list[Text]:
 
 
 def _format_section(title: str, items: list[str], empty_message: str) -> list[Text]:
-    """Format a section of the inspection output."""
+    """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"))
@@ -100,7 +115,12 @@ def _format_section(title: str, items: list[str], empty_message: str) -> list[Te
 
 
 def _get_attributes_section(obj: object) -> list[Text]:
-    """Get the attributes section for the object info."""
+    """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),
@@ -109,7 +129,12 @@ def _get_attributes_section(obj: object) -> list[Text]:
 
 
 def _get_methods_section(obj: object) -> list[Text]:
-    """Get the methods section for the object info."""
+    """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)],
@@ -132,8 +157,7 @@ def get_simplified_object_info(obj: object) -> list[Text]:
     """
     info_lines: list[Text] = []
     obj_type: str = type(obj).__name__
-    info_lines.append(Text(f"<class '{obj_type}'>", style="cyan bold"))
-    info_lines.append(Text(""))
+    info_lines.extend((Text(f"<class '{obj_type}'>", style="cyan bold"), Text("")))
 
     if _is_basic_type(obj):
         info_lines.extend(_get_basic_info(obj))

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

@@ -114,7 +114,7 @@ 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:

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

@@ -154,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,
         )

{debug_dojo-0.8.0 → debug_dojo-0.9.0}/src/debug_dojo/_execution.py

@@ -131,6 +131,9 @@ def _safe_execute(
         target_name (str): The name of the target.
         config (DebugDojoConfig): The configuration object.
 
+    Raises:
+        Exit: If an error occurs or the user interrupts the execution.
+
     """
     try:
         _ = runner(target_name, run_name="__main__")
@@ -167,10 +170,6 @@ def execute_with_debug(
         verbose (bool): If True, print verbose output.
         config (DebugDojoConfig): The debug-dojo configuration.
 
-    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.
-
     """
     _configure_sys_argv(target_name, target_args)
     _install_debug_tools(target_name, target_args, verbose=verbose, config=config)

{debug_dojo-0.8.0 → debug_dojo-0.9.0}/src/debug_dojo/_gamification.py

@@ -94,7 +94,12 @@ class GamificationManager:
         self.stats = self._load_stats()
 
     def _load_stats(self) -> DojoStats:
-        """Load stats from disk."""
+        """Load stats from disk.
+
+        Returns:
+            DojoStats: The loaded user statistics.
+
+        """
         if not self.stats_file.exists():
             return DojoStats()
 
@@ -104,17 +109,15 @@ class GamificationManager:
             if not isinstance(data, dict):
                 return DojoStats()
 
-            data_dict = cast("dict[str, object]", data)
+            data_dict = cast(dict[str, object], data)
 
-            history_raw = cast("list[dict[str, object]]", data_dict.get("history", []))
+            history_raw = cast(list[dict[str, object]], data_dict.get("history", []))
             history: list[SessionInfo] = []
             for s in history_raw:
                 # Support migration from duration_seconds
-                duration = float(cast("float", s.get("duration_minutes", 0.0)))
+                duration = float(cast(float, s.get("duration_minutes", 0.0)))
                 if "duration_seconds" in s and duration == 0:
-                    duration = (
-                        float(cast("float", s.get("duration_seconds", 0.0))) / 60.0
-                    )
+                    duration = float(cast(float, s.get("duration_seconds", 0.0))) / 60.0
 
                 history.append(
                     SessionInfo(
@@ -125,8 +128,8 @@ class GamificationManager:
                 )
 
             return DojoStats(
-                sessions=int(cast("int", data_dict.get("sessions", 0))),
-                bugs_crushed=int(cast("int", data_dict.get("bugs_crushed", 0))),
+                sessions=int(cast(int, data_dict.get("sessions", 0))),
+                bugs_crushed=int(cast(int, data_dict.get("bugs_crushed", 0))),
                 history=history,
             )
 

{debug_dojo-0.8.0 → debug_dojo-0.9.0}/src/debug_dojo/_installers.py

@@ -52,7 +52,7 @@ def use_pdb(config: PdbConfig) -> None:
     import pdb
 
     os.environ[BREAKPOINT_ENV_VAR] = config.set_trace_hook
-    sys.breakpointhook = cast("Any", pdb.set_trace)  # pyright: ignore[reportExplicitAny]
+    sys.breakpointhook = cast(Any, pdb.set_trace)  # pyright: ignore[reportExplicitAny]
 
 
 def use_pudb(config: PudbConfig) -> None:
@@ -72,7 +72,7 @@ def use_pudb(config: PudbConfig) -> None:
         return
 
     os.environ[BREAKPOINT_ENV_VAR] = config.set_trace_hook
-    sys.breakpointhook = cast("Any", pudb.set_trace)  # pyright: ignore[reportExplicitAny]
+    sys.breakpointhook = cast(Any, pudb.set_trace)  # pyright: ignore[reportExplicitAny]
 
 
 def use_ipdb(config: IpdbConfig) -> None:
@@ -93,7 +93,7 @@ def use_ipdb(config: IpdbConfig) -> None:
 
     os.environ[BREAKPOINT_ENV_VAR] = config.set_trace_hook
     os.environ[IPDB_CONTEXT_SIZE] = str(config.context_lines)
-    sys.breakpointhook = cast("Any", ipdb.set_trace)  # pyright: ignore[reportExplicitAny]
+    sys.breakpointhook = cast(Any, ipdb.set_trace)  # pyright: ignore[reportExplicitAny]
 
 
 def use_debugpy(config: DebugpyConfig) -> None:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: debug-dojo
-Version: 0.8.0
+Version: 0.9.0
 Summary: 🏣 debug dojo, a place for zen debugging
 Author-email: bwrob <bartosz.marcin.wroblewski@gmail.com>
 License-Expression: MIT
@@ -22,7 +22,6 @@ Requires-Python: <3.15,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: dacite>=1.0.0
-Requires-Dist: pyscn>=1.5.2
 Requires-Dist: rich>=10.0.0
 Requires-Dist: tomlkit>=0.7.0
 Requires-Dist: typer>=0.3.0

{debug_dojo-0.8.0 → debug_dojo-0.9.0}/src/debug_dojo.egg-info/requires.txt

@@ -1,5 +1,4 @@
 dacite>=1.0.0
-pyscn>=1.5.2
 rich>=10.0.0
 tomlkit>=0.7.0
 typer>=0.3.0

debug_dojo-0.9.0/tests/test_compare.py

@@ -0,0 +1,74 @@
+"""Test the compare utilities."""
+
+from rich.text import Text
+
+from debug_dojo._compare import (
+    get_object_attributes,
+    get_object_methods,
+    get_simplified_object_info,
+)
+
+
+def test_get_object_attributes() -> None:
+    """Test that object attributes are correctly extracted."""
+
+    class MyClass:
+        """A simple class for testing."""
+
+        x: int = 10
+        y: str = "hello"
+
+        def my_method(self) -> None:
+            """Do something."""
+
+    obj = MyClass()
+    attributes = get_object_attributes(obj)
+    assert "x=10" in attributes
+    assert "y='hello'" in attributes
+    assert "my_method" not in attributes
+
+
+def test_get_object_methods() -> None:
+    """Test that object methods are correctly extracted."""
+
+    class MyClass:
+        """A simple class for testing."""
+
+        x: int = 10
+
+        def my_method(self) -> None:
+            """Do something."""
+
+        def _private_method(self) -> None:
+            """Do something else."""
+
+    obj = MyClass()
+    methods = get_object_methods(obj)
+    assert "my_method" in methods
+    assert "_private_method" not in methods
+
+
+def test_get_simplified_object_info_basic_type() -> None:
+    """Test simplified object info for basic types."""
+    info = get_simplified_object_info(123)
+    assert any(isinstance(line, Text) and "123" in line.plain for line in info)
+
+
+def test_get_simplified_object_info_custom_object() -> None:
+    """Test simplified object info for custom objects."""
+
+    class MyClass:
+        """A simple class for testing."""
+
+        x: int = 10
+
+        def my_method(self) -> None:
+            """Do something."""
+
+    obj = MyClass()
+    info = get_simplified_object_info(obj)
+
+    # Check that basic info is present
+    assert any(isinstance(line, Text) and "MyClass" in line.plain for line in info)
+    assert any(isinstance(line, Text) and "x=10" in line.plain for line in info)
+    assert any(isinstance(line, Text) and "my_method" in line.plain for line in info)

{debug_dojo-0.8.0 → debug_dojo-0.9.0}/tests/test_config.py

@@ -17,7 +17,12 @@ from debug_dojo._config_models import DebugDojoConfig, DebuggerType
 
 @pytest.fixture
 def mock_config_file(tmp_path: Path) -> Path:
-    """Create a mock config file."""
+    """Create a mock config file.
+
+    Returns:
+        Path: The path to the created mock configuration file.
+
+    """
     config_content = """
 [debuggers]
 default = "pudb"

{debug_dojo-0.8.0 → debug_dojo-0.9.0}/tests/test_gamification.py

@@ -11,7 +11,12 @@ from debug_dojo._gamification import BELTS, GamificationManager, SessionInfo
 
 @pytest.fixture
 def temp_stats_file(tmp_path: Path) -> Path:
-    """Fixture providing a temporary stats file path."""
+    """Fixture providing a temporary stats file path.
+
+    Returns:
+        Path: The path to a temporary statistics file.
+
+    """
     return tmp_path / "stats.json"
 
 
@@ -26,7 +31,7 @@ def test_initial_stats(temp_stats_file: Path) -> None:
     assert belt_name == "White Belt"
     assert rank == 0
     assert next_sessions == BELTS[1][1]
-    assert next_mins == float(BELTS[1][2])
+    assert next_mins == pytest.approx(float(BELTS[1][2]))  # pyright: ignore[reportUnknownMemberType]
 
 
 def test_increment_session(temp_stats_file: Path) -> None:
@@ -34,39 +39,28 @@ def test_increment_session(temp_stats_file: Path) -> None:
     manager = GamificationManager(stats_path=temp_stats_file)
 
     duration_seconds = 120.0
-
     expected_minutes = 2.0
-
     expected_command = "dojo run script.py"
-
     manager.increment_session(
         duration_seconds=duration_seconds, command=expected_command
     )
 
     assert manager.stats.sessions == 1
-
     assert len(manager.stats.history) == 1
-
     assert manager.stats.history[0].duration_minutes == expected_minutes
-
     assert manager.stats.history[0].command == expected_command
-
     assert manager.stats.total_minutes == expected_minutes
 
     # Verify file persistence
-
     assert temp_stats_file.exists()
-
-    data = cast("dict[str, object]", json.loads(temp_stats_file.read_text()))
-
+    data: dict[str, object] = cast(
+        dict[str, object], json.loads(temp_stats_file.read_text(encoding="utf-8"))
+    )
     assert data["sessions"] == 1
 
-    history = cast("list[dict[str, object]]", data["history"])
-
+    history = cast(list[dict[str, object]], data["history"])
     assert len(history) == 1
-
     assert history[0]["duration_minutes"] == expected_minutes
-
     assert history[0]["command"] == expected_command
 
 
@@ -92,18 +86,13 @@ def test_load_existing_stats(temp_stats_file: Path) -> None:
         ],
     }
 
-    _ = temp_stats_file.write_text(json.dumps(data))
+    _ = temp_stats_file.write_text(json.dumps(data), encoding="utf-8")
 
     manager = GamificationManager(stats_path=temp_stats_file)
-
     assert manager.stats.sessions == expected_sessions
-
     assert manager.stats.bugs_crushed == expected_bugs
-
     assert len(manager.stats.history) == 1
-
     assert manager.stats.history[0].command == "dojo run test.py"
-
     assert manager.stats.total_minutes == expected_mins
 
 
@@ -122,10 +111,8 @@ def test_load_legacy_stats(temp_stats_file: Path) -> None:
         ],
     }
 
-    _ = temp_stats_file.write_text(json.dumps(data))
-
+    _ = temp_stats_file.write_text(json.dumps(data), encoding="utf-8")
     manager = GamificationManager(stats_path=temp_stats_file)
-
     assert manager.stats.total_minutes == expected_mins
 
 
@@ -153,7 +140,7 @@ def test_belt_progression(temp_stats_file: Path) -> None:
 
 def test_corrupt_stats_file(temp_stats_file: Path) -> None:
     """Test that corrupt stats file is handled gracefully."""
-    _ = temp_stats_file.write_text("invalid json")
+    _ = temp_stats_file.write_text("invalid json", encoding="utf-8")
 
     manager = GamificationManager(stats_path=temp_stats_file)
     assert manager.stats.sessions == 0

debug_dojo-0.8.0/tests/test_compare.py

@@ -1,75 +0,0 @@
-"""Test the `_compare` module."""
-
-from rich.text import Text
-
-from debug_dojo._compare import (
-    get_object_attributes,
-    get_object_methods,
-    get_simplified_object_info,
-)
-
-
-class TestCompare:
-    """Test the compare utilities."""
-
-    def test_get_object_attributes(self) -> None:
-        """Test that object attributes are correctly extracted."""
-
-        class MyClass:
-            """A simple class for testing."""
-
-            x: int = 10
-            y: str = "hello"
-
-            def my_method(self) -> None:
-                """Do something."""
-
-        obj = MyClass()
-        attributes = get_object_attributes(obj)
-        assert "x=10" in attributes
-        assert "y='hello'" in attributes
-        assert "my_method" not in attributes
-
-    def test_get_object_methods(self) -> None:
-        """Test that object methods are correctly extracted."""
-
-        class MyClass:
-            """A simple class for testing."""
-
-            x: int = 10
-
-            def my_method(self) -> None:
-                """Do something."""
-
-            def _private_method(self) -> None:
-                """Do something else."""
-
-        obj = MyClass()
-        methods = get_object_methods(obj)
-        assert "my_method" in methods
-        assert "_private_method" not in methods
-
-    def test_get_simplified_object_info_basic_type(self) -> None:
-        """Test simplified object info for basic types."""
-        info = get_simplified_object_info(123)
-        assert any(isinstance(line, Text) and "123" in line.plain for line in info)
-
-    def test_get_simplified_object_info_custom_object(self) -> None:
-        """Test simplified object info for custom objects."""
-
-        class MyClass:
-            """A simple class for testing."""
-
-            x: int = 10
-
-            def my_method(self) -> None:
-                """Do something."""
-
-        obj = MyClass()
-        info = get_simplified_object_info(obj)
-        plain_info = "\n".join(line.plain for line in info)
-        assert "<class 'MyClass'>" in plain_info
-        assert "Attributes:" in plain_info
-        assert "x=10" in plain_info
-        assert "Methods:" in plain_info
-        assert "my_method()" in plain_info