package starlark_debugging

Get desktop application:
View/edit binary Protocol Buffers messages

A location where the debug server will pause execution.

Used in: SetBreakpointsRequest

• oneof condition

  • Location location = 1

    A breakpoint that is triggered when a particular line is reached. Column index will be ignored for breakpoints. The debugger only supports one breakpoint per line. If multiple breakpoints are supplied for a single line, only the last such breakpoint is accepted.

• string expression = 2

  An optional condition for the breakpoint. When present, the breakpoint will be triggered iff both the primary condition holds and this expression evaluates to True. It is unspecified how many times this expression will be evaluated, so it should be free of side-effects.

A request to continue execution on a paused or stepping thread. (A stepping thread is a thread that is running as the result of a previous ContinueExecutionRequest with non-NONE stepping.) A paused thread will be resumed with the given stepping, unless thread_id is 0. A stepping thread will continue to run with its stepping condition removed, as if it were already paused.

The identifier of the thread to continue. The thread must be paused or stepping. If this field is not set (i.e., zero), then all threads will be continued without stepping; the stepping field in this message will be ignored. This is typically used when the debugger disconnects from the server.

Used in: DebugRequest

• int64 thread_id = 1

• Stepping stepping = 2

  Describes the stepping behavior to use when continuing execution.

The response to a ContinueExecutionRequest.

Used in: DebugEvent

(message has no fields)

There are two kinds of events: "responses", which correspond to a DebugRequest sent by the client, and other asynchronous events that may be sent by the server to notify the client of activity in the Starlark code being debugged.

• int64 sequence_number = 1

  If non-zero, this event is a response to a DebugRequest with the same sequence number.

• oneof payload

  The payload describes the type of event and any additional information about the event.

  • Error error = 99

  • SetBreakpointsResponse set_breakpoints = 101

  • ContinueExecutionResponse continue_execution = 102

  • EvaluateResponse evaluate = 103

  • ListFramesResponse list_frames = 104

  • StartDebuggingResponse start_debugging = 105

  • PauseThreadResponse pause_thread = 106

  • GetChildrenResponse get_children = 107

  • ThreadPausedEvent thread_paused = 1001

  • ThreadContinuedEvent thread_continued = 1002

A request sent by the debug client to the debug server.

• int64 sequence_number = 1

  A number (intended to be sequentially generated by the client) that identifies the request. The response sent by the server will contain the same sequence number so that the client can synchronize its activity if desired.

• oneof payload

  The payload describes the type of the request and its arguments, if any.

  • SetBreakpointsRequest set_breakpoints = 101

  • ContinueExecutionRequest continue_execution = 102

  • EvaluateRequest evaluate = 103

  • ListFramesRequest list_frames = 104

  • StartDebuggingRequest start_debugging = 105

  • PauseThreadRequest pause_thread = 106

  • GetChildrenRequest get_children = 107

A response that indicates that an error occurred while handling a debugging request.

Used in: DebugEvent, PausedThread

• string message = 1

  A message describing the error that occurred.

A request to evaluate a Starlark statement in a thread's current environment.

Used in: DebugRequest

• int64 thread_id = 1

  The identifier of the thread in whose execution context the expression should be evaluated.

• string statement = 2

  The Starlark statement to evaluate.

The response to an EvaluateRequest.

Used in: DebugEvent

• optional Value result = 1

  The result of evaluating a statement.

A single frame in a thread's stack trace.

Used in: ListFramesResponse

• string function_name = 1

  The name of the function that this frame represents.

• repeated Scope scope = 2

  The scopes that contain value bindings accessible in this frame.

• optional Location location = 3

  The source location where the frame is currently paused. May not be set in some situations.

A request to list the children of a previously-communicated Value, such as its elements (for a list or dictionary), its fields (for a struct), and so forth.

Used in: DebugRequest

• int64 thread_id = 1

  The identifier of the relevant thread.

• int64 value_id = 2

  The identifier of the value for which children are being requested. If the value has no children, an empty list will be returned in GetChildrenResponse.

The response to a GetChildrenRequest.

Used in: DebugEvent

• repeated Value children = 1

A request to list the stack frames of a thread.

Used in: DebugRequest

• int64 thread_id = 1

  The identifier of the thread whose stack frames should be listed.

The response to a ListFramesRequest.

Used in: DebugEvent

• repeated Frame frame = 1

  The list of stack frames. The first element in the list represents the topmost frame (that is, the current innermost function).

A location in Starlark source code.

Used in: Breakpoint, Frame, PausedThread

