Typical folder structure for a python project with unit and integration tests?

Question

What would be a typical structure and path/import conventions used? Would anyone have a link to a representative python project?

project.scratch/
    project/
        scratch/
            __init__.py
            dostuff.py
            tests/
                unit/
                    test_dostuff.py
                integration/
                    test_integration.py

github.com/languages/Python

duenni
– duenni

2013-05-02 05:59:10 +00:00
Commented May 2, 2013 at 5:59 — duenni
– duenni, Commented May 2, 2013 at 5:59

Joshua Howard · Accepted Answer · 2018-03-08 17:37:21Z

5

Similar to what you have shown, the typical python project structure is as follows.

├── app_name
    │
    ├── app_name
    │   ├── __init__.py
    │   ├── folder_name
    │   └── etc...
    ├── tests
    │   ├── unit
    │   └── integration
    ├── README.md
    ├── setup.py
    └── requirements.txt

```

This statement is largely due to personal experience, but it is also the structure advocated here.

I have also seen an integration_tests directory as a sibling of the tests directory instead, but I believe that this is much less common.

Contrary to Bhavish Agarwal's answer, I see no mention of integration tests for Django (only integration tests using Django). It seems they decided not to have any.

answered Mar 8, 2018 at 17:37

Joshua Howard

9261 gold badge12 silver badges27 bronze badges

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

4 Comments

Naveen Over a year ago

I have also seen an integration_tests directory as a sibling of the tests directory instead, but I believe that this is much less common. -> So where would be the right place ? I currently have my structure similar to what you have described but im not sure if this is right? Or is there no right or wrong way

Joshua Howard Over a year ago

@Naveen There is no right or wrong way. I like the structure that I provided because pytest will run both unit and integration tests together with both in the tests folder. It's still just personal opinion.

yardstick17 Over a year ago

Advocated link is broken @JoshuaHoward

FreyGeospatial Over a year ago

Adding what I think is the correct link @JoshuaHoward advocated here: docs.saltproject.io/en/latest/topics/tutorials/…

Bhavish Agarwal · Accepted Answer · 2013-05-02 06:10:11Z

-2

Since you asked for a typical structure, why look further than (arguably) the most famous python framework: django

answered May 2, 2013 at 6:10

Bhavish Agarwal

6737 silver badges13 bronze badges

2 Comments

p3t3 Over a year ago

Where can I find integration tests in django, and how would coverage tests be performed?

MattSom Over a year ago

Please expand this answer with an actual structure, don't just link to somewhere else.

Collectives™ on Stack Overflow

Typical folder structure for a python project with unit and integration tests?

2 Answers 2

4 Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related