Skip to main content

Some helpers to help writing correction bots, use by hackinscience.org.

Project description

Correction Helper

Project

This is just a set of tools to help writing correction bots in Python for Python.

It is used for hackinscience, but could be used elsewhere.

Security considerations

Running student code is probably really unsafe, unless you trust your students not to drop you a backdoor.

This projet does not help with security in any ways, maybe take a look at firejail if you have trust issues (Yes you can use correction-helper inside firejail).

Usage

To install it, run: pip install correction-helper.

In your checking code, you can use it like this:

The student_code decorator

This decorator is aimed to catch most problems that could happen in student code, use it simply as:

with student_code():
    their_function()

Find a more complete example in the examples/ directory.

Allowed parameters for student_code, and their default values

exception_prefix="I got an exception:"

Printed right before the exception, if any.

It's allowed to give a list of strings, in which case they'll be separated by "\n\n", useful to render markdown paragraphs.

print_prefix="Your code printed:"

Message to display before the student prints (in case print_allowed is False or None).

It's allowed to give a list of strings, in which case they'll be separated by "\n\n", useful to render markdown paragraphs.

too_slow_message="Your program looks too slow, looks like an infinite loop."

Message to display in case the code runs slower than the given timeout (defaults to 1s).

It's allowed to give a list of strings, in which case they'll be separated by "\n\n", useful to render markdown paragraphs.

prefix=()

A prefix for print_prefix, exception_prefix, and too_slow_message=, usefull to deduplicate strings, like:

with student_code(
    prefix="While calling blahblah('bar')",
    print_prefix="it printed:",
    exception_prefix="it raised:",
    too_slow_message="it took more than 1s, had to kill it.",
):
    blahblah('bar')

friendly=False

To use, or not friendly-traceback instead of bare Python exceptions.

print_allowed=True

To allow or deny the student to print to stdout and stderr.

  • True: Prints are allowed (and displayed).
  • None: Prints are allowed (but not displayed).
  • False: Prints are disallowed (and displayed).

In all cases you can read what they printed using the value of the context manager:

with student_code(print_allowed=None) as run:
    their_function()
assert run.err == ""
assert run.out == "42"

Good practices

Write the student checking code a you would write unit test for your own code.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

correction_helper-2024.15.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

correction_helper-2024.15-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file correction_helper-2024.15.tar.gz.

File metadata

  • Download URL: correction_helper-2024.15.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for correction_helper-2024.15.tar.gz
Algorithm Hash digest
SHA256 33e57fdb9c71647505ecc4cdcd206073eebc2d686b12155ed5e9be3f328d82da
MD5 bdf1033261a5a44eacd885166879a378
BLAKE2b-256 d1e81dfab825ee85b3990f6767cd3e0005e6f91f09ae4ebf502d4af31b508a86

See more details on using hashes here.

Provenance

File details

Details for the file correction_helper-2024.15-py3-none-any.whl.

File metadata

File hashes

Hashes for correction_helper-2024.15-py3-none-any.whl
Algorithm Hash digest
SHA256 789d4be14c7a8740a7e24fb6cd235bcf17ea9a11bed7f85e74064b32e7cc4587
MD5 aaf1e2a4e3ddea2d01e86b679b1c4342
BLAKE2b-256 99e25dc2f42352eb3f86e4d78e22950a0a4938b8bcd468f434d5ce2c44403f0d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page