Merge pull request #4 from code-dot-org/molly/cleanup-code

Create a teardown function

Author: molly-moen

README.md

@@ -3,15 +3,16 @@ This repository consists of packages for use in Python Lab. This can contain any
 students or any patches we want to apply to student code. Here are the current packages:
 
 ### pythonlab_setup
-This package handles setup for Python Lab. Specifically, it patches libraries for use in Python Lab.
+This package handles setup and teardown for Python Lab. For setup, it patches libraries for use in Python Lab.
 The current patches are:
 - We patch `matplotlib` in order to display graphs correctly. The patch updates the `show` method to send
   a base64 encoded string for display in Python Lab.
 - We patch `requests` in order to route requests through code.org's request proxy. This protects students
   by only allowing requests to an allow-list of urls.
 
-All Python Lab programs are prefixed with `setup_pythonlab()`, the method this package exposes, which only applies
-the matplotlib patch for now.
+We run `setup_pythonlab()`, a method this package exposes, before each student run, which only applies
+the matplotlib patch for now. We also run `teardown_pythonlab()` after each run, which flushes stdout and
+changes directory to the home folder.
 
 ## unittest_runner
 This tests adds some customization to the output of unit tests, and has a function to either run validation tests

packages/pythonlab_setup/pyproject.toml

@@ -4,5 +4,5 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pythonlab_setup"
-version = "0.0.1"
+version = "0.1.0"
 dependencies = ["matplotlib"]

packages/pythonlab_setup/pythonlab_setup/__init__.py

@@ -1 +1,2 @@
 from .setup_pythonlab import setup_pythonlab
+from .teardown_pythonlab import teardown_pythonlab

packages/pythonlab_setup/pythonlab_setup/teardown_pythonlab.py

@@ -0,0 +1,14 @@
+import os
+import sys
+
+def teardown_pythonlab(home_folder):
+  flush_sysout()
+  go_home(home_folder)
+
+# Ensure stdout is flushed so all of of a user's prints are visible to them.
+def flush_sysout():
+  sys.stdout.flush()
+  os.fsync(sys.stdout.fileno())
+
+def go_home(home_folder):
+  os.chdir(home_folder)