pytest cannot import module while python can

It could be that Pytest is not reading the package as a Python module while Python is (likely due to path issues). Try changing the directory of the pytest script or adding the module explicitly to your PYTHONPATH.

Or it could be that you have two versions of Python installed on your machine. Check your Python source for pytest and for the python shell that you run. If they are different (i.e. Python 2 vs 3), use source activate to make sure that you are running the pytest installed for the same python that the module is installed in.

I had the same problem but for another reason than the ones mentioned:

I had py.test installed globally, while the packages were installed in a virtual environment.

The solution was to install pytest in the virtual environment. (In case your shell hashes executables, as Bash does, use hash -r, or use the full path to py.test)

I had a similar issue, exact same error, but different cause. I was running the test code just fine, but against an old version of the module. In the previous version of my code one class existed, while the other did not. After updating my code, I should have run the following to install it.

sudo pip install ./ --upgrade

Upon installing the updated module running pytest produced the correct results (because i was using the correct code base).

I can’t say I understand why this works, but I had the same problem and the tests work fine if I run python -m pytest.

I’m in a virtualenv, with pytest also available globally:

(proj)tom@neon ~/dev/proj$ type -a python
python is /home/tom/.virtualenvs/proj/bin/python
python is /usr/bin/python

(proj)tom@neon ~/dev/proj$ python -V
Python 3.5.2

(proj)tom@neon ~/dev/proj$ type -a pytest
pytest is /home/tom/.virtualenvs/proj/bin/pytest
pytest is /usr/bin/pytest

(proj)tom@neon ~/dev/proj$ pytest --version
This is pytest version 3.5.0, imported from /home/tom/.virtualenvs/proj/lib/python3.5/site-packages/pytest.py

Install the packages into Your virtual environment.
Then start a new shell and source Your virtual environment again.

In my case, the import error occurred because the package is pointing to another package/directory with the same name and its path is one level above the folder I actually wanted.
I think this also explains why some people need to remove _ init _.py while others need to add back.

I just put print(the_root_package.__path__) (after import the_root_package) in both python console and pytest scripts to compare the difference

BOTTOM LINE: When you do python, the package you import may be different from the package when you run pytest.

I just solved this by removing the __init__.py in my project root:

.
├── __init__.py <--- removed
├── models
│   ├── __init__.py
│   ├── address.py
│   ├── appointment.py
│   └── client.py
├── requirements.txt
├── setup.cfg
├── tests
│   ├── __init__.py
│   ├── models
│   │   ├── __init__.py
│   │   ├── appointment_test.py
│   │   └── client_test.py
│   └── other_test.py
└── script.py

This problem will happen if you have a tests.py file and a tests folder with tests/__init__.py.

During the collection pytest finds the folder, but when it tries to import the test files from the folder, tests.py file will cause the import problem.

To fix simply remove the tests.py file and put all your tests inside the tests/ folder.

For your specific case the fix will be precisely:

• Remove the file /home/zz/Desktop/GitFolders/rc/tests.py
• Make sure /home/zz/Desktop/GitFolders/rc/tests/__init__.py is present

For anyone who tried everything and still getting error,I have a work around.

In the folder where pytest is installed,go to pytest-env folder.

Open pyvenv.cfg file.

In the file change include-system-site-packages from false to true.

home = /usr/bin
include-system-site-packages = true
version = 3.6.6

Hope it works .Don’t forget to up vote.

Another special case:

I had the problem using tox. So my program ran fine, but unittests via tox kept complaining.
After installing packages (needed for the program) you need to additionally specify the packages used in the unittests in the tox.ini

[testenv]
deps =
    package1
    package2 
...

The answer above not work for me. I just solved it by appending the absolute path of the module which not found to the sys.path at top of the test_xxx.py (your test module), like:

import sys
sys.path.append('path')

Had a similar issue and it worked when I added __init__.py file under tests directory.

If it is related to python code that was originally developed in python 2.7 and now migrated into python 3.x than the problem is probably related to an import issue.

e.g.
when importing an object from a file: base that is located in the same directory this will work in python 2.x:

from base import MyClass

in python 3.x you should replace with base full path or .base
not doing so will cause the above problem.
so try:

from .base import MyClass

if you need a init.py file in your folder make a copy of the folder and delete init.py in that one to run your tests it works for local projects. If you need to run test regularly see if you can move your init.py to a separate file.

I was getting this using VSCode. I have a conda environment. I don’t think the VScode python extension could see the updates I was making.

