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

andrewleech · 2022-06-16T23:48:37Z

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-commenter · 2022-06-20T00:09:22Z

Codecov Report

❌ Patch coverage is 51.42857% with 17 lines in your changes missing coverage. Please review.
✅ Project coverage is 98.39%. Comparing base (2dc2e30) to head (3280c2a).
⚠️ Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
py/profile.c	44.82%	16 Missing ⚠️
py/modsys.c	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8767      +/-   ##
==========================================
- Coverage   98.46%   98.39%   -0.08%     
==========================================
  Files         176      176              
  Lines       22784    22816      +32     
==========================================
+ Hits        22435    22450      +15     
- Misses        349      366      +17

☔ 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

+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

+    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

        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

+            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

    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


 // 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

    return mp_const_none;
 }

+mp_obj_t mp_prof_gettrace() {


void in arg list

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

+    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

github-actions · 2023-08-24T01:07:00Z

Code size report:

Reference:  esp32/boards/SEEED_XIAO_ESP32C6: Add new XIAO board definition. [2dc2e30]
Comparison: sys/settrace: Improve settrace to support debugpy/pdb debugging. [merge of e0237a8]
  mpy-cross:    +0 +0.000% 
   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64: +35616 +4.158% standard[incl +13536(data) +32(bss)]
      stm32:    +0 +0.000% PYBV10
      esp32:    +0 +0.000% ESP32_GENERIC
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

Re-enable binascii.crc32()

projectgus · 2024-03-07T23:51:51Z

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

Add sys.gettrace() to mirror settrace, add sys._getframe() for stack frame inspection, and enable sys.settrace() by default on unix standard variant. These additions provide the baseline infrastructure needed for pdb and debugpy to function on MicroPython. Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>

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-core Relates to py/ directory in source label 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

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

andrewleech force-pushed the pdb_support branch 4 times, most recently from 0bbcb6e to e0237a8 Compare March 26, 2026 05:12

andrewleech force-pushed the pdb_support branch from e0237a8 to 3280c2a Compare March 30, 2026 20:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve sys.settrace to help support debugpy / pdb debugging#8767

Improve sys.settrace to help support debugpy / pdb debugging#8767
andrewleech wants to merge 1 commit into
micropython:masterfrom
andrewleech:pdb_support

andrewleech commented Jun 16, 2022 •

edited

Loading

Uh oh!

codecov-commenter commented Jun 20, 2022 •

edited by codecov Bot

Loading

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!

github-actions Bot commented Aug 24, 2023 •

edited

Loading

Uh oh!

projectgus commented Mar 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

andrewleech commented Jun 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Jun 20, 2022 • edited by codecov Bot Loading Uh oh! There was an error while loading. Please reload this page.

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!

github-actions Bot commented Aug 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

projectgus commented Mar 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

andrewleech commented Jun 16, 2022 •

edited

Loading

codecov-commenter commented Jun 20, 2022 •

edited by codecov Bot

Loading

github-actions Bot commented Aug 24, 2023 •

edited

Loading