Improve sys.settrace to help support debugpy / pdb debugging by andrewleech · Pull Request #8767 · micropython/micropython ·

Companion support for micropython/micropython-lib#1022 & micropython/micropython-lib#499

Requires micropython be built with MICROPY_PY_SYS_SETTRACE eg. unix standard variant

Includes:

sys/settrace: Add sys._getframe() function.
Refer to https://docs.python.org/3/library/sys.html#sys._getframe
sys/settrace: Add frame.f_trace object support.
f_trace holds a python obj on the frame, used in bdb to track active trace function for call stack.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.80%. Comparing base (5f058e9) to head (a7ae522).
Report is 24 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8767      +/-   ##
==========================================
- Coverage   98.54%   97.80%   -0.74%     
==========================================
  Files         169      169              
  Lines       21943    21924      -19     
==========================================
- Hits        21623    21443     -180     
- Misses        320      481     +161

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Requires micropython/micropython#8767

Requires micropython to be compiled with MICROPY_PY_SYS_SETTRACE. Also requires micropython/micropython#8767

dpgeorge · 2022-06-27T02:24:27Z

py/modsys.c

+MP_DEFINE_CONST_FUN_OBJ_0(mp_sys_gettrace_obj, mp_sys_gettrace);
+
+// _getframe(): Return current frame object.
+STATIC mp_obj_t mp_sys_getframe(size_t n_args, const mp_obj_t *args) {


please call it mp_sys__getframe

dpgeorge · 2022-06-27T02:26:22Z

py/objfun.c

+if (attr == MP_QSTR___code__) {
+mp_obj_fun_bc_t *self = MP_OBJ_TO_PTR(self_in);
+mp_obj_code_t *code = MP_OBJ_TO_PTR(mp_obj_new_code(self->context, self->rc));
+if (code != NULL) {


can code be null?

dpgeorge · 2022-06-27T02:32:04Z

py/profile.c

 switch (attr) {
 case MP_QSTR_f_back:
 dest[0] = mp_const_none;
 if (o->code_state->prev_state) {
+if (!o->code_state->prev_state->frame) {


did you find a case where this could be NULL? maybe it needs a test...

dpgeorge · 2022-06-27T02:33:24Z

py/profile.c

+dest[0] = o->trace_obj;
+break;
+case MP_QSTR_f_locals:
+dest[0] = MP_OBJ_FROM_PTR(o->code->dict_locals);


is this needed? locals in uPy doesn't work well

can we just return an empty dict instead?

dpgeorge · 2022-06-27T02:33:58Z

py/profile.c

@@ -274,6 +292,7 @@ mp_obj_t mp_obj_new_frame(const mp_code_state_t *code_state) {
 o->lineno = mp_prof_bytecode_lineno(rc, o->lasti);
 o->trace_opcodes = false;
 o->callback = MP_OBJ_NULL;
+o->trace_obj = MP_OBJ_NULL;


maybe call it f_trace

dpgeorge · 2022-06-27T02:35:11Z

py/profile.h

@@ -60,7 +61,9 @@ mp_obj_t mp_obj_new_frame(const mp_code_state_t *code_state);

 // This is the implementation for the sys.settrace
 mp_obj_t mp_prof_settrace(mp_obj_t callback);
+mp_obj_t mp_prof_gettrace();


please put void in arg list

dpgeorge · 2022-06-27T02:35:58Z

py/profile.c

@@ -313,6 +332,33 @@ mp_obj_t mp_prof_settrace(mp_obj_t callback) {
 return mp_const_none;
 }

+mp_obj_t mp_prof_gettrace() {


void in arg list

dpgeorge · 2022-06-27T02:38:19Z

py/profile.c

+return prof_trace_cb;
+}
+
+mp_obj_t mp_prof_get_frame(int depth) {


can we change int to size_t to indicate it can't be negative?

Requires micropython to be compiled with MICROPY_PY_SYS_SETTRACE. Also requires micropython/micropython#8767

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64: +35176 +4.114% standard[incl +13376(data) +32(bss)]
      stm32:    +8 +0.002% PYBV10
     mimxrt:   -72 -0.019% TEENSY40
        rp2:    +0 +0.000% RPI_PICO_W
       samd:   -80 -0.030% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

Re-enable binascii.crc32()

This is an automated heads-up that we've just merged a Pull Request
that removes the STATIC macro from MicroPython's C API.

See #13763

A search suggests this PR might apply the STATIC macro to some C code. If it
does, then next time you rebase the PR (or merge from master) then you should
please replace all the STATIC keywords with static.

Although this is an automated message, feel free to @-reply to me directly if
you have any questions about this.

Requires micropython to be compiled with MICROPY_PY_SYS_SETTRACE. Also requires micropython/micropython#8767

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 <[email protected]>

Signed-off-by: Andrew Leech <[email protected]>

Refer to https://docs.python.org/3/library/sys.html#sys._getframe Signed-off-by: Andrew Leech <[email protected]>

Refer to https://docs.python.org/3/library/sys.html#sys.gettrace Signed-off-by: Andrew Leech <[email protected]>

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 <[email protected]>

andrewleech force-pushed the pdb_support branch 2 times, most recently from 16bd204 to e027113 Compare June 19, 2022 23:51

andrewleech pushed a commit to andrewleech/micropython-lib that referenced this pull request Jun 20, 2022
bdb: Re-enable usage of frame.f_trace.

c1d415b
Requires micropython/micropython#8767

andrewleech pushed a commit to andrewleech/micropython-lib that referenced this pull request Jun 20, 2022
bdb: Re-enable usage of frame.f_trace.

c03abd8
Requires micropython/micropython#8767

andrewleech mentioned this pull request Jun 21, 2022
Draft: Working towards pdb debugging support. micropython/micropython-lib#499
Open

andrewleech force-pushed the pdb_support branch from e027113 to f3c6bf2 Compare June 22, 2022 00:37

andrewleech pushed a commit to andrewleech/micropython-lib that referenced this pull request Jun 22, 2022
bdb: Add initial micropython support.

b690b51
Requires micropython to be compiled with MICROPY_PY_SYS_SETTRACE. Also requires micropython/micropython#8767

andrewleech pushed a commit to andrewleech/micropython-lib that referenced this pull request Jun 22, 2022
bdb: Add initial micropython support.

6f5221d
Requires micropython to be compiled with MICROPY_PY_SYS_SETTRACE. Also requires micropython/micropython#8767

andrewleech pushed a commit to andrewleech/micropython-lib that referenced this pull request Jun 22, 2022
bdb: Add initial micropython support.

da52b43
Requires micropython to be compiled with MICROPY_PY_SYS_SETTRACE. Also requires micropython/micropython#8767

dpgeorge reviewed Jun 27, 2022
View reviewed changes

dpgeorge added the py-coreRelates to py/ directory in sourcelabel Jun 29, 2022

dpgeorge changed the title ~~Draft: Working towards pdb debugging support.~~ Improve sys.settrace support to help support bdb/pdb debugging Jun 29, 2022

dpgeorge changed the title ~~Improve sys.settrace support to help support bdb/pdb debugging~~ Improve sys.settrace to help support bdb/pdb debugging Jun 29, 2022

rkompass mentioned this pull request Dec 27, 2022
m.iMX RT: After a few seconds print() hangs #10335
Closed

andrewleech pushed a commit to andrewleech/micropython-lib that referenced this pull request Aug 24, 2023
bdb: Add initial micropython support.

448c386
Requires micropython to be compiled with MICROPY_PY_SYS_SETTRACE. Also requires micropython/micropython#8767

andrewleech force-pushed the pdb_support branch from f3c6bf2 to c32fec4 Compare August 24, 2023 00:57

RetiredWizard pushed a commit to RetiredWizard/micropython that referenced this pull request Dec 30, 2023
Merge pull request micropython#8767 from dhalbert/turn-on-crc32

1d13364
Re-enable binascii.crc32()

Gadgetoid mentioned this pull request Feb 29, 2024
global: Remove the STATIC macro. #13763
Merged

andrewleech pushed a commit to andrewleech/micropython-lib that referenced this pull request Jun 11, 2025
bdb: Add initial micropython support.

1f036b1
Requires micropython to be compiled with MICROPY_PY_SYS_SETTRACE. Also requires micropython/micropython#8767

andrewleech force-pushed the pdb_support branch from c32fec4 to b55ccd4 Compare June 11, 2025 00:32

andrewleech mentioned this pull request Jun 11, 2025
python-ecosys/debugpy: Add VS Code debugging support for MicroPython. micropython/micropython-lib#1022
Open

andrewleech changed the title ~~Improve sys.settrace to help support bdb/pdb debugging~~ Improve sys.settrace to help support debugpy / pdb debugging Jun 11, 2025

pi-anl and others added 5 commits June 11, 2025 22:09

py/objfun: Add function.__code__ attribute.

e288cb3
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 <[email protected]>

unix/standard: Enable sys.settrace() by default.

a05fa05
Signed-off-by: Andrew Leech <[email protected]>

sys/settrace: Add sys._getframe() function.

8d3dce0
Refer to https://docs.python.org/3/library/sys.html#sys._getframe Signed-off-by: Andrew Leech <[email protected]>

sys/gettrace: Add gettrace function to mirror settrace.

872b5d9
Refer to https://docs.python.org/3/library/sys.html#sys.gettrace Signed-off-by: Andrew Leech <[email protected]>

andrewleech force-pushed the pdb_support branch from b55ccd4 to a7ae522 Compare June 11, 2025 12:22

Uh oh!

Uh oh!

dpgeorge Jun 27, 2022

Uh oh!

dpgeorge Jun 27, 2022

Uh oh!

dpgeorge Jun 27, 2022

Uh oh!

dpgeorge Jun 27, 2022

Uh oh!

dpgeorge Jun 27, 2022

Uh oh!

dpgeorge Jun 27, 2022

Uh oh!

dpgeorge Jun 27, 2022

Uh oh!

dpgeorge Jun 27, 2022

Uh oh!

dpgeorge Jun 27, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Conversation

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!