python c:Usersbrig.vscodeextensionsms-python.python-2019.9.34911pythonFilestesting_toolsrun_adapter.py discover pytest -- -s --cache-clear test
Test Discovery failed:

I had to run pip install ./ --upgrade

Edit your conftest.py and add following lines of code:

import os, sys
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(file), '..')))

And if trying to run the test case through terminal, use following ex:

python -m pytest test_some_step_file_steps.py --html=HTML_step_file_output.html --self-contained-html

[Resolved]
Before directly jumping into the solution of removing/ adding __init__.py, we might also want to look at how the imports are been done in your classes. Actually, I lost a day playing around with just __init__.py thinking that might be the problem 🙂 However, that was quite informative.

In my case, it was the wrong way of calling classes from one python class to another python class which was throwing ImportError. Fixed the way classes/ modules to be called and it worked like charm. Hope, this helps others as well.

And yes, for similar error, we might have different solutions depending on how the code is written. Better to spend more time on self debugging. Lesson Learnt 🙂 Happy coding!!!

I was experiencing this issue today and solved it by calling python -m pytest from the root of my project directory.

Calling pytest from the same location still caused issues.

My Project dir is organized as:

api/
 - server/
  - tests/
      - test_routes.py
  - routes/
      - routes.py
 - app.py

The module routes was imported in my test_routes.py as: from server.routes.routes import Routes

Hope that helps!

I had placed all my tests in a tests folder and was getting the same error. I solved this by adding an __init__.py in that folder like so:

.
|-- Pipfile
|-- Pipfile.lock
|-- README.md
|-- api
|-- app.py
|-- config.py
|-- migrations
|-- pull_request_template.md
|-- settings.py
`-- tests
    |-- __init__.py <------
    |-- conftest.py
    `-- test_sample.py

Yet another massive win for Python’s import system. I think the reason there is no consensus is that what works probably depends on your environment and the tools you are using on top of it.

I’m using this from VS Code, in the test explorer under Windows in a conda environment, Python 3.8.

The setup I have got to work is:

mypkg/
    __init__.py
    app.py
    view.py
tests/
    test_app.py
    test_view.py

Under this setup intellisense works and so does test discovery.

Note that I originally tried the following, as recommended here.

src/
    mypkg/
        __init__.py
        app.py
        view.py
tests/
    test_app.py
    test_view.py

I could find no way of getting this to work from VS Code because the src folder just blew the mind of the import system. I can imagine there is a way of getting this to work from the command line. As a relatively new convert to Python programming it gives me a nostalgic feeling of working with COM, but being slightly less fun.

My 2 cents on this: pytest will fail at chance if you are not using virtual environments. Sometimes it will just work, sometimes not.

Therefore, the solution is:

• remove pytest with pip uninstall
• create your venv
• activate your venv
• pip install your project path in editable mode, so it will be treated by pytest as a module (otherwise, pytest wont find your internal imports). You will need a setup.py file for that
• install your packages, including pytest
• finally, run your tests

The code, using windows PowerShell:

pip uninstall pytest
python.exe -m venv my_env
.my_envScriptsactivate
(my_env) pip install -e .
(my_env) pip install pytest pytest-html pandas numpy

Then finally

(my_env) pytest --html="my_testing_report.html"

An example of setup.py, for pip install -e:

import setuptools

setuptools.setup(
    name='my_package',
    version='devel',
    author='erickfis',
    author_email='[email protected]',
    description='My package',
    long_description='My gooood package',
    packages=setuptools.find_packages(),
    classifiers=[
        'Programming Language :: Python :: 3',
        'Operating System :: OS Independent',
    ],
    include_package_data=True
)

I disagree with the posts saying that you must remove any __init__.py files. What you must instead do is alter the sys.path.

Run an experiment where you print sys.path when running the code normally.
Then print sys.path while running the code via pytest. I think you will find that there is a difference between these two paths, hence why pytest breaks.

To fix this, insert the path from the first experiment at the 0th index of the second.

Let '/usr/exampleUser/Documents/foo' be the first element of print(sys.path) for experiment 1.

Below is code that should fix your issue:

import sys
sys.path[0] = '/usr/exampleUser/Documents/foo'


Put this at the top of your file, before your actual import statement.

Source: I was dealing with this myself and the above process solved it.

Kept everything same and just added a blank test file at the root folder .. Solved it

Here are the findings, this problem really bugged me for a while.
My folder structure was

mathapp/
    - server.py  
    - configuration.py 
    - __init__.py 
    - static/ 
       - home.html  
