Formatter
Pedal uses Formatters to adapt Feedback Function message_template fields to different
environments. For example, it can be used to generate HTML or Markdown in web-based
environments, or just regular text for consoles.
The power of the Formatter is that it provides conversion flags
for the message_template. As long as the Feedback author is careful, fields can be interpolated with the appropriate
formatting.
# A message_template can have fields and conversion flags:
"Your code returned {student_answer!python_value}"
# Which will generate the HTML output:
"Your code returned <code>5</code>"
# Or the plain-text output:
"Your code returned 5"
The following
- class Formatter
The base formatter that all others inherit from.
- python_code
A block of Python code, which might be turned into syntax highlighted code.
Defaults to returning a block of code with 4 spaces at the start of each line.
- python_expression
A span of Python code, which might be turned into syntax highlighted code. Should not have line breaks.
Defaults to just returning the code unchanged.
- python_value
A span of Python code, which might be turned into syntax highlighted code. Should not have line breaks.
Defaults to just returning the code unchanged.
- name
A span of a Python name, such as the name of a function or class.
Defaults to just returning the name unchanged.
- inputs
A block of inputs that were either entered by the user or provided to Pedal by the ICS. Meant to explain how a program was interacted with during execution. Think “standard input” inputs!
Defaults to returning a block of text with 4 spaces at the start of each line, and additional new lines before and after the block.
- output
A block of output text that was printed by the students’ program (or meant to be printed). Meant to explain how a program is supposed to render text during execution. Think “standard output” outputs!
Defaults to returning a block fo text with 4 spaces at the start of each line.
- line: int
A line number in code, which might be highlighted by the environment (in which case it assumes that the line is in the main file). Should therefore be numeric.
Defaults to just returning the number.
- filename
A filename, probably relevant to the project. An environment might hyperlink this to an actual file.
Defaults to just returning the filename.
- exception
A block of an Exception trace. Mostly internal.
Defaults to returning a block of text with 4 spaces at the start of each line.
- frame
A span of a code Frame. Mostly internal.
Defaults to returning the text of the frame unmodified.
- traceback
A block of a traceback. Mostly internal.
Defaults to returning the text of the frame unmodified.
- check_mark()
A check mark symbol, to indicate the student was correct. Must be called by using the report’s formatter, rather than as a conversion flag.
self.report.formatter.check_mark()
Defaults to a white space character (might be a mistake?)
- negative_mark()
An “X” (cross) that indicates the student was incorrect. Must be called by using the report’s formatter, rather than as a conversion flag.
self.report.formatter.negative_mark()
Defaults to the character
"×"
- indent()
Generates an indentation in the text. Must be called by using the report’s formatter, rather than as a conversion flag.
self.report.formatter.negative_mark()
Defaults to four spaces (
" ").
- table(rows, columns)
A function provided by the formatter to create a table of data. Must provide both the columns and rows. Has to be called by using the report’s formatter, rather than as a conversion flag.
self.report.formatter.table([ [10,2,3], [3,4,5] ], ["X", "Y", "Z"])
Results in something like this by default:
X | Y | Z 10 | 2 | 3 3 | 4 | 5
- class TextFormatter
Generates regular text. Default for command line environments. Provides no additional conversion flags over the regular
Formatter, and uses its default behavior.
- class HtmlFormatter
Generates HTML formatted text. Default for HTML-capable environments like BlockPy.