fix(typos): deprecate Interruptable in favor of Interruptible

python/promplate/chain/callback.py

@@ -3,7 +3,7 @@
 from ..prompt import Context
 
 if TYPE_CHECKING:
-    from .node import AsyncProcess, ChainContext, Interruptable, Process
+    from .node import AsyncProcess, ChainContext, Interruptible, Process
 
 
 class BaseCallback(Protocol):
@@ -13,10 +13,10 @@ def mid_process(self, context: "ChainContext") -> Context | Awaitable[Context |
 
     def end_process(self, context: "ChainContext") -> Context | Awaitable[Context | None] | None: ...
 
-    def on_enter(self, node: "Interruptable", context: Context | None, config: Context) -> tuple[Context | None, Context]:
+    def on_enter(self, node: "Interruptible", context: Context | None, config: Context) -> tuple[Context | None, Context]:
         return context, config
 
-    def on_leave(self, node: "Interruptable", context: "ChainContext", config: Context) -> tuple["ChainContext", Context]:
+    def on_leave(self, node: "Interruptible", context: "ChainContext", config: Context) -> tuple["ChainContext", Context]:
         return context, config
 
 
@@ -27,8 +27,8 @@ def __init__(
         pre_process: "Process | AsyncProcess | None" = None,
         mid_process: "Process | AsyncProcess | None" = None,
         end_process: "Process | AsyncProcess | None" = None,
-        on_enter: Callable[["Interruptable", Context | None, Context], tuple[Context | None, Context]] | None = None,
-        on_leave: Callable[["Interruptable", "ChainContext", Context], tuple["ChainContext", Context]] | None = None,
+        on_enter: Callable[["Interruptible", Context | None, Context], tuple[Context | None, Context]] | None = None,
+        on_leave: Callable[["Interruptible", "ChainContext", Context], tuple["ChainContext", Context]] | None = None,
     ):
         self._pre_process = pre_process
         self._mid_process = mid_process

python/promplate/chain/node.py

@@ -1,6 +1,6 @@
 from inspect import isclass
 from itertools import accumulate
-from typing import Callable, Mapping, MutableMapping, TypeVar, overload
+from typing import TYPE_CHECKING, Callable, Mapping, MutableMapping, TypeVar, overload
 
 from ..llm.base import *
 from ..prompt.template import Context, Loader, SafeChainMapContext, Template
@@ -105,7 +105,7 @@ def ensure_callbacks(callbacks: list[BaseCallback | type[BaseCallback]]) -> list
     return [i() if isclass(i) else i for i in callbacks]
 
 
-class Interruptable(AbstractNode, Protocol):
+class Interruptible(AbstractNode, Protocol):
     def _invoke(
         self,
         context: ChainContext,
@@ -301,7 +301,17 @@ def context(self):
         self._context = None
 
 
-class Node(Loader, Interruptable):
+if TYPE_CHECKING:
+    from typing_extensions import deprecated  # type: ignore
+
+    @deprecated("Use `Interruptible` instead")
+    class Interruptable(Interruptible, Protocol): ...
+
+else:
+    Interruptable = Interruptible
+
+
+class Node(Loader, Interruptible):
     def __init__(
         self,
         template: Template | str,
@@ -383,7 +393,7 @@ def __str__(self):
         return f"</{self.name}/>"
 
 
-class Loop(Interruptable):
+class Loop(Interruptible):
     def __init__(self, chain: AbstractNode, partial_context: Context | None = None):
         self.chain = chain
         self._context = partial_context
@@ -420,7 +430,7 @@ async def _astream(self, context, /, generate, callbacks, **config):
             await self._apply_async_end_processes(context, callbacks)
 
 
-class Chain(Interruptable):
+class Chain(Interruptible):
     def __init__(self, *nodes: AbstractNode, partial_context: Context | None = None):
         self.nodes = list(nodes)
         self._context = partial_context
@@ -472,7 +482,7 @@ def __repr__(self):
 
 
 class Jump(Exception):
-    def __init__(self, into: Interruptable | None = None, out_of: Interruptable | None = None):
+    def __init__(self, into: Interruptible | None = None, out_of: Interruptible | None = None):
         self.into = into
         self.out_of = out_of
 

python/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "promplate"
-version = "0.3.5.0"
+version = "0.3.5.1"
 description = "Prompt engineering framework for humans"
 homepage = "https://promplate.dev/"
 documentation = "https://docs.py.promplate.dev/"