tests/            
    - functional 
       - test_errors.py 
    - unit  
       - test_add.py

and pytest would complain with the ModuleNotFoundError and gives the hint:

make sure your test modules/packages have valid Python names.

I introduced a mock test file at the same level as mathsapp and tests directory. The file contained nothing. Now pytest does not complain.

Result without the file

$ pytest
============================= test session starts =============================
platform win32 -- Python 3.8.2, pytest-5.4.2, py-1.8.1, pluggy-0.13.1
rootdir: C:mak2006workspacegithubpython-rest-app-cont
collected 1 item / 1 error

=================================== ERRORS ====================================
_______________ ERROR collecting tests/functional/test_func.py ________________
ImportError while importing test module 'C:mainakworkspacegithubpython-rest-app-conttestsfunctionaltest_func.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
testsfunctionaltest_func.py:4: in <module>
    from mathapp.service import sum
E   ModuleNotFoundError: No module named 'mathapp'
=========================== short test summary info ===========================
ERROR tests/functional/test_func.py
!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!
============================== 1 error in 0.24s ===============================

Results with the file

$ pytest
============================= test session starts =============================
platform win32 -- Python 3.8.2, pytest-5.4.2, py-1.8.1, pluggy-0.13.1
rootdir: C:mak2006workspacegithubpython-rest-app-cont
collected 2 items

testsfunctionaltest_func.py .                                          [ 50%]
testsunittest_unit.py .                                                [100%]

============================== 2 passed in 0.11s ==============================

I solved my problem by setting the PYTHONPATH in Environment Variables for the specific configuration I’m running my tests with.

While you’re viewing the test file on PyCharm:

1. Ctrl + Shift + A
2. Type Edit Configurations
3. Set your PYTHONPATH under Environment > Environment variables.

UPDATE

1. Move into your project’s directory root
2. Create a virtual environment
3. Activate your newly created virtual environment
4. Set the variable $PYTHONPATH to the root of your project and export it:

export PYTHONPATH=$(pwd)

5. Do not remove the __init__.py from the tests/ directory or from the src/ directory.

Also note:

• The root of your directory is not a python module so do NOT add an __init__.py
• conftest.py is not necessary in the root of your project.

6. The $PYTHONPATH var will only be available during the current terminal/console session; so you will need to set this each time.
   (You can follow the steps previous to this update if you are working in pycharm).

Simply put an empty conftest.py file in the project root directory, because when pytest discovers a conftest.py, it modifies sys.path so it can import stuff from the conftest module.
A general directory structure can be:

Root
├── conftest.py
├── module1
│   ├── __init__.py
│   └── sample.py
└── tests
    └── test_sample.py

In my case I am working in a container and unfortuantely pytest has the tendency to use python2.7 rather than my python3 interpreter of choice.

In my case this worked:

python3 -m pytest

My folder structure

/
app/
-module1.py
-module2.py
-tests/
--test_module1.py
--test_module2.py
requirements.txt
README.md

If you run Pytest from a terminal:

Run pytest with the --import-mode=append command-line flag.

Argument description in the official documentation: https://docs.pytest.org/en/stable/pythonpath.html

UPD:
Before I also wrote how to do the same if you use PyCharm, but community does not like extendend answers, so I removed additional information that probably was helpful to someone who have a similar issue.

I had a similar problem just recently. The way it worked for me it was realizing that "setup.py" was wrong

Previously I deleted my previous src folder, and added a new one with other name, but I didn’t change anything on the setup.py (newbie mistake I guess).

So pointing setup.py to the right packages folder did the trick for me

from setuptools import find_packages, setup

setup(
    name="-> YOUR SERVICE NAME <-",
    extras_Require=dict(test=["pytest"]),
    packages=find_packages(where="->CORRECT FOLDER<-"),
    package_dir={"": "->CORRECT FOLDER<-"},
)

Also, not init.py in test folder nor in the root one.

Hope it helps someone =)

Best!

In my case the problem was that the filename and the class name were exactly the same: FrameAnalyzer.py and FrameAnalyzer respectively. Once I changed the filename to frame_analyzer.py, everything worked.

Here’s a medium article! describing the problem!

The issue is which pytest you are using and your use of a virtual environment.
If you have installed pytest system-wide, in other words, outside of a virtual environment, pytest has a nasty habit of only looking outside your virtual environment for modules! If your project is using a module that is only installed in your virtual environment, and you’re using a system-wide pytest, it won’t find the module, even if you’ve activated the virtual environment.1

