✨ Support detecting project

Add some unit tests
Fix the bug on args/kwargs
Change the plugin names, see wakatime/wakatime-cli#805

Author: Freed-Wu

README.md

@@ -85,7 +85,8 @@ install_hook(c)
 - [ ] [mypython](https://github.com/asmeurer/mypython): Won't fix.
   - configure file: non-exist.
 
-`install_hook()` must after customization of prompt string, best at the end of file.
+`install_hook()` must be after customization of prompt string, best at the end
+of file.
 
 ## Similar projects
 

pyproject.toml

@@ -22,9 +22,13 @@ classifiers = [
   "Operating System :: MacOS",
   "Programming Language :: Python :: 3 :: Only",
   "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dynamic = ["version", "optional-dependencies"]
 

src/python_wakatime/__init__.py

@@ -1,28 +1,52 @@
 """Wakatime
 ===========
 
-`create-plugin <https://wakatime.com/help/creating-plugin>`_
+Refer `create-plugin <https://wakatime.com/help/creating-plugin>`_.
 """
+import logging
 import os
+from shutil import which
 from subprocess import run  # nosec: B404
 from threading import Thread
-from typing import Any
+from typing import Any, Callable
 
 from ._version import __version__, __version_tuple__  # type: ignore
 
+logger = logging.getLogger(__name__)
 
-def send_wakatime_heartbeat(project: str = "Terminal") -> None:
+
+def send_wakatime_heartbeat(
+    project: str = "",
+    plugin: str = "repl-python-wakatime",
+    filenames: list[str] = [".git"],
+    detect_func: Callable[[str], bool] = os.path.isdir,
+) -> None:
     """Send wakatime heartbeat.
 
+    If ``project == ""``, detect automatically.
+
+    ``plugin`` must be the format of ``repl-REPL_NAME-wakatime`` to let
+    wakatime detect correctly.
+
     :param project:
     :type project: str
+    :param plugin:
+    :type plugin: str
+    :param filenames:
+    :type filenames: list[str]
+    :param detect_func:
+    :type detect_func: Callable[[str], bool]
     :rtype: None
     """
+    if project == "":
+        from .utils import get_project
+
+        project = get_project(filenames, detect_func)
     run(  # nosec: B603 B607
         [
             "wakatime-cli",
             "--write",
-            "--plugin=python-wakatime",
+            f"--plugin={plugin}",
             "--entity-type=app",
             "--entity=python",
             "--alternate-language=python",
@@ -39,6 +63,9 @@ def wakatime_hook(args: tuple = (), kwargs: dict[str, Any] = {}) -> None:
     :type args: tuple
     :rtype: None
     """
+    if which("wakatime-cli") is None:
+        logger.error("Please install wakatime-cli firstly!")
+        return
     task = Thread(target=send_wakatime_heartbeat, args=args, kwargs=kwargs)
     task.daemon = True
     task.start()

src/python_wakatime/ipython.py

@@ -66,7 +66,7 @@ def out_prompt_tokens(self) -> list[tuple[_TokenType, str]]:
 
             :rtype: list[tuple[_TokenType, str]]
             """
-            hook(*args, **kwargs)
+            hook(args, kwargs)
             return prompts_class(shell).out_prompt_tokens()
 
     return Ps
@@ -76,7 +76,7 @@ def install_hook(
     c: Config,
     hook: Callable = wakatime_hook,
     args: tuple = (),
-    kwargs: dict[str, Any] = {},
+    kwargs: dict[str, Any] = {"plugin": "repl-ipython-wakatime"},
 ) -> Config:
     """Install hook.
 

src/python_wakatime/ptpython.py

@@ -60,15 +60,15 @@ def out_prompt(self) -> AnyFormattedText:
 
         :rtype: AnyFormattedText
         """
-        self.hook(*self.args, **self.kwargs)
+        self.hook(self.args, self.kwargs)
         return self.prompt_style.out_prompt()
 
 
 def install_hook(
     repl: PythonRepl,
     hook: Callable = wakatime_hook,
     args: tuple = (),
-    kwargs: dict[str, Any] = {},
+    kwargs: dict[str, Any] = {"plugin": "repl-ptpython-wakatime"},
     hook_prefix: str = "ps1_",
 ) -> PythonRepl:
     """Install hook.

src/python_wakatime/python.py

@@ -45,7 +45,7 @@ def __str__(self) -> str:
 
         :rtype: str
         """
-        self.hook(*self.args, **self.kwargs)
+        self.hook(self.args, self.kwargs)
         if isinstance(self.ps1, str):
             return self.ps1
         else:
@@ -55,7 +55,7 @@ def __str__(self) -> str:
 def install_hook(
     hook: Callable = wakatime_hook,
     args: tuple = (),
-    kwargs: dict[str, Any] = {},
+    kwargs: dict[str, Any] = {"plugin": "repl-python-wakatime"},
 ) -> object:
     """Install hook.
 

src/python_wakatime/utils.py

@@ -0,0 +1,36 @@
+"""Utils
+========
+"""
+import os
+from typing import Callable
+
+
+def get_project(
+    filenames: list[str] = [".git"],
+    detect_func: Callable[[str], bool] = os.path.isdir,
+) -> str:
+    """Get project.
+
+    If ``.git`` is a directory, use current directory. If not, detect its
+    parent directory. If its parent directory is itself (which means it is the
+    root directory) and ``.git`` is still not a directory, stop detection. Just
+    use current directory as ``project``.
+
+    :param filenames:
+    :type filenames: list[str]
+    :param detect_func:
+    :type detect_func: Callable[[str], bool]
+    """
+    cwd = os.getcwd()
+    project = cwd
+    oldproject = ""
+    while not any(
+        detect_func(os.path.join(project, filename)) for filename in filenames
+    ):
+        if oldproject == project:
+            project = cwd
+            break
+        oldproject = project
+        project = os.path.dirname(project)
+    project = os.path.basename(project)
+    return project

tests/__init___test.py

@@ -0,0 +1,40 @@
+"""Test
+=======
+"""
+import os
+from pathlib import Path
+
+from python_wakatime.utils import get_project
+
+
+class Test:
+    """Test."""
+
+    def test_get_project_no_cwd(self, tmp_path: Path) -> None:
+        """Test get project no cwd.
+
+        :param tmp_path:
+        :type tmp_path: Path
+        :rtype: None
+        """
+        os.chdir(tmp_path)
+        os.makedirs(".svn")
+        os.makedirs("subdir")
+        os.chdir("subdir")
+        rst = get_project([".git", ".svn"])
+        expected = os.path.basename(tmp_path)
+        assert rst == expected
+
+    def test_get_project_cwd(self, tmp_path: Path) -> None:
+        """Test get project cwd.
+
+        :param tmp_path:
+        :type tmp_path: Path
+        :rtype: None
+        """
+        os.chdir(tmp_path)
+        os.makedirs("subdir")
+        os.chdir("subdir")
+        rst = get_project([".git", ".svn"])
+        expected = "subdir"
+        assert rst == expected