nose-docstring-modifier 0.0.6

Enables you to modify docstring of tests based on their attributes

The project is available on GitHub

Installing

You can install nose-docstring-modifier plugin using pip:

$ pip install nose-docstring-modifier

Using

Given the following test function, that uses nose-ittr plugin:

@ittr(platforms=['P1', 'P2', 'P3'])
@attr(section='MySection', type='functional+', module='MyModule', id=1)
def test_function(self):
    """
    This is the original docstring
    """
    for platform in self.platforms:
        ok_(True)

running it with nosetest using nose-docstring-modifier plugin:

nosetests --with-docstring-modifier --prefix=id,section,platform --suffix=type --replace=('s','S')

will print

(1, MySection, P1) ThiS iS the original docString (functional+) ... ok
(1, MySection, P2) ThiS iS the original docString (functional+) ... ok
(1, MySection, P3) ThiS iS the original docString (functional+) ... ok

Note that if you hardcode the platform on docstring, you cannot get dynamic output and you’ll get the same platform even when the test runs on three different platforms.

Features

• Works with multiprocess plugin:

nosetests --processes=10 --process-restartworker with-docstring-modifier --prefix=id

spreads test run among 10 processes, appending id attribute to each test.

History

0.0.6 (2014-11-25)

• Added ability to display only first line of docstring
• Changed the way –replace called: –replace=(‘s’,’S’)

0.0.5 (2014-11-24)

• HOTFIX - Fixed a bug that caused an error when running the plugin due to dependency with another upcoming plugin

0.0.4 (2014-11-06)

• Code design changes

0.0.3 (2014-11-05)

• Multiprocessing support

0.0.2 (2014-11-04)

• Initial release

Authors

Authors:	Maroun Maroun
Contributors:	Tal Ben Basat Nicole Franco Roy Klinger Sergey Ragatsky
Version:	0.0.6 of 26/11/2014