Testing sample code in python modules

Question

I'm in the process of writing a python module that includes some samples. These samples aren't unit-tests, and they are too long and complex to be doctests. I'm interested in best practices for automatically checking that these samples run.

My current project layout is pretty standard, except that there is an extra top level makefile that has build, install, unittest, coverage and profile targets, that delegate responsibility to setup.py and nose as required.

projectname/
    Makefile
    README
    setup.py
    samples/
        foo-sample
        foobar-sample
    projectname/
        __init__.py
        foo.py
        bar.py
    tests/
        test-foo.py
        test-bar.py

I've considered adding a sampletest module, or adding nose.tools.istest decorators to the entry-point functions of the samples, but for a small number of samples, these solutions sound a bit ugly.

This question is similar to Automatically Unit Test Example Code, but I assume python best practices will differ from C#

Is it ideal to have file 'projectname' under 'projectname?'

Concerned_Citizen
– Concerned_Citizen

2012-10-24 19:09:59 +00:00
Commented Oct 24, 2012 at 19:09 — Concerned_Citizen
– Concerned_Citizen, Commented Oct 24, 2012 at 19:09

Mike Graham · Accepted Answer · 2010-05-07 16:23:13Z

3

Most of the time, I just use unittest for testing my examples and functional tests. It isn't unit testing, but a lot of what I do with the unittest module isn't. To quote Knuth, "A computer doesn’t mind if its programs are put to purposes that don’t match their names."

answered May 7, 2010 at 16:23

Mike Graham

77.2k16 gold badges105 silver badges131 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

unwind · Accepted Answer · 2010-05-07 13:40:05Z

3

Can't you just do:

if __name__ == "__main__":
  run_tests()

in the module code? This way, it will only run if the module is called as a stand-alone progran, not when it's imported into other code.

answered May 7, 2010 at 13:40

unwind

402k64 gold badges492 silver badges620 bronze badges

1 Comment

Andrew Walker Over a year ago

The problem is that some of the modules have multiple samples, and that code in those samples isn't related to the code in the module

Collectives™ on Stack Overflow

Testing sample code in python modules

2 Answers 2

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related