Conftest import error

[johnmiaoncs]

Hi,

Thanks for the help in advance!
I have this project folder structure:

Workspace
├── AAA
│   ├── __init__.py
│   └── tests
│       ├── __init__.py
│       ├── integration
│       │   ├── __init__.py
│       │   ├── conftest.py                  <--
│       │   ├── pytest.ini
│       │   ├── test_AAA.py
│       └── unit
│           ├── __init__.py
│           ├── conftest.py                   <--
│           ├── pytest.ini
│           ├── test_AAA.py
├── BBB
│   ├── __init__.py
│   ├── tests
│   │   ├── __init__.py
│   │   ├── integration
│   │   │   ├── __init__.py
│   │   │   ├── conftest.py                   <--
│   │   │   ├── pytest.ini
│   │   │   ├── test_BBB.py
│   │   └── unit
│   │       ├── __init__.py
│   │       ├── conftest.py                   <--
│   │       ├── pytest.ini
│   │       ├── test_BBB.py
├── pyproject.toml

Notice that there are multiple conftest.py in the folders with the same name.
When I run pytest, the test discovery shows errors:

====================================================================================== test session starts ======================================================================================
platform linux -- Python 3.12.12, pytest-9.0.0, pluggy-1.6.0
rootdir: /workspace
configfile: pyproject.toml
plugins: mock-3.15.1, requests-mock-1.12.1, asyncio-1.3.0
asyncio: mode=Mode.STRICT, debug=False, asyncio_default_fixture_loop_scope=None, asyncio_default_test_loop_scope=function
collected 197 items / 2 errors                                                                                                                                                                  

============================================================================================ ERRORS =============================================================================================
___________________________________________________________________ ERROR collecting BBB/tests/integration ____________________________________________________________________
.venv/lib/python3.12/site-packages/_pytest/config/__init__.py:728: in _importconftest
    mod = import_path(
.venv/lib/python3.12/site-packages/_pytest/pathlib.py:610: in import_path
    raise ImportPathMismatchError(module_name, module_file, path)
E   _pytest.pathlib.ImportPathMismatchError: ('tests.integration.conftest', '/workspace/AAA/tests/integration/conftest.py', PosixPath('/workspace/BBB/tests/integration/conftest.py'))
_______________________________________________________________________ ERROR collecting BBB/tests/unit _______________________________________________________________________
.venv/lib/python3.12/site-packages/_pytest/config/__init__.py:728: in _importconftest
    mod = import_path(
.venv/lib/python3.12/site-packages/_pytest/pathlib.py:610: in import_path
    raise ImportPathMismatchError(module_name, module_file, path)
E   _pytest.pathlib.ImportPathMismatchError: ('tests.unit.conftest', '/workspace/AAA/tests/unit/conftest.py', PosixPath('/workspace/BBB/tests/unit/conftest.py'))
==================================================================================== short test summary info ====================================================================================
ERROR BBB/tests/integration - _pytest.pathlib.ImportPathMismatchError: ('tests.integration.conftest', '/workspace/AAA/tests/integration/conftest.py', PosixPath('/workspace/BBB...
ERROR BBB/tests/unit - _pytest.pathlib.ImportPathMismatchError: ('tests.unit.conftest', '/workspace/AAA/tests/unit/conftest.py', PosixPath('/workspace/BBB/tests/unit/co...
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Interrupted: 2 errors during collection !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
======================================================================================= 2 errors in 1.55s =======================================================================================

I have followed the doc's suggestion to add __init__.py at each folder but it does not seem to work.
It's not critical but annoying, every time I want to run tests in AAA I will have to disable the BBB, as in VS Code

    "python.testing.pytestArgs": [
        "/workspace/AAA/",
        // "/workspace/BBB/",
    ],

Is there a better way or I did something wrong in the config? (I can't rename the folders as it is a shared project)

Thanks!

[bluetech]

Are you sure you added the __init__.py files?

Maybe try --import-mode=importlib and see if it helps.

[johnmiaoncs]

Thanks for the reply.

Are you sure you added the __init__.py files?

yep, I did, I double checked over and over again.... Also the structure above is from the tree command, I only deleted some irrelevant files.

Maybe try --import-mode=importlib and see if it helps.

I tried, it shows different error:

=============================================================================================== short test summary info ================================================================================================
ERROR BBB/tests/integration - ValueError: Plugin already registered under a different name: /workspace/BBB/tests/integration/conftest.py=<module 'tests.integration.conftest' from '/workspace/AAA/tes...
ERROR BBB/tests/unit - ValueError: Plugin already registered under a different name: /workspace/BBB/tests/unit/conftest.py=<module 'tests.unit.conftest' from '/workspace/AAA/tests/unit/confte...
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Interrupted: 2 errors during collection !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
================================================================================================== 2 errors in 1.15s ==================================================================================================

[bluetech]

How do you invoke pytest when this error happens?

Also, with --import-mode=importlib you might have better luck without some of the __init__.py files.

But more generally, such a layout is something that pytest currently doesn't handle. By which I mean, pytest doesn't support the concept of "workspaces"/multiple roots/monorepo layout. It currently assumes that all code is running in the same namespace. So if you have two roots AAA and BBB, both have their own tests.unit.conftest and pytest can't handle it, it wants just one.

It doesn't mean you can't use pytest, just that you can't use a single pytest invocation to test both roots at the same time. You should run pytest AAA and pytest BBB separately.

[johnmiaoncs]

Thanks!

How do you invoke pytest when this error happens?

I have two ways:

• VS Code 'Test Explorer' and configed

"python.testing.pytestArgs": [
  "AAA", 
  "BBB"
]

• command line pytest, for this I have the pyproject.tmol config as `

[tool.pytest.ini_options]
addopts = [
    "--verbose",
    "--import-mode=importlib"               
]

Also, with --import-mode=importlib you might have better luck without some of the __init__.py files.

I just tried to remove the __init__.py in AAA/tests/unit and AAA/tests/integration and keep the BBB ones there. It did help a bit as the error changes to something like some packages unable to import in BBB. But I just feel weird and cannot figure out how this works.

But more generally, such a layout is something that pytest currently doesn't handle. By which I mean, pytest doesn't support the concept of "workspaces"/multiple roots/monorepo layout. It currently assumes that all code is running in the same namespace. So if you have two roots AAA and BBB, both have their own tests.unit.conftest and pytest can't handle it, it wants just one.

It doesn't mean you can't use pytest, just that you can't use a single pytest invocation to test both roots at the same time. You should run pytest AAA and pytest BBB separately.

If it is indeed that pytest currently does not support this layout, it's fine, it's not critical, I was just afraid I did something incorrect in the config. Thanks anyway. :)