• string path = 1

  The path of the Starlark source file.

• uint32 line_number = 2

  A 1-indexed line number in the file denoted by path.

• uint32 column_number = 3

  A 1-indexed column number in the file denoted by path. 0 (/unset) indicates column number is unknown or irrelevant.

The reason why a thread was paused.

Used in: PausedThread

• UNSET = 0

  The debug server hasn't set any reason.

• STEPPING = 1

  The stepping condition in a ContinueExecutionRequest was hit.

• ALL_THREADS_PAUSED = 2

  A PauseThreadRequest was sent with thread_id=0.

• PAUSE_THREAD_REQUEST = 3

  A PauseThreadRequest was sent with thread_id matching this thread.

• HIT_BREAKPOINT = 4

  A breakpoint was hit.

• CONDITIONAL_BREAKPOINT_ERROR = 5

  An error occurred while evaluating a breakpoint condition.

• INITIALIZING = 6

  Debugging just started, and a StartDebuggingRequest has not yet been received and processed.

A request to pause execution of a thread, or all threads.

Used in: DebugRequest

• int64 thread_id = 1

  The identifier of the thread to be paused. If not set (i.e. zero), all current Starlark threads will be paused, and until a ContinueExecutionRequest is sent, any future Starlark threads will also start off paused.

The response to a PauseThreadRequest. This is an acknowledgement that the request was received. Actual pausing of individual threads happens asynchronously, and will be communicated via ThreadPausedEvent(s).

Used in: DebugEvent

(message has no fields)

Information about a paused Starlark thread.

Used in: ThreadPausedEvent

• int64 id = 1

  The identifier of the thread.

• string name = 2

  A descriptive name for the thread that can be displayed in the debugger's UI.

• PauseReason pause_reason = 3

• optional Location location = 4

  The location in Starlark code of the next statement or expression that will be executed.

• optional Error conditional_breakpoint_error = 5

  An error that occurred while evaluating a breakpoint condition. Present if and only if pause_reason is CONDITIONAL_BREAKPOINT_ERROR.

A scope that contains value bindings accessible in a frame.

Used in: Frame

• string name = 1

  A human-readable name of the scope, such as "global" or "local".

• repeated Value binding = 2

  The variable bindings that are defined in this scope.

A request to update the breakpoints used by the debug server.

Used in: DebugRequest

• repeated Breakpoint breakpoint = 1

  The breakpoints that describe where the debug server should pause evaluation.

The response to a SetBreakpointsRequest.

Used in: DebugEvent

(message has no fields)

A request to begin the debugging session. Starlark execution will block until this request is made, to allow initial setup after the connection is established (e.g. setting breakpoints).

Used in: DebugRequest

(message has no fields)

The response to a StartDebuggingRequest.

Used in: DebugEvent

(message has no fields)

Describes the stepping behavior that should occur when execution of a thread is continued.

Used in: ContinueExecutionRequest

• NONE = 0

  Do not step; continue execution until it completes or is paused for some other reason (such as hitting another breakpoint).

• INTO = 1

  If the thread is paused on a statement that contains a function call, step into that function. Otherwise, this is the same as OVER.

• OVER = 2

  Step over the next statement and any functions that it may call.

• OUT = 3

  Continue execution until the current function has been exited and then pause.

An event indicating that a thread has continued execution after being paused.

Used in: DebugEvent

• int64 thread_id = 1

  The identifier of the thread that continued executing.

An event indicating that a thread was paused during execution.

Used in: DebugEvent

• optional PausedThread thread = 1

  The thread that was paused.

The debugger representation of a Starlark value.

Used in: EvaluateResponse, GetChildrenResponse, Scope

• string label = 1

  A label that describes this value's location or source in a value hierarchy. For example, in a stack frame, the label would be the name of the variable to which the value is bound. For a value that is an element of a list, its its label would be its subscript, such as "[4]". A value that is a field in a struct would use the field's name as its label, and so forth.

• string description = 2

  A string description of the value.

• string type = 3

  A string describing the type of the value. This field may be omitted if the value does not correspond to a "real" type as far as the debugging view is concerned; for example, dictionaries will be rendered as sequences of key/value pairs ("entries") but the entries themselves do not have a meaningful type with respect to our rendering.

• bool has_children = 4

  Will be false if the value is known to have no children. May sometimes be true if this isn't yet known, in which case GetChildrenResponse#children will be empty.

• int64 id = 5

  An identifier for this value, used to request its children. The same value may be known by multiple ids. Not set for values without children.