LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
    • Overview
    • Graphs
    • Functional API
    • Pregel
    • Checkpointing
    • Storage
    • Caching
    • Types
    • Runtime
    • Config
    • Errors
    • Constants
    • Channels
    • Agents
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    ⌘I

    LangChain Assistant

    Ask a question to get started

    Enter to send•Shift+Enter new line

    Menu

    OverviewGraphsFunctional APIPregelCheckpointingStorageCachingTypesRuntimeConfigErrorsConstantsChannelsAgents
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    Pythonlanggraphpregeldebug
    Module●Since v0.1

    debug

    Attributes

    attribute
    CONF
    attribute
    CONFIG_KEY_CHECKPOINT_NS
    attribute
    ERROR
    attribute
    INTERRUPT
    attribute
    NS_END
    attribute
    NS_SEP
    attribute
    RETURN
    attribute
    MISSING

    Unset sentinel value.

    attribute
    TAG_HIDDEN

    Tag to hide a node/edge from certain tracing/streaming environments.

    attribute
    TASK_NAMESPACE
    attribute
    COLOR_MAPPING: dict

    Functions

    function
    patch_checkpoint_map
    function
    read_channels
    function
    map_debug_tasks

    Produce "task" events for stream_mode=debug.

    function
    is_multiple_channel_write

    Return True if the payload already wraps multiple writes from the same channel.

    function
    map_task_result_writes

    Folds task writes into a result dict and aggregates multiple writes to the same channel.

    If the channel contains a single write, we record the write in the result dict as {channel: write} If the channel contains multiple writes, we record the writes in the result dict as {channel: {'$writes': [write1, write2, ...]}}

    function
    map_debug_task_results

    Produce "task_result" events for stream_mode=debug.

    function
    rm_pregel_keys

    Remove pregel-specific keys from the config.

    function
    map_debug_checkpoint

    Produce "checkpoint" events for stream_mode=debug.

    function
    tasks_w_writes

    Apply writes / subgraph states to tasks to be returned in a StateSnapshot.

    function
    get_colored_text

    Get colored text.

    function
    get_bolded_text

    Get bolded text.

    Classes

    class
    BaseChannel

    Base class for all channels.

    class
    CheckpointPayload

    Payload for a checkpoint event.

    class
    PregelExecutableTask
    class
    PregelTask

    A Pregel task.

    class
    StateSnapshot

    Snapshot of the state of the graph at the beginning of a step.

    class
    TaskPayload

    Payload for a task start event.

    class
    TaskResultPayload

    Payload for a task result event.

    View source on GitHub