Pyret Summer Updates 2020
We’ve been working on a few improvements and new features in Pyret that we’re excited to share.
- New image library functionality
- New syntax for controlling modules
- A new way to write more descriptive tests
- Basic accessibility infrastructure for screenreaders (not complete)
- Fixes for numerous small bugs
There are some backwards incompatibilities in this release that we view as being minor and unlikely to affect the vast majority of programs. We’ll get those out of the way up front:
becauseis a new keyword that wasn’t in Pyret’s reserved keyword list. Programs that used
becauseas a variable name will need to choose a new name for that variable.
- We have changed the way pinholes work for calculating centers of images, which affects how odd-sided polygons’ centers behave.
New image library functionality
Pyret’s image library has been updated to include new image primitives (wedge creates a slice of a pie, and point-polygon creates a polygon from a list of coordinates), new image combinators (such as
-list variants of
beside etc, which take a list of images instead of just two, and overlay-onto-offset, which is a generalization of
overlay-offset), and new mechanisms for handling the pinholes of images. Finally, we provide a new, typed library for images, that uses Pyret data definitions (instead of strings) as the arguments to the image functions.
Pinholes Intuitively, think of overlaying images as pinning them together with a push-pin; the point where the pin connects the images is their pinhole. By default, the pinhole is in the visual center of each image. This has changed very slightly from before, where it used to be the geometric center of each image (measured by its bounding box); this only affects polygons with odd numbers of sides, and should simply make the images feel less “bottom-heavy” than before. You’ll now be able to align a triangle or pentagon at the center of a rectangle, or spin a star around its center, without it being lopsided.
Pinhole at visual center of star
Star is visually centered inside circle
Pinhole at geometric center of star’s bounding box
Star is below the visual center of circle
Additionally, we provide new functions
draw-pinhole to see where the pinhole is in an image,
center-pinhole to move it to its geometric center, and
move-pinhole to move it by some specified offset.
Explaining test cases with
Often when writing tests, we have a choice: we can either write a test case that shows the expected answer, or we can write a test case that shows the expression that produces that answer:
check: distance(0, 0, 3, 4) is 5 distance(0, 0, 3, 4) is num-sqrt(num-sqr(3 - 0) + num-sqr(4 - 0)) end
The former is useful for sanity-checking results; the latter is useful in the design process for deducing how a function should be implemented. Pyret now supports an optional
because keyword on test cases to express both of these ideas at once:
check: distance(0, 0, 3, 4) is 5 because num-sqrt(3 - 0) + num-sqr(4, 0)) end
Semantically, Pyret will first check whether the explanation (at the end, after
because) matches the expected expression (after
is), and warn the programmer that their expected answer and their explanation are inconsistent if they are not equal. If they are, then Pyret continues to check the actual expression (at the beginning) against the expected expression as usual.
A because clause is Pyret’s answer to the common teacher request to “show your work”. Once a few test cases are written that show work, additional tests can be written that don’t need the extra clause. Conversely, if a test case is unexpectedly failing, the programmer can write a
because clause to elaborate on their reasoning. Since Pyret will check that the explanation matches the expected result, this helps pinpoint errors in reasoning without having to debug the function implementation itself.
New Syntax (and Some Internal Improvements) for Modules
We’ve added user-facing syntax for much more fine-grained control of names across module boundaries. Modules can now
- Re-export values from other modules without naming them all
- More easily rename and exclude names when providing
- More easily export names related to a particular data definition
This has also led to several improved error messages that relate source locations across modules or between definitions and interactions areas.
Basic Accessibility Infrastructure for Screenreaders
If you load code.pyret.org with a screenreader enabled, you will now hear dictated results at interactions. For example, if you type (with a screenreader on)
2 + 2 and hit enter at interactions, you should hear “two plus two evaluated to four.” Try it with images!
Note that this is pre-alpha infrastructure that we’re getting in place so we can make future improvements on top of it — there’s more work to do for true screenreader support for navigation of code and values. Credit goes to Dorai Sitaram, Emmanuel Schanzer, and Sina Bahram for their work on this.
This release includes contributions from Ayaz Hafiz, Philip Blair, Ben Muschol, Ben Lerner, Dorai Sitaram, Doug Woos, Alexander Vo, Joe Politz, Jack Wrenn, Matthew Kolosick, Emmanuel Schanzer, Seth Poulson, Shriram Krishnamurthi, Sorawee Porncharoenwase, Jesse Tov, and Zachary Espiritu.