[Python Lab] add support for matplotlib and small updates #57782
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ebeastlake
reviewed
Apr 8, 2024
| @@ -102,7 +102,22 @@ const PythonEditor: React.FunctionComponent = () => { | |||
| <div> | |||
| Output: | |||
| {codeOutput.map((outputLine, index) => { | |||
| return <div key={index}>{outputLine}</div>; | |||
| if (outputLine.type === 'img') { | |||
There was a problem hiding this comment.
non-blocking nit: Should we eventually move these types to a constants file somewhere?
There was a problem hiding this comment.
This is going to get refactored completely so I think for now I'll leave as-is
There was a problem hiding this comment.
but yes, they should eventually be constants :)
There was a problem hiding this comment.
Haha, I figured! As I typed it I knew I was just making the "obligatory seeing plaintext in a condition" comment 😂 Sounds good to me!
ebeastlake
reviewed
Apr 8, 2024
| return ( | ||
| <img | ||
| key={index} | ||
| src={`data:image/png;base64,${outputLine.contents}`} |
ebeastlake
reviewed
Apr 8, 2024
| os.fsync(sys.stdout.fileno()) | ||
| `; | ||
|
|
||
| // TODO: Should we always patch matplotlib? Or can we be smarter about when to patch it? |
There was a problem hiding this comment.
Is there some comment about this included in the task to productionize the patch? If not, can we add a comment?
There was a problem hiding this comment.
I'll add a link to the ticket here!
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Warning!!
The AP CSP Create Performance Task is in progress. The most critical dates are from April 3 - April 30, 2024. Please consider any risk introduced by this PR that could affect our students taking AP CSP. Code.org students taking AP CSP primarily use App Lab for their Create Task, however a small percent use Game Lab. Carefully consider whether your change has any risk of alterering, changing, or breaking anything in these two labs. Even small changes, such as a different button color, are considered significant during this time period. Reach out to the Student Learning team or Curriculum team for more details.
Summary
The work in this PR came out of investigating if we could get matplotlib working in Python Lab. matplotlib is a supported pyodide package, but there are some issues with getting it working in a web worker (see this issue for details). As a simple workaround we can patch the matplotlib
showfunction to print a base64 string, then show said string in an image element. This may prove to be a little fragile; I filed a follow up task to productionize this.This work required a couple things that caused me to do a few refactors/improvements more generally to Python Lab. These are:
pyodideWorkerManager. Now I have moved the existing flush system out patch (which is appended to all student code) and the new matplotlib patch into a separate file, and created a utils file to handle wrapping the user's code.This is what it looks like to run a program that outputs two graphs
Links
Testing story
Tested locally. Python Lab is isolated code and not in use, so this is low risk.
Follow-up work
PR Checklist: