Skip to content

Pdb support - local variables #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

Josverl
Copy link

@Josverl Josverl commented Jun 17, 2025

local variable access

This document describes the enhanced debugging functionality added to MicroPython through two key commits that implement comprehensive local variable introspection for the sys.settrace() functionality.

Overview

The enhancements enable debuggers and profiling tools to access local variable names and values in function frames, which is essential for interactive debugging, breakpoint inspection, and runtime analysis. The implementation includes both basic local variable access and advanced variable name preservation with correct slot mapping.

Key Features Added

1. Basic Frame Local Variables Access (frame.f_locals)

The initial implementation provides access to local variables in stack frames through the frame.f_locals property. This foundational feature enables debuggers to inspect variable values at runtime.

Key Components:

  • frame_f_locals() function - Core implementation in py/profile.c
  • Memory-safe access - Includes GC lock checking and state validation
  • Generic fallback names - Uses local_01, local_02, etc. when variable names unavailable
  • Robust error handling - Graceful handling of invalid state or memory allocation failures

Implementation Features:

  • Pre-allocates dictionary size based on frame state count for efficiency
  • Validates code state and state array before access
  • Skips NULL values in the state array
  • Safe qstr creation with error checking

2. Advanced Variable Name Storage (MICROPY_PY_SYS_SETTRACE_SAVE_NAMES)

An enhanced compile-time feature that preserves actual local variable names in compiled bytecode for professional debugging capabilities.

pi-anl and others added 12 commits June 11, 2025 22:09
Only if MICROPY_PY_SYS_SETTRACE is enabled.
This is used to provide introspection of attributes
such as function name or source file & line.

Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
Refer to https://docs.python.org/3/library/sys.html#sys._getframe
Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
Refer to https://docs.python.org/3/library/sys.html#sys.gettrace
Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
Updates micropython-lib submodule to include the new debugpy implementation
that enables VS Code debugging support for MicroPython applications.

The debugpy port provides:
- Debug Adapter Protocol (DAP) compatibility with VS Code
- Line breakpoints, stepping, and variable inspection
- Integration with MicroPython's sys.settrace functionality
- Network-based debugging via TCP socket connection

This enables developers to debug MicroPython code using the familiar
VS Code debugging interface, improving the development experience.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
@Josverl Josverl marked this pull request as ready for review June 17, 2025 13:12
Josverl added 6 commits June 17, 2025 16:58
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants