✨ Support ptpython/ipython/ptipython

Author: Freed-Wu

.pre-commit-config.yaml

@@ -57,6 +57,7 @@ repos:
         args:
           - --number
         additional_dependencies:
+          - mdformat-gfm
           - mdformat-myst
           - mdformat-toc
           - mdformat-deflist

CITATION.cff

@@ -6,6 +6,6 @@ authors:
   - family-names: Wu
     given-names: Zhenyu
     orcid: https://orcid.org/0000-0001-6478-9993
-title: "python-wakatime: wakatime plugin for python"
+title: "python-wakatime: wakatime plugin for python REPLs"
 date-released: 2023-01-12
 url: https://github.com/Freed-Wu/python-wakatime

README.md

@@ -36,33 +36,59 @@
 [![pypi/implementation](https://shields.io/pypi/implementation/python-wakatime)](https://pypi.org/project/python-wakatime/#files)
 [![pypi/pyversions](https://shields.io/pypi/pyversions/python-wakatime)](https://pypi.org/project/python-wakatime/#files)
 
-[wakatime](https://wakatime.com) plugin for python.
+[wakatime](https://wakatime.com) plugin for python REPLs.
 
-## Usage
+Supported REPLs:
 
-Add the following code to your
-[`$PYTHON_STARTUP`](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONSTARTUP):
+- [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
-from python_wakatime import install_hook
+from python_wakatime.python import install_hook
 
-# ... # customize your PS1
-
-# must after customization of PS1, best at the end of file
 install_hook()
 ```
 
-## FAQ
+- [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.
+
+```python
+from ptpython.repl import PythonRepl
+from python_wakatime.ptpython import install_hook
+
+
+def configure(repl: PythonRepl) -> None:
+    install_hook(repl)
+```
+
+- [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`.
+
+```python
+from python_wakatime.iptpython import install_hook
+
+install_hook(c)
+```
 
-Q: How does it work?
+- [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.
 
-A: Python executes
-[`str(sys.ps1)`](https://docs.python.org/3/library/sys.html#sys.ps1) after
-every inputting of the user. We can do anything what we want in
-`sys.ps1.__str__()`.
+`install_hook()` must after customization of prompt string, best at the end of file.
 
 ## Similar projects
 
-- <https://wakatime.com/terminal> lists wakatime plugins for bash/zsh/fish.
+- <https://wakatime.com/terminal> lists wakatime plugins for many shells.
 
 See more in [document](https://python-wakatime.readthedocs.io).

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 # https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
 [project]
 name = "python-wakatime"
-description = "wakatime plugin for python"
+description = "wakatime plugin for python REPLs"
 authors = [{ name = "Wu Zhenyu", email = "wuzhenyu@ustc.edu" }]
 readme = "README.md"
 requires-python = ">= 3.9"

requirements/dev.txt

@@ -2,3 +2,4 @@
 # For unit test and code coverage rate test.
 
 pre-commit
+ptpython[ptipython]

requirements/ipython.txt

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S pip install -r
+
+ipython

requirements/ptipython.txt

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S pip install -r
+
+ptpython[ptipython]

requirements/ptpython.txt

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S pip install -r
+
+ptpython

src/python_wakatime/__init__.py

@@ -4,10 +4,9 @@
 `create-plugin <https://wakatime.com/help/creating-plugin>`_
 """
 import os
-import sys
 from subprocess import run  # nosec: B404
 from threading import Thread
-from typing import Callable
+from typing import Any
 
 from ._version import __version__, __version_tuple__  # type: ignore
 
@@ -33,68 +32,13 @@ def send_wakatime_heartbeat(project: str = "Terminal") -> None:
     )
 
 
-def wakatime_hook(args: tuple = ()) -> None:
+def wakatime_hook(args: tuple = (), kwargs: dict[str, Any] = {}) -> None:
     """Wakatime hook.
 
     :param args:
     :type args: tuple
     :rtype: None
     """
-    task = Thread(target=send_wakatime_heartbeat, args=args)
+    task = Thread(target=send_wakatime_heartbeat, args=args, kwargs=kwargs)
     task.daemon = True
     task.start()
-
-
-class Ps1:
-    """Ps1."""
-
-    def __init__(
-        self,
-        ps1: object = None,
-        hook: Callable = wakatime_hook,
-        args: tuple = (),
-    ) -> None:
-        """Init.
-
-        :param ps1:
-        :type ps1: object
-        :param hook:
-        :type hook: Callable
-        :param args:
-        :type args: tuple
-        :rtype: None
-        """
-        if ps1:
-            self.ps1 = ps1
-        else:
-            if hasattr(sys, "ps1"):
-                self.ps1 = sys.ps1
-            else:
-                self.ps1 = ">>> "
-        self.args = args
-        self.hook = hook
-
-    def __str__(self) -> str:
-        """Str.
-
-        :rtype: str
-        """
-        self.hook(*self.args)
-        if isinstance(self.ps1, str):
-            return self.ps1
-        else:
-            return str(self.ps1)
-
-
-def install_hook(hook: Callable = wakatime_hook, args: tuple = ()) -> None:
-    """Install hook. Only install once.
-
-    :param hook:
-    :type hook: Callable
-    :param args:
-    :type args: tuple
-    :rtype: None
-    """
-    if hasattr(sys, "ps1") and isinstance(sys.ps1, Ps1):
-        return
-    sys.ps1 = Ps1(hook=hook, args=args)

src/python_wakatime/ipython.py

@@ -0,0 +1,96 @@
+"""ipython
+==========
+"""
+from typing import Any, Callable
+
+from IPython.terminal.interactiveshell import TerminalInteractiveShell
+from IPython.terminal.prompts import ClassicPrompts, Prompts
+from pygments.token import _TokenType
+from traitlets.config.loader import Config, LazyConfigValue
+
+from . import wakatime_hook
+
+
+def get_new_prompts_class(
+    prompts_class: type,
+    hook: Callable = wakatime_hook,
+    args: tuple = (),
+    kwargs: dict[str, Any] = {},
+) -> type:
+    """Get new prompts class.
+
+    :param prompts_class:
+    :type prompts_class: type
+    :param hook:
+    :type hook: Callable
+    :param args:
+    :type args: tuple
+    :param kwargs:
+    :type kwargs: dict[str, Any]
+    :rtype: type
+    """
+    if isinstance(prompts_class, LazyConfigValue):
+        prompts_class = ClassicPrompts
+    shell = TerminalInteractiveShell()
+
+    class Ps(Prompts):
+        """Ps."""
+
+        def in_prompt_tokens(self) -> list[tuple[_TokenType, str]]:
+            """In prompt tokens.
+
+            :rtype: list[tuple[_TokenType, str]]
+            """
+            return prompts_class(shell).in_prompt_tokens()
+
+        def continuation_prompt_tokens(
+            self, width: int | None = None
+        ) -> list[tuple[_TokenType, str]]:
+            """Continuation prompt tokens.
+
+            :param width:
+            :type width: int | None
+            :rtype: list[tuple[_TokenType, str]]
+            """
+            return prompts_class(shell).continuation_prompt_tokens(width)
+
+        def rewrite_prompt_tokens(self) -> list[tuple[_TokenType, str]]:
+            """Rewrite prompt tokens.
+
+            :rtype: list[tuple[_TokenType, str]]
+            """
+            return prompts_class(shell).rewrite_prompt_tokens()
+
+        def out_prompt_tokens(self) -> list[tuple[_TokenType, str]]:
+            """Out prompt tokens.
+
+            :rtype: list[tuple[_TokenType, str]]
+            """
+            hook(*args, **kwargs)
+            return prompts_class(shell).out_prompt_tokens()
+
+    return Ps
+
+
+def install_hook(
+    c: Config,
+    hook: Callable = wakatime_hook,
+    args: tuple = (),
+    kwargs: dict[str, Any] = {},
+) -> Config:
+    """Install hook.
+
+    :param c:
+    :type c: Config
+    :param hook:
+    :type hook: Callable
+    :param args:
+    :type args: tuple
+    :param kwargs:
+    :type kwargs: dict[str, Any]
+    :rtype: Config
+    """
+    c.TerminalInteractiveShell.prompts_class = get_new_prompts_class(  # type: ignore
+        c.TerminalInteractiveShell.prompts_class, hook, args, kwargs  # type: ignore
+    )
+    return c