No project description provided
Project description
cg_feedback_helpers
This package provides functionality to provide feedback messages. It mainly provides
the class Asserter
. The Asserter
has a number of methods that are documented on
the official docs, which allow to run
assertions. Each assertion can provide either positive or negative feedback. A few helpers are also provided to aid with input and output coupled when running
assertions. At the end of a run, call Asserter::emit_success
to guarantee the
user receives some feedback if everything was correct.
The package outputs feedback in the following format:
{
"tag": "feedback",
"contents": [
{
"value": <your feedback message>,
"sentiment": <"positive" | "negative">
},
]
}
Usage:
The following example shows how the asserter can be used to check that the function
greet_user
responds with the correct output to a user input.
from cg_feedback_helpers import asserter, helpers
def greet_user():
name = input()
print(f"Hi {name}")
with helpers.capture_output() as buffer, helpers.as_stdin("John"):
greet_user()
output = helpers.get_lines_from_buffer(buffer)
asserter.has_length(output, 1)
asserter.equals(output[0], "John")
asserter.emit_success()
The output of which will be:
{"tag":"feedback","contents":[{"value":"Got expected length 1","sentiment":"positive"}]}
{"tag":"feedback","contents":[{"value":"Got expected value Hi John","sentiment":"positive"}]}
{"tag":"feedback","contents":[{"value":"Everything was correct! Good job!","sentiment":"positive"}]}
Module contains:
Asserter
class, of which the default messages produced can be configured, as well as its failure behavior (either using exceptions orsys.exit
);helpers
to make it easier to work with input/output tests.
Limitation:
The module currently does not support markdown feedback, nor the neutral
sentiment.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cg_feedback_helpers-2023.12.22.1110.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 343084112f24a91171013507495abfde7ce6ee97bfb7df9423ed2034ff85b7c0 |
|
MD5 | 86a0ef56a5761af5a6d6c04d526198a0 |
|
BLAKE2b-256 | 6f2b09baf317016a73455b4779aa1fe6f1dbf195c1dde55085364a9e4d6437dd |
Hashes for cg_feedback_helpers-2023.12.22.1110-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24da512705a51f79428030fe9a546613f9d7ecdf303b9f8d72849c6670a8f49e |
|
MD5 | ecfc61be1e3c631188cd93bc51862972 |
|
BLAKE2b-256 | 5cef6d0db400c51b7225dcbadb64674819a619c81c7a8a36cf79e1b56b8fc9bb |