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 Checkpoint
    LangGraph Store
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    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 Checkpoint
    LangGraph Store
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    Pythonlanggraphpregeldebug
    Module●Since v0.1

    debug

    Attributes

    Functions

    Classes

    View source on GitHub
    attribute
    CONF
    attribute
    CONFIG_KEY_CHECKPOINT_NS
    attribute
    ERROR
    attribute
    INTERRUPT
    attribute
    NS_END
    attribute
    NS_SEP
    attribute
    RETURN
    attribute
    MISSING
    attribute
    TAG_HIDDEN
    attribute
    TASK_NAMESPACE
    attribute
    COLOR_MAPPING: dict
    function
    filter_to_user_tags
    function
    patch_checkpoint_map
    function
    read_channels
    function
    map_debug_tasks
    function
    is_multiple_channel_write
    function
    map_task_result_writes
    function
    map_debug_task_results
    function
    rm_pregel_keys
    function
    map_debug_checkpoint
    function
    tasks_w_writes
    function
    get_colored_text
    function
    get_bolded_text
    class
    BaseChannel
    class
    CheckpointPayload
    class
    PregelExecutableTask
    class
    PregelTask
    class
    StateSnapshot
    class
    TaskPayload
    class
    TaskResultPayload

    Unset sentinel value.

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

    Drop langgraph's internal seq:step:* bookkeeping tags.

    seq:step:N tags are added internally to mark sequence steps; everything else (user-supplied tags and any other framework tags) is kept. Returns the surviving tags, or None if none remain. Shared by the messages and tasks stream handlers so both surface the same tag set on their metadata.

    Produce "task" events for stream_mode=debug.

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

    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, ...]}}

    Produce "task_result" events for stream_mode=debug.

    Remove pregel-specific keys from the config.

    Produce "checkpoint" events for stream_mode=debug.

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

    Get colored text.

    Get bolded text.

    Base class for all channels.

    Payload for a checkpoint event.

    A Pregel task.

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

    Payload for a task start event.

    Payload for a task result event.