✨ Support gdb

Author: Freed-Wu

.github/workflows/main.yml

@@ -77,7 +77,7 @@ jobs:
         with:
           path: |
             dist/*
-      - uses: softprops/action-gh-release@v1
+      - uses: softprops/action-gh-release@v2
         if: runner.os == 'Linux' && startsWith(github.ref, 'refs/tags/')
         with:
           # body_path: build/CHANGELOG.md

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ exclude: ^templates/
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: fix-byte-order-marker
@@ -27,7 +27,7 @@ repos:
     hooks:
       - id: remove-crlf
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.4.1
     hooks:
       - id: codespell
         additional_dependencies:
@@ -39,23 +39,23 @@ repos:
         args:
           - --msg-filename
   - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
-    rev: 2.7.3
+    rev: 3.2.1
     hooks:
       - id: editorconfig-checker
   - repo: https://github.com/jumanjihouse/pre-commit-hooks
     rev: 3.0.0
     hooks:
       - id: check-mailmap
   - repo: https://github.com/rhysd/actionlint
-    rev: v1.6.27
+    rev: v1.7.7
     hooks:
       - id: actionlint
   - repo: https://github.com/adrienverge/yamllint
-    rev: v1.35.1
+    rev: v1.37.1
     hooks:
       - id: yamllint
   - repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.17
+    rev: 0.7.22
     hooks:
       - id: mdformat
         additional_dependencies:
@@ -64,12 +64,12 @@ repos:
           - mdformat-myst
           - mdformat-toc
           - mdformat-deflist
-          - mdformat-beautysh
+          # - mdformat-beautysh
           - mdformat-ruff
           - mdformat-config
           - mdformat-web
   - repo: https://github.com/DavidAnson/markdownlint-cli2
-    rev: v0.12.1
+    rev: v0.18.1
     hooks:
       - id: markdownlint-cli2
         additional_dependencies:
@@ -80,18 +80,14 @@ repos:
       - id: update-CITATION.cff
       - id: update-pyproject.toml
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.2.1
+    rev: v0.11.13
     hooks:
       - id: ruff
       - id: ruff-format
   - repo: https://github.com/kumaraditya303/mirrors-pyright
-    rev: v1.1.350
+    rev: v1.1.401
     hooks:
       - id: pyright
-  - repo: https://github.com/nix-community/nixpkgs-fmt
-    rev: v1.3.0
-    hooks:
-      - id: nixpkgs-fmt
 
 ci:
   skip:

README.md

@@ -39,7 +39,7 @@
 Python REPL plugin for automatic time tracking and metrics generated from your
 programming activity.
 
-![screenshot](https://github.com/wakatime/repl-python-wakatime/assets/32936898/d0ac2fab-f9c2-4213-99e3-4249279b1213)
+![screenshot](https://github.com/user-attachments/assets/b745d591-60ac-462e-9485-1828914706a1)
 
 Supported REPLs:
 
@@ -81,6 +81,23 @@ from repl_python_wakatime.iptpython import install_hook
 install_hook(c)
 ```
 
+- [x] [gdb](https://sourceware.org/gdb/):
+
+Your `gdb` must be compiled with
+[python port](https://sourceware.org/gdb/current/onlinedocs/gdb.html/Python.html).
+
+`~/.config/gdb/gdbinit`:
+
+```gdb
+source /the/path/of/repl_python_wakatime/gdb.py
+```
+
+See [GDB Hooks](https://sourceware.org/gdb/current/onlinedocs/gdb.html/Hooks.html)
+to know more.
+
+Use environment variables `HOOK_NAMES=hook1:hook2` to defines which
+[hook](#configure) will be used.
+
 - [x] [ptipython](https://github.com/prompt-toolkit/ptpython): Same as
   [ipython](https://github.com/ipython/ipython).
 - [ ] [bpython](https://github.com/bpython/bpython)
@@ -109,14 +126,6 @@ REPLs are similar. Currently, `hook_function` can be:
   - [rescuetime](https://www.rescuetime.com/)
   - ...
 
-## Related programs
-
-Some programs is written in python or providing a python port.
-We can use this project to statistic their time:
-
-- [gdb](https://sourceware.org/gdb): See
-  [here](https://github.com/Freed-Wu/gdb-prompt)
-
 ## Similar projects
 
 - [wakatime plugins for python and many shells](https://wakatime.com/terminal)

src/repl_python_wakatime/gdb.py

@@ -0,0 +1,30 @@
+r"""GDB hook
+============
+
+Record your debug time to use gdb in wakatime.
+"""
+
+import os
+
+import gdb  # type: ignore
+
+hook_names = os.getenv("HOOK_NAMES", "wakatime")
+
+for hook_name in hook_names.split(":"):
+    if hook_name == "wakatime":
+        from repl_python_wakatime.hooks.wakatime import wakatime_hook as hook
+    elif hook_name == "codestats":
+        from repl_python_wakatime.hooks.codestats import codestats_hook as hook
+    else:
+        raise NotImplementedError
+
+
+class StopHook:
+    def __init__(self):
+        gdb.events.stop.connect(self.handler)
+
+    def handler(self, event):
+        hook(plugin="repl-gdb-wakatime", language="gdb", category="debugging")
+
+
+StopHook()

tests/test_api.py

@@ -3,6 +3,7 @@
 """
 
 import pytest
+
 from repl_python_wakatime.hooks.codestats import CodeStats
 from repl_python_wakatime.utils.api import get_api_key