Usage

Impyccable is designed for use with any unit-testing framework. As such the easiest way to begin using Impyccable is to decorate a unit-testing function with the structure of the required data set.

The following is a simple demo packaged with Impyccable itself that demonstrates both methods of running Impyccable tests.

from impyccable.generators import List, Integer
from impyccable.runners import Impyccable, Runner

print("===\nDecorator\n===")
@Impyccable(List(bool))
def test(val):
    """
    This function takes a list of booleans.
    """
    print(val)

test(runs=5)

print("===\nRunner\n===")
def test2(val):
    """
    The runner will supply test2 with randomly generated integers.
    """
    print(val)

imptest = Runner(test2, Integer())
imptest(5)

Here you can see the recommended way of using the @Impyccable decorator on a unit-test function as well as using a Runner object. By default these execute the underlying function with new data 10 times but this can be changed with the runs argument.

Both of these methods are constructed with a definition of the kinds of data generators that output the data you want to test against. These arguments are to be used much the same as you would if you where calling the function with real data, but to instead have Impyccable generators as values.

When a decorated function or a runner object is called it will instead run the data tests without requiring any arguments in the call. Although, the number of runs can be defined here as well as in the decorator or Runner construction.

There are multiple useful impyccable.generators to use.