mirror of
https://github.com/langchain-ai/langgraph.git
synced 2026-09-06 09:47:51 +02:00
94 lines
3.0 KiB
Python
94 lines
3.0 KiB
Python
from abc import ABC, abstractmethod
|
|
from contextlib import asynccontextmanager, contextmanager
|
|
from typing import (
|
|
Any,
|
|
AsyncGenerator,
|
|
Generator,
|
|
Generic,
|
|
Optional,
|
|
Sequence,
|
|
TypeVar,
|
|
)
|
|
|
|
from langchain_core.runnables import RunnableConfig
|
|
from typing_extensions import Self
|
|
|
|
from langgraph.errors import EmptyChannelError, InvalidUpdateError
|
|
|
|
Value = TypeVar("Value")
|
|
Update = TypeVar("Update")
|
|
C = TypeVar("C")
|
|
|
|
|
|
class BaseChannel(Generic[Value, Update, C], ABC):
|
|
@property
|
|
@abstractmethod
|
|
def ValueType(self) -> Any:
|
|
"""The type of the value stored in the channel."""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def UpdateType(self) -> Any:
|
|
"""The type of the update received by the channel."""
|
|
|
|
# serialize/deserialize methods
|
|
|
|
def tap(self) -> Optional[C]:
|
|
"""Return the current checkpoint of the channel, without consuming it.
|
|
By default, it just calls checkpoint()."""
|
|
return self.checkpoint()
|
|
|
|
@abstractmethod
|
|
def checkpoint(self) -> Optional[C]:
|
|
"""Return a serializable representation of the channel's current state.
|
|
Raises EmptyChannelError if the channel is empty (never updated yet),
|
|
or doesn't support checkpoints."""
|
|
|
|
@contextmanager
|
|
@abstractmethod
|
|
def from_checkpoint(
|
|
self, checkpoint: Optional[C], config: RunnableConfig
|
|
) -> Generator[Self, None, None]:
|
|
"""Return a new identical channel, optionally initialized from a checkpoint.
|
|
If the checkpoint contains complex data structures, they should be copied."""
|
|
|
|
@asynccontextmanager
|
|
async def afrom_checkpoint(
|
|
self, checkpoint: Optional[C], config: RunnableConfig
|
|
) -> AsyncGenerator[Self, None]:
|
|
"""Return a new identical channel, optionally initialized from a checkpoint.
|
|
If the checkpoint contains complex data structures, they should be copied."""
|
|
with self.from_checkpoint(checkpoint, config) as value:
|
|
yield value
|
|
|
|
# state methods
|
|
|
|
@abstractmethod
|
|
def update(self, values: Sequence[Update]) -> bool:
|
|
"""Update the channel's value with the given sequence of updates.
|
|
The order of the updates in the sequence is arbitrary.
|
|
This method is called by Pregel for all channels at the end of each step.
|
|
If there are no updates, it is called with an empty sequence.
|
|
Raises InvalidUpdateError if the sequence of updates is invalid.
|
|
Returns True if the channel was updated, False otherwise."""
|
|
|
|
@abstractmethod
|
|
def get(self) -> Value:
|
|
"""Return the current value of the channel.
|
|
|
|
Raises EmptyChannelError if the channel is empty (never updated yet)."""
|
|
|
|
def consume(self) -> bool:
|
|
"""Mark the current value of the channel as consumed. By default, no-op.
|
|
This is called by Pregel before the start of the next step, for all
|
|
channels that triggered a node. If the channel was updated, return True.
|
|
"""
|
|
return False
|
|
|
|
|
|
__all__ = [
|
|
"BaseChannel",
|
|
"EmptyChannelError",
|
|
"InvalidUpdateError",
|
|
]
|