How to run coverage for a Python project with src-layout?

Question

My python project is structured in the so called src-layout.

hyperorg
├── README.md
├── setup.cfg
├── setup.py
├── src
│   └── hyperorg
│       ├── content.py
│       ├── exporter.py
│       ├── __init__.py
│       ├── __main__.py
│       └── reader.py
└── tests
    ├── helper.py
    ├── __init__.py
    ├── test_content.py
    ├── test_exporter.py
    ├── test_hyperorg.py
    └── test_reader.py

I am not able to get coverage running for it. How can I do this?

What I tried so far

Run coverage in the projects root folder just gives me Nothing to run.

Or coverage run ./src/hyperorg gives me

Traceback (most recent call last):
File "/home/user/tab-cloud/hyperorg/src/hyperorg/__main__.py", line 6, in <module>
from .content import Content
ImportError: attempted relative import with no known parent package

How do you normally run your test suite? Take that command, and replace "python" with "coverage run". — Ned Batchelder
– Ned Batchelder, Commented Apr 29, 2022 at 20:45
@NedBatchelder it's not that simple. I just migrated to src-layout from the adhoc one and couldn't find recommended way to run coverage, hope you can help. In src-layout ideally the test & coverage needs to run on the installed package, not the one in src directory. If you set coverage source to installed package coverage report generates with absolute path of files. Combining those reports from a build matrix is another challenge. — Munim Munna
– Munim Munna, Commented Oct 2, 2022 at 16:08
Seems to be a serious Issue. Shouldn't we open a report at upstream? Maybe this #963 is about it? — buhtz
– buhtz, Commented Oct 3, 2022 at 11:20

veioxidation · Accepted Answer · 2022-11-06 12:05:53Z

2

One of the ways of doing that is entering the src folder by cd src and then running coverage from there as following:

coverage run -m unittest discover -s ../tests

You can also leverage rcfile (default .coveragerc) to specify configurations and change HTML report path to be created outside the src folder as well.

answered Nov 6, 2022 at 12:05

veioxidation

212 bronze badges

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

Collectives™ on Stack Overflow

How to run coverage for a Python project with src-layout?

What I tried so far

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

What I tried so far

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related