Here’s the step-by-step:1

1. Exit any virtual environment
2. Use Pip to uninstall pytest
3. Activate your project’s virtual environment
4. Install pytest inside the virtual environment
5. pytest will now find your virtual-environment-only packages!

Please check here: https://docs.pytest.org/en/documentation-restructure/background/pythonpath.html

I has an issue with pytest (that was solved using python -m pytest); the error was

FileNotFoundError: [Errno 2] No such file or directory: '/usr/local/lib/python3.9/site-packages/...

I found the problem was missing __init__.py in tests/ and tests/subfolders.

This can be resolved by adding the respective path to the System’s Environmental Variables.

Since you are using the virtualenv, the pytest may not read the environmental variables of the virtual machine.

I also faced this issue and resolved it by adding the path to the System’s Environmental Variable (PATH)

I find the answer in there :Click here

If you have other project structure, place the conftest.py in the package root dir (the one that contains packages but is not a package itself, so does not contain an init.py)

ANOTHER SUGGESTION

I explored this question and various others on SO and elsewhere… all the stuff about adding (or removing) an empty __init__.py in and/or conftest.py in various parts of the project directory structure, all the stuff about PYTHONPATH, etc., etc.: NONE of these solutions worked for me, in what is actually a very simple situation, and which shouldn’t be causing any grief.

I regard this as a flaw in pytest’s current setup. In fact I got a message recently from someone on SO who clearly knew his stuff. He said that pytest is not designed to work with (as per Java/Groovy/Gradle) separate "src" and "test" directory structures, and that test files should be mingled in amongst the application directories and files. This perhaps goes some way to providing an explanation … however, tests, particularly integration/functional tests, don’t always necessarily correspond neatly to particular directories, and I think pytest should give users more choice in this regard.

Structure of my project:

project_root
    src
        core
            __init__.py
            __main__.py
            my_other_file.py 
    tests
        basic_tests
            test_first_tests.py

The import problem posed: very simply, __main__.py has a line import my_other_file. This (not surprisingly) works OK when I just run the app, i.e. run python src/core from the root directory.

But when I run pytest with a test which imports __main__.py I get

ModuleNotFoundError: No module named 'my_other_file'

on the line in __main__.py that tries to import "my_other_file". Note that the problem here, in my case, is that, in the course of a pytest test, one application file fails to find another application file in the same package.

USING PYTHONPATH
After a lot of experimentation, and putting an __init__.py file and a confest.py file in just about every directory I could find (I think the crucial files were __init__.py added to "tests" and "basic_tests", see above directory structure), and then setting PYTHONPATH to as follows

PYTHONPATH=D:My Documentssoftware projectsEclipseWorkspacemy_projectsrccore

… I found it worked. Imports in the testing files had to be tweaked a bit, the general pattern being from core import app, project, but the test files were able to "see" core, and crucially there was no need to mess around with the import commands in the app files.

HOWEVER… for some reason the tests now run much slower using this method! Compared to my solution below, where the core package can be seen to be loaded just once, my suspicion is that the PYTHONPATH solution probably results in vast amounts of code being reloaded again and again. I can’t yet confirm this, but I can’t see any other explanation.

THE ALTERNATIVE
My alternative fairly simple solution is this:

1 – in __init__.py in that application package (i.e. directory "core"), put the following two lines:

import pathlib, sys
sys.path.append(str(pathlib.Path(__file__).parent))

NB normally there isn’t anything in an __init__.py of course. It turns out, as I confirmed by experimentation, that pytest usually (see update below) executes __init__.py in this situation, after pytest has done whatever it has done to mess up the sys.path entries.

2 – UPDATE 2022-01:
The original solution I had found involved putting a conftest.py file in the application directory(ies) – without which things didn’t work. This is obviously undesirable. I find that another solution is to put this code in your conftest.py file in your root directory:

def pytest_configure(config):
    import src.core # NB this causes `src/core/__init__.py` to run
    # set up any "aliases" (optional...)
    import sys
    sys.modules['core'] = sys.modules['src.core']

… indeed, from my experiments, the effect of putting conftest.py in the application directory seems to be that pytest then runs __init__.py in that directory. This appears to imply that the module is being imported…

(previous suggestion:)
yes, you also HAVE to include an empty "conftest.py" file in the directory "core". Hopefully this should be the only conftest.py you’ll need: I experimented with all this, and putting one in the root directory was not necessary (nor did it solve the problem without the suggested code in __init__.py).

