Appropriate file hierarchy for unittesting in Python

Question

I am developing a collection of Python packages/modules (no executables). What is the correct/best way to set up the file hierarchy for testing. I can think of two scenarios:

Scenario 1:

AllPackages/
    package1/
        module1-1.py
        module1-2.py
    package2/
        module2-1.py
        module2-2.py
    tests/
        package1/
            test_module1-1.py
            test_module1-2.py
        package2/
            test_module2-1.py
            test_module2-2.py

Scenario 2:

AllPackages/
    package1/
        module1-1.py
        module1-2.py
        tests/
            test_module1-1.py
            test_module1-2.py
    package2/
        module2-1.py
        module2-2.py
        tests/
            test_module2-1.py
            test_module2-2.py

I am new to unittesting (I know I should have done it long ago) so I'm not sure which of these approaches is better and I'm looking for some advice from those which have more experience.

Thanks!

Misha Akovantsev · Accepted Answer · 2012-02-15 16:41:24Z

2

The 2nd scenario allows you to have pluggable packages and is used at least in Django framework (to mention some authority). If you use plain unittest module, it has discover utility, which will find all the tests you have in your project folder no matter how you organized them, so the 2nd approach fits here too.

answered Feb 15, 2012 at 16:41

Misha Akovantsev

1,82513 silver badges14 bronze badges

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

1 Comment

jlconlin Over a year ago

Thanks, this looks like a good solution. I like that it is expandable when I add more package and modules.

larsbutler · Accepted Answer · 2012-02-15 16:35:19Z

1

Scenario 1 is better, in my opinion. It makes things easier when you deploy, for example. You don't want to deploy test code, so you just omit the tests/ directory in your package. This approach is much cleaner.

Scenario 2 is messy; I don't see any advantage of mixing test code and production code in this way.

answered Feb 15, 2012 at 16:35

larsbutler

5333 silver badges11 bronze badges

Collectives™ on Stack Overflow

Appropriate file hierarchy for unittesting in Python

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related