CS 131 Fall 2024: Project Starter

Hey there! This is a template repository that contains the necessary boilerplate for CS 131's quarter-long project: making an interpreter.

There are four stages to the project. This folder contains the necessary bootstrapping code for whatever stage of the project students are currently on:

• ply/lex.py, ply/yacc.py, brewlex.py, brewparse.py, responsible for taking in a string representing a Brewin program and outputting an AST (parser logic)
• elements.py, defines the return type of the parser
• intbase.py, the base class and enum definitions for the interpreter
• released solutions to previous stages of the project when applicable

Some notes on your submission

1. You must have a top-level, versioned interpretervX.py file (where X is the current project number) that exports the Interpreter class. If not, your code will not run on our autograder.
2. You may also submit one or more additional .py modules that your interpreter uses, if you decide to break up your solution into multiple .py files.
3. You should have a readme.txt outlining known bugs in your interpreter or "all good!" if there are none.
4. You should maintain a copy of your local git history and commit to it regularly as you work. Although this is not required for submission, we reserve the right to ask you to submit this at any time if we suspect foul play.
5. You should not modify/submit any of the source files that are present in this base template, which includes:

• ply/lex.py
• ply/yacc.py
• brewlex.py
• brewparse.py
• element.py
• intbase.py

You can find out more about our autograder, including how to run it, in the accompanying repo

Licensing and Attribution

This is an unlicensed repository; even though the source code is public, it is not governed by an open-source license.

This code was primarily written by Carey Nachenberg, with support from his TAs for the Fall 2024 iteration of CS 131.