Skip to main content

Tiny Python library for code demonstrations and small-scale testing

Project description

quickdemo

For when unit tests would be too much!

quickdemo is a tiny Python library for code demonstrations and small-scale testing. If your debugging tool of choice is printing to stdout, this might be the right library for you.

quickdemo allows you to decorate any module-level function with an invocation or testing directive:

import quickdemo as qd

@qd.expect([1, 2], [0, 1], 1)
@qd.run([1, 2, 3], 5)
def add_to_list(input_list, number):
    return [x + number for x in input_list]

The snippet above produces the following output:

add_to_list([1, 2, 3], 5) -> [6, 7, 8]
Passed: add_to_list([0, 1], 1)

Check out the showcase*.py files for more examples!

I developed quickdemo for two reasons:

Firstly, when presenting solutions to other people, I always wrote several print statements per function to demonstrate the correctness of the solution. The print statements always added up quickly, making it difficult to discern which output corresponded to which function. Also, changing any function name implied re-writing the invocation code. This was especially tedious when working with Jupyter Notebooks, where you have to take great care to re-run a cell each time something changes.

Secondly, there is an educational programming language called Pyret, which allows writing short unit tests as part of a function definition. I believe this to be a sensible choice when targeting beginners. Unfortunately, Pyret code is neither readable nor particularly fast, so I decided to introduce this feature to Python as a part of quickdemo.

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

quickdemo-0.2.0.tar.gz (6.0 kB view hashes)

Uploaded source

Built Distribution

quickdemo-0.2.0-py3-none-any.whl (6.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page