Skip to main content

nodev helpers to write specification tests.

Project description

nodev.specs helps you write robust tests that describe the abstract behaviour of your code leaving many implementation details out of your tests.

The general idea is best explained with an example, let’s write a specification test for the following function skip_comments that returns the non-comment part of every line in the input file:

def skip_comments(stream):
    return [line.partition('#')[0] for line in stream]

The simplest unit test may look like the following:

def test_skip_comments():
    assert skip_comments(['# comment']) == ['']
    assert skip_comments(['value # comment']) == ['value ']
    assert skip_comments(['value 1', '', 'value 2']) == ['value 1', '', value 2']

Such a unit test is much more tied to current skip_comments implementation than it needs to be and the test will need update every time a tiny feature is added, like turning the function into a generator:

def skip_comments(stream):
    for line in stream:
        yield line.partition('#')[0]

This can be fixed by re-writing the test in more generic way:

def test_skip_comments():
    assert '' in skip_comments(['# comment'])
    assert 'value ' in skip_comments(['value # comment'])
    assert 'value 1' in skip_comments(['value 1', '', 'value 2'])
    assert 'value 2' in skip_comments(['value 1', '', 'value 2'])

Let’s re-write the test making use of the nodev.specs.FlatContainer helper:

def test_skip_comments():
    assert '' in FlatContainer(skip_comments(['# comment']))
    assert 'value ' in FlatContainer(skip_comments(['value # comment']))
    assert 'value 1' in FlatContainer(skip_comments(['value 1', '', 'value 2']))
    assert 'value 2' in FlatContainer(skip_comments(['value 1', '', 'value 2']))

Now you can choose to skip empty lines returning the current line index instead:

def skip_comments(stream):
    for index, line in enumerate(stream):
        value = line.partition('#')[0]
        if value:
            yield index, value

Or return also the comment for every line:

def skip_comments(stream):
    for index, line in enumerate(stream):
        value, sep, comment = line.partition('#')
        if value:
            yield index, value, sep + comment

The nodev test needs no update because it makes almost no assumption on the details of the return value.

Project resources

Discussion To be decided, see issue #15 of the pytest-nodev repository.
Code quality Build Status on Travis CI Build Status on AppVeyor Coverage Status on Coveralls
nodev website


Contributions are very welcome. Please see the CONTRIBUTING document for the best way to help. If you encounter any problems, please file an issue along with a detailed description.



  • B-Open Solutions srl


nodev.specs is free and open source software distributed under the terms of the MIT license.

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 nodev.specs, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size nodev.specs-0.3.1-py2.py3-none-any.whl (8.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size nodev.specs-0.3.1.tar.gz (6.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page