Skip to content

ports/unix: Add raw REPL support.#16141

Open
glenn20 wants to merge 1 commit into
micropython:masterfrom
glenn20:feature-unix-port-rawrepl
Open

ports/unix: Add raw REPL support.#16141
glenn20 wants to merge 1 commit into
micropython:masterfrom
glenn20:feature-unix-port-rawrepl

Conversation

@glenn20
Copy link
Copy Markdown
Contributor

@glenn20 glenn20 commented Nov 3, 2024 •
edited
Loading

Summary

Add raw REPL support to the unix port. This make it possible to connect to a unix micropython instance using mpremote and utilise the functionality of the raw REPL. This is useful for debugging and CI tests of mpremote and related tools.

For example, one can run micropython behind a PTY with socat and connect to the slave pty (as if it were a serial port) with mpremote:

socat PTY,link=$HOME/.upy-pty,rawer EXEC:./build-standard/micropython,pty,stderr,onlcr=0 &
mpremote resume connect ~/.upy-pty ls

(The resume argument is required since micropython v1.24 as a soft reset terminates the micropython process).

or, using the micropython docker image (thanks to @mattytrentini ):

socat PTY,link=$HOME/.upy-pty,rawer EXEC:"docker run -ti --rm micropython/unix\:v1.23.0",pty,stderr,onlcr=0

Testing

This has been tested using private CI workflows adapted from those in the mpremote-path tool (which uses mpremote as a library).

Trade-offs and Alternatives

The changes impact only the unix port (adding pyexec.c to the build) and present a user-visible change through behaviour when a ctrl-A character is entered at the repl. However, this reflects expected behaviour on other ports and should not impact on expected or supported usage.

@codecov
Copy link
Copy Markdown

codecov Bot commented Nov 3, 2024 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.54%. Comparing base (49f81d5) to head (f03f2be).
⚠️ Report is 1200 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master   #16141   +/-   ##
=======================================
  Coverage   98.54%   98.54%           
=======================================
  Files         169      169           
  Lines       21898    21898           
=======================================
  Hits        21579    21579           
  Misses        319      319

☔ 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.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Nov 3, 2024 •
edited
Loading

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64: +1484 +0.174% standard[incl +8(bss)]
      stm32:    +0 +0.000% PYBV10
     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

@glenn20 glenn20 force-pushed the feature-unix-port-rawrepl branch from 75567d5 to 7904157 Compare November 3, 2024 03:24
@glenn20
Copy link
Copy Markdown
Contributor Author

glenn20 commented Nov 3, 2024

Pushed a commit to wrap the changes to ports/unix/main.c in #ifdef __linux__ to ensure no impact on the windows port (which re-uses code in the unix port).

@dpgeorge
Copy link
Copy Markdown
Member

dpgeorge commented Nov 4, 2024

Thanks for this, I do think this is a good feature to enable on the unix port.

There are previous attempts to do similar things, which aim to unify unix and bare-metal REPL code: #12802 and #6008.

@glenn20
Copy link
Copy Markdown
Contributor Author

glenn20 commented Nov 4, 2024

Thanks for this, I do think this is a good feature to enable on the unix port.

There are previous attempts to do similar things, which aim to unify unix and bare-metal REPL code: #12802 and #6008.

Ah. Thanks for pointing out those PRs. I completely overlooked them when scanning for PRs. I see the value in a more unified approach to the repl - I was just chasing a particular feature and so a much more limited change. I'm happy to close this PR in favour of #12802 or #6008.

@dpgeorge
Copy link
Copy Markdown
Member

dpgeorge commented Nov 4, 2024

This PR is nice and simple, and may still be needed. Let's keep it open until the other ones are merged/closed.

@glenn20
ports/unix: Add raw REPL support.
f03f2be 
Add raw REPL support to the unix port. This make it possible to
connect to a unix micropython instance using mpremote and
utilise the functionality of the raw REPL. This is useful for
debugging and CI tests of mpremote and related tools.

Eg:
```
socat PTY,link=$HOME/.upy-pty,rawer |
      EXEC:./build-standard/micropython,pty,stderr,onlcr=0 &
mpremote resume connect ~/.upy-pty ls
```

Requires the inclusion of `#include "extmod/modplatform.h"` in
`pyexec.c` so that `MICROPY_BANNER_MACHINE` is fully resolved.

Changes are wrapped in `#ifdef linux` to ensure no impact on
the windows port.

Signed-off-by: Glenn Moloney <[email protected]>
@glenn20 glenn20 force-pushed the feature-unix-port-rawrepl branch from 7904157 to f03f2be Compare May 22, 2025 12:59
@dpgeorge dpgeorge mentioned this pull request May 26, 2025
Merged
@AJMansfield AJMansfield mentioned this pull request Jul 27, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

port-unix

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@glenn20 @dpgeorge