Support of src project structure

[stefaneidelloth]

My project has following structure using a src folder

+ root
  + src
    + foo
      baa.py
    main.py
  + test
    + foo
        test_baa.py
    test_main.py

=> What are the right parameters for pytest_func_cov and what --import-mode should I use for pytest?

I tried pytest --func_cov=src --func_cov_report=term-missing test but get a No module named 'foo' error.

"Development tools should ensure that they support the src layout cleanly - they can obviously also support the non-src layout, but we should be clear that in order to be recommended in the PyPA guidelines, a tool must be capable of supporting the src layout."

pypa/packaging.python.org#320 (comment)

As kind of a workaround, some interim solution might be to add some extra folders to the PYTHON_PATH.

a) Maybe pytest_func_cov could support some init-hook like pylint.

# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
init-hook=''print('Hello from pylint init hook')"

b) Or support a test_setup.py file under src, initialiting the path:

import sys
import os

file_path = os.path.abspath(__file__)
src_path = os.path.dirname(file_path)

print('Including python path for testing:')
print(src_path)

sys.path.append(src_path)

[stefaneidelloth]

Got it running. The reported coverage is zero; however, that might be another issue, see #12.

I used the command

pytest --func_cov=src --func_cov_report=term-missing

in combination with following pyproject.toml settings for pytest:

[tool.pytest.ini_options]
# Also see
# https://docs.pytest.org/en/7.1.x/customize.html#pyproject-toml
# https://pytest-cov.readthedocs.io/en/latest/config.html
# If you want to see console output from tests, include -s flag
addopts = [
    # !! do not include --cov option here because it would destroy PyCharm debug feature !!
    # Also see https://stackoverflow.com/questions/40718760/unable-to-debug-in-pycharm-with-pytest
    '--junitxml=report.xml',
    '--import-mode=importlib',
]
pythonpath = 'src'
testpaths = 'test'