A simple tool for testing
Project description
A simple tool for testing
litio
how to use
example 1: The basics
install
pip install litio
run
python3 -m litio -c litio-config.yml
litio-config.yml:
name: My Awesome Title
tests:
firsth-test: # test name
path: ./tests/test1.py # path to python file
functions: # functions list
- pow: # function name
inputs: # inputs
# arguments with name of parameters
base: 2
exponent: 2
expected:
value: 4 # expected value
comparator: Equals
print-return: true # print returned value by function
test1.py:
def pow(base, exponent):
return base**exponent
example 2: If something fails?
test2.py:
def pow(base, exponent):
return base / exponent # it's obviously not working.
litio-config.yml:
name: My Awesome Title
api-key: YOUR_OPENAI_API_KEY_ENVIRONMENT_VARIABLE # the name of the environment variable, NOT THE API KEY!
tests:
failed-test:
path: ./tests/test2.py
functions:
- pow:
inputs:
base: 2
exponent: 2
expected:
value: 4
comparator: Equals
verbose: true
auto-fix: true # auto fix function using AI if call fails
how auto-fix works?
The "auto-fix" parameter instructs litio to use artificial intelligence to automatically repair and replace the function in the source code. If you prefer to confirm before consulting AI, you can use the "use-ai" parameter instead of "auto-fix."
Litio config file reference
name
paramater
- The
name
parameter is the title of the config file.
api-key
parameter
- The
api-key
parameter is the name of the environment variable that contains the OpenAI API key, NOT THE API KEY!
tests
parameter
- The
tests
parameter is a dictionary of tests.
Tests structure
- The test name is the name of the test.
- The
path
parameter is the path to the Python file that contains the functions, methods or classmethods to test. - The
functions
parameter is a list of functions to test.
Looks like this:
...
tests:
first-test:
path: ./src/utils.py
functions:
- add: # function name
...
Function structure
- The function name is the name of the function.
- The
inputs
parameter is a dictionary of inputs. - The
expected
parameter is a dictionary with expected value and comparator. - The
print-return
parameter is a boolean that indicates whether to print the returned value. - The
verbose
parameter is a boolean that indicates whether to print the full function call. Included the returned value. - The
auto-fix
parameter is a boolean that indicates whether to use AI to automatically fix the function. Only can be used with theEquals
comparator. - The
use-ai
parameter is a boolean that indicates whether to use AI to fix the function. Only can be used with theEquals
comparator.
Looks like this:
...
tests:
first-test:
path: ./src/utils.py
functions:
- FUNCTION_NAME: # (e.g. subtract)
inputs:
a: 1 # arguments with name of parameters
b: 2 # must be the same as the name of the parameter
expected:
value: -1 # expected value
comparator: Equals
Using methods
The syntax for a method is the same as that of a function, except that you need to add the "instance" parameter with the values to instantiate an object of that class.
Looks like this:
...
tests:
first-test:
path: ./src/utils.py
functions:
- Person.get_age:
instance:
name: John
age: 30
expected:
value: 30
comparator: Equals
What comparators are there?
Equals
Greater
Less
GreaterOrEqual
LessOrEqual
NotEquals
Is
isNot
IsNone
IsNotNone
IsInstance
IsNotInstance
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
litio-1.1.0.0.tar.gz
(21.7 kB
view hashes)
Built Distribution
litio-1.1.0.0-py3-none-any.whl
(20.8 kB
view hashes)