diff mercurial/interfaces/misc.py @ 52905:483b0bb23085

typing: use a protocol to annotate `hooks` in repository.py That is one external import for the repository interface module. Two more to go. This introduces a new "misc" module in the `interfaces` "package" to host small things that does warrant their own module yet.
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Sat, 08 Feb 2025 18:12:29 +0100
parents
children bde94bd8e8a2
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mercurial/interfaces/misc.py	Sat Feb 08 18:12:29 2025 +0100
@@ -0,0 +1,26 @@
+# misc.py - Various Interface that did not deserve a dedicated module (yet)
+#
+# Copyright 2025 Octobus, contact@octobus.net
+from __future__ import annotations
+
+import abc
+
+from typing import (
+    Callable,
+    List,
+    Protocol,
+)
+
+
+class IHooks(Protocol):
+    """A collection of hook functions that can be used to extend a
+    function's behavior. Hooks are called in lexicographic order,
+    based on the names of their sources."""
+
+    @abc.abstractmethod
+    def add(self, source: bytes, hook: Callable):
+        ...
+
+    @abc.abstractmethod
+    def __call__(self, *args) -> List:
+        ...