💥 Rewrite by OOP

Author: Freed-Wu

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ exclude: ^templates/
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-added-large-files
       - id: fix-byte-order-marker
@@ -39,7 +39,7 @@ repos:
         args:
           - --msg-filename
   - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
-    rev: 3.2.1
+    rev: 3.4.0
     hooks:
       - id: editorconfig-checker
   - repo: https://github.com/jumanjihouse/pre-commit-hooks
@@ -74,18 +74,13 @@ repos:
       - id: markdownlint-cli2
         additional_dependencies:
           - markdown-it-texmath
-  - repo: https://github.com/Freed-Wu/pre-commit-hooks
-    rev: 0.0.11
-    hooks:
-      - id: update-CITATION.cff
-      - id: update-pyproject.toml
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.13
+    rev: v0.13.0
     hooks:
-      - id: ruff
+      - id: ruff-check
       - id: ruff-format
   - repo: https://github.com/kumaraditya303/mirrors-pyright
-    rev: v1.1.401
+    rev: v1.1.405
     hooks:
       - id: pyright
 

README.md

@@ -39,92 +39,108 @@
 Python REPL plugin for automatic time tracking and metrics generated from your
 programming activity.
 
-![screenshot](https://github.com/user-attachments/assets/b745d591-60ac-462e-9485-1828914706a1)
+![screen](https://github.com/user-attachments/assets/4e337cae-06a7-4164-be83-c7b73e8a0f63)
 
-Supported REPLs:
+## REPLs
 
-- [x] [python](https://github.com/python/cpython):
-  - executes
-    [`str(sys.ps1)`](https://docs.python.org/3/library/sys.html#sys.ps1) after
-    every input.
-  - configure file:
-    [`$PYTHON_STARTUP`](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONSTARTUP).
+### [python](https://github.com/python/cpython)
+
+[`$PYTHON_STARTUP`](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONSTARTUP):
 
 ```python
-from repl_python_wakatime.python import install_hook
+import sys
+
+from repl_python_wakatime.backends.wakatime import Wakatime
+from repl_python_wakatime.frontends.python import Python
 
-install_hook()
+sys.ps1 = Python(Wakatime())
 ```
 
-- [x] [ptpython](https://github.com/prompt-toolkit/ptpython):
-  - executes `get_ptpython().get_output_prompt()` after every output.
-  - configure file: `.../ptpython/config.py`. `...` depends on OS.
+### [ptpython](https://github.com/prompt-toolkit/ptpython)
+
+`${XDG_CONFIG_HOME:-$HOME/.config}/ptpython/config.py`:
 
 ```python
-from ptpython.repl import PythonRepl
-from repl_python_wakatime.ptpython import install_hook
+from repl_python_wakatime.backends.wakatime import Wakatime
+from repl_python_wakatime.frontends.ptpython import Ptpython
 
 
 def configure(repl: PythonRepl) -> None:
-    install_hook(repl)
+    repl.all_prompt_styles[repl.prompt_style] = Ptpython(
+        Wakatime(), repl.all_prompt_styles[repl.prompt_style]
+    )
 ```
 
-- [x] [ipython](https://github.com/ipython/ipython):
-  - executes
-    `c.TerminalInteractiveShell.prompts_class(shell).out_prompt_tokens()` after
-    every output.
-  - configure file: `~/.ipython/profile_default/ipython_config.py`.
+### [ipython](https://github.com/ipython/ipython)/[ptipython](https://github.com/prompt-toolkit/ptpython)
+
+`~/.ipython/profile_default/ipython_config.py`:
 
 ```python
-from repl_python_wakatime.iptpython import install_hook
+from IPython.terminal.prompts import ClassicPrompts
+from repl_python_wakatime.backends.wakatime import Wakatime
+from repl_python_wakatime.frontends.ipython import Ipython
 
-install_hook(c)
+c.TerminalInteractiveShell.prompts_class = lambda *args, **kwargs: Ipython(
+    Wakatime(), ClassicPrompts(*args, **kwargs)
+)
 ```
 
-- [x] [gdb](https://sourceware.org/gdb/):
+### [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
+source ~/.config/gdb/gdbinit.py
 ```
 
-See [GDB Hooks](https://sourceware.org/gdb/current/onlinedocs/gdb.html/Hooks.html)
-to know more.
+`~/.config/gdb/gdbinit.py`:
+
+```python
+from repl_python_wakatime.backends.wakatime import Wakatime
+from repl_python_wakatime.frontends.gdb import StopHook
 
-Use environment variables `HOOK_NAMES=hook1:hook2` to defines which
-[hook](#configure) will be used.
+StopHook(Wakatime())
+```
 
-- [x] [ptipython](https://github.com/prompt-toolkit/ptpython): Same as
-  [ipython](https://github.com/ipython/ipython).
 - [ ] [bpython](https://github.com/bpython/bpython)
 - [ ] [xonsh](https://github.com/xonsh/xonsh)
-- [ ] [mypython](https://github.com/asmeurer/mypython): Won't fix.
-  - configure file: non-exist.
+- [ ] [mypython](https://github.com/asmeurer/mypython): won't fix due to no any
+  configuration.
+- [ ] vim/neovim with python support: see
+  [vim-wakatime](https://github.com/wakatime/vim-wakatime)
+
+## Hooks
 
-`install_hook()` must be after the customization of the prompt string and best
-at the end of file.
+- [x] [wakatime](https://wakatime.com/)
+- [x] [codestats](https://codestats.net/)
+- [ ] [codetime](https://codetime.dev/)
+- [ ] [rescuetime](https://www.rescuetime.com/)
 
-## Configure
+You can use many hooks at the same time:
 
 ```python
-from repl_python_wakatime.python import install_hook
+from repl_python_wakatime.backends.codestats import CodeStats
+from repl_python_wakatime.backends.wakatime import Wakatime
+from repl_python_wakatime.frontends.python import Python
 
-install_hook(hook_function, args, kwargs)
+Python(Wakatime() | CodeStats()).install()
 ```
 
-will execute `hook_function(*args, **kwargs)` after every output/input. Other
-REPLs are similar. Currently, `hook_function` can be:
+## APIs
+
+You can use this project to statistic the time of using any programs. Such as,
+[translate-shell](https://github.com/Freed-Wu/translate-shell/) is a translating
+program:
 
-- `repl_python_wakatime.hooks.wakatime.wakatime_hook()`: By default.
-- `repl_python_wakatime.hooks.codestats.codestats_hook()`: for [codestats](https://codestats.net/)
-- Create your hooks for other similar projects, such as:
-  - [codetime](https://codetime.dev/)
-  - [rescuetime](https://www.rescuetime.com/)
-  - ...
+```python
+from repl_python_wakatime.backends.wakatime import Wakatime
+
+# after each translating
+Wakatime(language="translate-shell", category="translating")()
+```
 
 ## Similar projects
 

src/repl_python_wakatime/backends/__init__.py

@@ -0,0 +1,65 @@
+r"""Backends
+============
+"""
+
+import os
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Self
+
+
+@dataclass
+class Hook:
+    r"""Each frontend should pass its name and language. Such as:
+
+    Ptpython(frontend="ptpython", language="python", category="coding")
+    Gdb(frontend="gdb", language="gdb", category="debugging")
+    """
+
+    frontend: str = "python"
+    language: str = "python"
+    category: str = "coding"
+    hooks: tuple[Self, ...] = ()
+
+    @property
+    def plugin(self) -> str:
+        """Plugin. ``plugin`` must be the format of ``repl-REPL_NAME-wakatime``
+        to let wakatime detect correctly.
+
+        :param self:
+        :rtype: str
+        """
+        if self.category == "coding":
+            return f"repl-{self.frontend}-{self.__class__.__name__.lower()}"
+        return f"{self.language}-{self.__class__.__name__.lower()}"
+
+    @property
+    def language_type(self) -> str:
+        return f"Terminal ({self.language})"
+
+    @staticmethod
+    def get_project(
+        filenames: tuple[str, ...] = (".git/",),
+    ) -> str:
+        """Get project. Its function is like ``git rev-parse --show-toplevel``.
+
+        use current directory as a fallback.
+
+        :param filenames:
+        :type filenames: tuple[str, ...]
+        """
+        cwd = Path(os.getcwd())
+        project = cwd
+        for parent in project.parents:
+            for filename in filenames:
+                if (parent / filename).exists():
+                    return project.name
+        return cwd.name
+
+    def __or__(self, hook: Self) -> "Hook":
+        return Hook(hooks=(self, hook))
+
+    def __call__(self) -> None:
+        r"""Run hook"""
+        for hook in self.hooks:
+            hook()