Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

It makes combinations covering pairs for pairwise testing.

Project description

https://badge.fury.io/py/covertable.svg https://circleci.com/gh/walkframe/covertable.svg?style=shield https://codecov.io/gh/walkframe/covertable/branch/master/graph/badge.svg https://img.shields.io/badge/code%20style-black-000000.svg https://img.shields.io/badge/License-Apache%202.0-blue.svg

Requirements

  • Python: 3.3 or later.
    • Tested with 3.7

Installation

$ pip install covertable

Usage

Just import covertable and call make function.

>>> from covertable import make, sorters

>>> machine_list = ['iphone', 'pixel']
>>> os_list = ['ios', 'android']
>>> browser_list = ['FireFox', 'Chrome', 'Safari']

>>> # list input and output
... make(
...     [machine_list, os_list, browser_list],  # list factors
...     length=2,  # default: 2
...     sorter=sorters.greedy,  # default: sorters.sequential
...     sort_kwargs={'seed': 100},  # default: {}
...     pre_filter=lambda row: not(row[1] == 'android' and row[0] != 'pixel'),  # default: None
...     post_filter=lambda row: not(row[1] == 'ios' and row[2] != 'Safari'),  # default: None
... )
[
  ['iphone', 'ios', 'Safari'],
  ['pixel', 'android', 'Safari']
]

>>> # dict input and output
... make(
...     {'machine': machine_list, 'os': os_list, 'browser': browser_list},  # dict factors
...     length=2,  # default: 2
...     sorter=sorters.greedy,  # default: sorters.sequential
...     sort_kwargs={'seed': 100},  # default: {}
...     pre_filter=lambda row: not(row['os'] == 'android' and row['machine'] != 'pixel'),  # default: None
...     post_filter=lambda row: not(row['os'] == 'ios' and row['browser'] != 'Safari'),  # default: None
... )
[
  {'os': 'ios', 'browser': 'Safari', 'machine': 'iphone'},
  {'machine': 'pixel', 'browser': 'Safari', 'os': 'android'}
]

Options

covertable.make function has options as keyword argument.

All options are omittable.

length

It means length of pair to meet. (default: 2)

The more it increases, the more number of combinations increases.

sorter

Combinations depend on the order of spreading all over the rows.

You can choice a sorter from the following:

sorters.sequential:
 It is simplest and fastest sorter. (default)
sorters.random:It makes different combinations everytime.
sorters.hash:It makes combinations depending on hash of the pair (and seed).
sorters.greedy:It attempts to make most efficient combinations, but slowest. (Warning: these combinations are not always shortest compared to the other sorter’s one.)

sort_kwargs

sort_kwargs will be passed to sorter function mentioned above.

seed:

It is a seed of hash. sorters.hash and sorters.greedy use this option.

When seed and factors are not changed, output combinations will not be changed.

Not relevant options will be ignored.

pre_filter

This means a function to filter beforehand.

It receives an argument row as object type.

When the function returns false, the row combination will not registered.

  • If factors type is Array, you should an index at the subscript like row => row[1] < 6.
  • IF factors type is Object, you should a key at the subscript like row => row.month < 6 or row => row[‘month’] < 6

post_filter

This means a function to filter later.

Usage is the same as preFilter, only the difference is the timing that it is called. It will delete rows not matched this function at the last.

Development

# preparation
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ pip install -r dev_requirements.txt

# testing
(venv) $ tox # -e py37 -e cov -e black

Publish

(venv) $ python setup.py sdist bdist_wheel
(venv) $ twine upload --repository pypi dist/*

Project details


Download files

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

Files for covertable, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size covertable-1.1.0-py3-none-any.whl (6.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size covertable-1.1.0.tar.gz (5.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page