3 – finally, in my test function, before calling core.__main__ in my example, I have to import the file I know is about to be imported:

import core.my_other_file
import core.__main__ 

If you do this in the first test in your file, you will find that sys.modules is set up for all other tests in that file. Better yet, put import core.my_other_file at the very start of the file, before the first test. Unfortunately, from core import * does not seem to work.

Later: this method has some idiosyncracies and limitations. For example, although the -k switch works OK to filter in/out tests or entire files, if you do something like pytest tests/tests_concerning_module_x, it appears that core.__init__.py does NOT get run… so the files in the core module are once again mutually unimportable during testing. Other limitations will probably come to light…

As I say, I regard this as a flaw in pytest’s setup. I have absolutely no idea what pytest does to establish a common-sense setup for sys.path, but it’s obviously getting it wrong. There should be no need to rely on PYTHONPATH, or whatever, and if indeed this is the "official" solution, the documentation on this subject is sorely lacking.

NB this suggestion of mine has a problem: by adding to sys.path every time pytest runs __init__.py in a module, it means that this new path thereafter becomes permanent in sys.path, both during testing and, more worryingly, during runs of the application itself, if there is anything which actually calls __init__.py. (Incidentally, just going python src/core (as in my example) does NOT cause this to happen. But other things might.)

To cater for this I have a clunky but effective solution:

import pathlib, sys, traceback
frame_list = traceback.extract_stack()
if len(frame_list) > 2:
    path_parts = pathlib.Path(frame_list[2].filename).parts
    if len(path_parts) > 2:
        module_dir_path_str = str(pathlib.Path(__file__).parent)
        if sys.platform.startswith('win'):
            if path_parts[-3:-1] == ('Scripts', 'pytest.exe'):
                sys.testing_context = True
                sys.path.append(module_dir_path_str)
        elif sys.platform.startswith('lin'):
            if path_parts[-3:-1] == ('_pytest', 'config'):
                sys.testing_context = True
                sys.path.append(module_dir_path_str)

This is based on my examination of the stacktrace when pytest runs something, in a W10 context and Linux Mint 20 context. It means that in an application run there will be no messing with sys.path.

Of course, this may break with future versions of pytest. My version is 6.2.5.

update PYTHONPATH till src folder

export PYTHONPATH=/tmp/pycharm_project_968/src

For me, this issue was that my test file was named: xxx.test.py

it was resolved my naming the file: xxx_test.py

But i imagine naming it: test_xxx.py would work too.

I was having the same problem using pytest under tox. I solved it by including any submodule of my project in my setup.cfg file.

My project structure:

src/
    main_module
       - __init__.py
       ...
       submodule_a
           - __init__.py
           ...
       submodule_b
           - __init__.py
           ...
tests/
    - __init__.py
    - test_a.py
    ...

My setup.cfg file

...
[options]
packages = main_module, main_module.submodule_a, main_module.submodule_b
package_dir = 
    = src
...

my case:

• all configurations are correct except I forgot to remove the default my_app/tests.py

  • After removing it, python -m pytest tests/my_app works fine

• pytest.ini:

[pytest]
DJANGO_SETTINGS_MODULE=necktie_hy.settings
python_files=*/tests/*/test_*.py
python_classes=Test

My issue was solved by fixing an import. I was importing from project_root.tests.xxxx and when I changed it to from tests.xxxx it worked. Funny thing is Pycharm didn’t mark it as an error in the project tree view, I had to go into the file and only there it showed in red.

Points to be observed in the same order as below:

1. Make sure that every folder and subfolder of your app has a __init__.py
   file.
2. Make sure that the tests folder(module) is inside the app folder(module).
3. Try pytest command and if that doesn’t work try python3 -m pytest .

As of pytest 7.0, you can now add pythonpath in pytest.ini. No need to add __init__.py or conftest.py in your root directory.

[pytest]
minversion = 7.0
addopts = --cov=src
pythonpath = src
testpaths =
    tests

You can run pytest without any parameters.

https://docs.pytest.org/en/7.0.x/reference/reference.html#confval-pythonpath

I faced the same/similar issue when trying to import a new class in my test file. In my case I moved the new import to be the last one in the test file, and then the problem went away. Not entirely sure why though.

The TestCase directory must be a Python Package

I can generally recommend using absolute paths and running the applications and/or tests from the root or perhaps parent folder.

If someone is receiving this error in FastAPI with Uvicorn, simply run e.g.

uvicorn app.main:app --host 0.0.0.0 --port 8080