Full path in .pyc files causes fixtures not to be found #7890

beenje · 2020-10-12T13:32:11Z

beenje
Oct 12, 2020

a detailed description of the bug or problem you are having

I'm using pytest-factoryboy and the factory boy fixture can't be found after updating pytest to 6.1.1.
It could be a pytest-factoryboy issue but as it works with pytest 6.1.0, I assumed it's a pytest problem.

output of pip list from the virtual environment you are using

Package           Version
----------------- -------
attrs             20.2.0
factory-boy       3.1.0
Faker             4.9.0
inflection        0.5.1
iniconfig         1.0.1
packaging         20.4
pip               20.2.3
pluggy            0.13.1
py                1.9.0
pyparsing         2.4.7
pytest            6.1.1
pytest-factoryboy 2.0.3
python-dateutil   2.8.1
setuptools        47.1.0
six               1.15.0
text-unidecode    1.3
toml              0.10.1

[X ] pytest and operating system versions

# pytest -v tests/
========================================================================================== test session starts ===========================================================================================
platform linux -- Python 3.8.5, pytest-6.1.1, py-1.9.0, pluggy-0.13.1 -- /venv/bin/python
cachedir: .pytest_cache
rootdir: /build
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py::test_author_factory ERROR                                                                                                                                                    [100%]

================================================================================================= ERRORS =================================================================================================
_________________________________________________________________________________ ERROR at setup of test_author_factory __________________________________________________________________________________
file /Users/benjaminbertrand/Dev/web/flask/test-factoryboy/tests/test_models.py, line 1: source code not available
E       fixture 'author_factory' not found
>       available fixtures: _session_faker, cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, factoryboy_request, faker, monkeypatch, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
>       use 'pytest --fixtures [testpath]' for help on them.

/Users/benjaminbertrand/Dev/web/flask/test-factoryboy/tests/test_models.py:1
======================================================================================== short test summary info =========================================================================================
ERROR tests/test_models.py::test_author_factory
============================================================================================ 1 error in 0.07s ============================================================================================

minimal example if possible

$ tree
.
└── tests
    ├── __init__.py
    ├── conftest.py
    ├── factories.py
    └── test_models.py

File factories.py:

import factory
from faker import Factory as FakerFactory

faker = FakerFactory.create()


class Author:
    def __init__(self, name):
        self.name = name


class AuthorFactory(factory.Factory):

    name = factory.LazyAttribute(lambda x: faker.name())

    class Meta:
        model = Author

File conftest.py

from pytest_factoryboy import register

from . import factories

register(factories.AuthorFactory)

File test_models.py:

def test_author_factory(author_factory):
    author = author_factory(name="John")
    assert author.name == "John"

On OSX, using pytest 6.1.1, works:

$ pytest -v tests
========================================================================================== test session starts ===========================================================================================
platform darwin -- Python 3.8.5, pytest-6.1.1, py-1.9.0, pluggy-0.13.1 -- /Users/benjaminbertrand/Dev/web/flask/test-factoryboy/.venv/bin/python
cachedir: .pytest_cache
rootdir: /Users/benjaminbertrand/Dev/web/flask/test-factoryboy
plugins: factoryboy-2.0.3, Faker-4.9.0
collected 1 item

tests/test_models.py::test_author_factory PASSED                                                                                                                                                   [100%]

=========================================================================================== 1 passed in 0.05s ============================================================================================

On Linux, the same fails:

 $ docker run --rm -it -v $(pwd):/build python:3.8 bash
root@fea28e9c91d2:/# python -m venv /venv
root@fea28e9c91d2:/# source /venv/bin/activate
(venv) root@fea28e9c91d2:/# pip install pytest-factoryboy
(venv) root@fea28e9c91d2:/# cd /build
(venv) root@fea28e9c91d2:/build# pytest -v tests/
========================================================================================== test session starts ===========================================================================================
platform linux -- Python 3.8.5, pytest-6.1.1, py-1.9.0, pluggy-0.13.1 -- /venv/bin/python
cachedir: .pytest_cache
rootdir: /build
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py::test_author_factory ERROR                                                                                                                                                    [100%]

================================================================================================= ERRORS =================================================================================================
_________________________________________________________________________________ ERROR at setup of test_author_factory __________________________________________________________________________________
file /Users/benjaminbertrand/Dev/web/flask/test-factoryboy/tests/test_models.py, line 1: source code not available
E       fixture 'author_factory' not found
>       available fixtures: _session_faker, cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, factoryboy_request, faker, monkeypatch, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
>       use 'pytest --fixtures [testpath]' for help on them.

/Users/benjaminbertrand/Dev/web/flask/test-factoryboy/tests/test_models.py:1

If I downgrade pytest to 6.1.0, it works:

(venv) root@fea28e9c91d2:/build# pip install pytest==6.1.0
(venv) root@fea28e9c91d2:/build# pytest -v tests/
========================================================================================== test session starts ===========================================================================================
platform linux -- Python 3.8.5, pytest-6.1.0, py-1.9.0, pluggy-0.13.1 -- /venv/bin/python
cachedir: .pytest_cache
rootdir: /build
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py::test_author_factory PASSED                                                                                                                                                   [100%]

=========================================================================================== 1 passed in 0.07s ============================================================================================

Answered by beenje

Oct 15, 2020

To summarise, it seems the full path of the files is used inside the pyc files instead of relative path. This isn't a platform issue. It can easily be reproduced using docker by mounting the same directory in 2 different locations:

$ docker run --rm -it -v $(pwd):/app1 -v $(pwd):/app2 beenje/test-pytest-factoryboy bash
dev@1eef1e791dd8:/app$ cd /app1
dev@1eef1e791dd8:/app1$ rm -rf tests/__pycache__/
dev@1eef1e791dd8:/app1$ pytest
========================================================================== test session starts ==========================================================================
platform linux -- Python 3.8.6, pytest-6.1.1, py-1.9.0, pluggy-0.13.1
rootdir: /app1
plugins:…

View full answer

The-Compiler · 2020-10-12T14:57:44Z

The-Compiler
Oct 12, 2020
Maintainer

Works fine for me:

$ docker run --rm -it -v $(pwd):/build python:3.8 bash
root@513861b8e87f:/# python -m venv /venv
root@513861b8e87f:/# source /venv/bin/activate
(venv) root@513861b8e87f:/# pip install pytest-factoryboy
[...]
Successfully installed Faker-4.9.0 attrs-20.2.0 factory-boy-3.1.0 inflection-0.5.1 iniconfig-1.0.1 packaging-20.4 pluggy-0.13.1 py-1.9.0 pyparsing-2.4.7 pytest-6.1.1 pytest-factoryboy-2.0.3 python-dateutil-2.8.1 six-1.15.0 text-unidecode-1.3 toml-0.10.1
[...]
(venv) root@513861b8e87f:/# cd /build
(venv) root@513861b8e87f:/build# pytest -v tests/
============================================================================================================ test session starts =============================================================================================================
platform linux -- Python 3.8.6, pytest-6.1.1, py-1.9.0, pluggy-0.13.1 -- /venv/bin/python
cachedir: .pytest_cache
rootdir: /build
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item                                                                                                                                                                                                                             

tests/test_models.py::test_author_factory PASSED                                                                                                                                                                                       [100%]

============================================================================================================= 1 passed in 0.02s ==============================================================================================================

(venv) root@513861b8e87f:/build# cat tests/conftest.py 
from pytest_factoryboy import register

from . import factories

register(factories.AuthorFactory)

(venv) root@513861b8e87f:/build# cat tests/factories.py 
import factory
from faker import Factory as FakerFactory

faker = FakerFactory.create()


class Author:
    def __init__(self, name):
        self.name = name


class AuthorFactory(factory.Factory):

    name = factory.LazyAttribute(lambda x: faker.name())

    class Meta:
        model = Author

(venv) root@513861b8e87f:/build# cat tests/test_models.py 
def test_author_factory(author_factory):
    author = author_factory(name="John")
    assert author.name == "John"

Can you maybe share a built docker image where this can be reproduced?

0 replies

beenje · 2020-10-13T05:34:56Z

beenje
Oct 13, 2020
Author

Thanks for he quick feedback.

When creating a docker image with the following .dockerignore I noticed I couldn't reproduce the problem:

**/*.swp
**/__pycache__
.venv
.pytest_cache

I pinned the issue to the __pycache__ directory:

dev@3b50b92e0f8b:/app$ pytest -v tests/
================================================================== test session starts ==================================================================
platform linux -- Python 3.8.6, pytest-6.1.1, py-1.9.0, pluggy-0.13.1 -- /venv/bin/python
cachedir: .pytest_cache
rootdir: /app
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py::test_author_factory ERROR                                                                                                   [100%]

======================================================================== ERRORS =========================================================================
_________________________________________________________ ERROR at setup of test_author_factory _________________________________________________________
file /Users/benjaminbertrand/Dev/web/flask/test-factoryboy/tests/test_models.py, line 1: source code not available
E       fixture 'author_factory' not found
>       available fixtures: _session_faker, cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, factoryboy_request, faker, monkeypatch, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
>       use 'pytest --fixtures [testpath]' for help on them.

/Users/benjaminbertrand/Dev/web/flask/test-factoryboy/tests/test_models.py:1
================================================================ short test summary info ================================================================
ERROR tests/test_models.py::test_author_factory
=================================================================== 1 error in 0.04s ====================================================================
dev@3b50b92e0f8b:/app$ ls -l tests/__pycache__/
total 24
-rw-r--r-- 1 dev dev 162 Oct 12 13:27 __init__.cpython-38.pyc
-rw-r--r-- 1 dev dev 340 Oct 12 13:29 conftest.cpython-38-pytest-6.1.0.pyc
-rw-r--r-- 1 dev dev 387 Oct 12 13:27 conftest.cpython-38-pytest-6.1.1.pyc
-rw-r--r-- 1 dev dev 995 Oct 12 13:27 factories.cpython-38.pyc
-rw-r--r-- 1 dev dev 815 Oct 12 13:29 test_models.cpython-38-pytest-6.1.0.pyc
-rw-r--r-- 1 dev dev 862 Oct 12 13:27 test_models.cpython-38-pytest-6.1.1.pyc
dev@3b50b92e0f8b:/app$ rm -f tests/__pycache__/test_models.cpython-38-pytest-6.1.1.pyc
dev@3b50b92e0f8b:/app$ pytest -v tests/
================================================================== test session starts ==================================================================
platform linux -- Python 3.8.6, pytest-6.1.1, py-1.9.0, pluggy-0.13.1 -- /venv/bin/python
cachedir: .pytest_cache
rootdir: /app
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py::test_author_factory ERROR                                                                                                   [100%]

======================================================================== ERRORS =========================================================================
_________________________________________________________ ERROR at setup of test_author_factory _________________________________________________________
file /app/tests/test_models.py, line 1
  def test_author_factory(author_factory):
E       fixture 'author_factory' not found
>       available fixtures: _session_faker, cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, factoryboy_request, faker, monkeypatch, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
>       use 'pytest --fixtures [testpath]' for help on them.

/app/tests/test_models.py:1
================================================================ short test summary info ================================================================
ERROR tests/test_models.py::test_author_factory
=================================================================== 1 error in 0.05s ====================================================================
dev@3b50b92e0f8b:/app$ rm -f tests/__pycache__/conftest.cpython-38-pytest-6.1.1.pyc
dev@3b50b92e0f8b:/app$ pytest -v tests/
================================================================== test session starts ==================================================================
platform linux -- Python 3.8.6, pytest-6.1.1, py-1.9.0, pluggy-0.13.1 -- /venv/bin/python
cachedir: .pytest_cache
rootdir: /app
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py::test_author_factory PASSED                                                                                                  [100%]

=================================================================== 1 passed in 0.04s ===================================================================

The error file /Users/benjaminbertrand/Dev/web/flask/test-factoryboy/tests/test_models.py, line 1: source code not available should have warned me. This isn't the path of the file inside the docker container but on my machine...
Removing test_models.cpython-38-pytest-6.1.1.pyc made this error disappear but the fixture was still not found. I had to remove conftest.cpython-38-pytest-6.1.1.pyc.

In this example, those files were generated on my mac, so I understand I should have cleaned that directory.

In my original problem, the tests are always run inside the docker container, but I mount the app directory as a volume. I found some pyc files generated:

$ ls -l conft*
-rw------- 1 csi csi 5357 Nov 27  2018 conftest.cpython-36-PYTEST.pyc
-rw------- 1 csi csi 5612 Aug 22  2019 conftest.cpython-37-PYTEST.pyc
-rw------- 1 csi csi 5761 Feb 26  2020 conftest.cpython-37-pytest-5.1.2.pyc
-rw-r--r-- 1 csi csi 5684 Dec 13  2019 conftest.cpython-37-pytest-5.3.1.pyc
-rw-r--r-- 1 csi csi 5722 Feb 24  2020 conftest.cpython-37-pytest-5.3.5.pyc
-rw-r--r-- 1 csi csi 5722 Oct  5 09:30 conftest.cpython-37-pytest-6.1.1.pyc
-rw-r--r-- 1 csi csi 5781 Sep  9 09:37 conftest.cpython-38-pytest-6.0.1.pyc
-rw-r--r-- 1 csi csi 5742 Oct 12 09:58 conftest.cpython-38-pytest-6.0.2.pyc
-rw-r--r-- 1 csi csi 5742 Oct  2 16:01 conftest.cpython-38-pytest-6.1.0.pyc
-rw-r--r-- 1 csi csi 5742 Oct 13 05:11 conftest.cpython-38-pytest-6.1.1.pyc
-rw-r--r-- 1 csi csi 5781 Oct  5 06:51 conftest.cpython-38-pytest-6.1.1.pyc.save

Moving the conftest.cpython-38-pytest-6.1.1.pyc solved the issue. I know some requirements had changed when I re-run the tests and I think I updated the Python 3.8 version in between. I'm still not sure why I had to remove that file.

0 replies

beenje · 2020-10-13T05:45:03Z

beenje
Oct 13, 2020
Author

I saved the old pyc file. Is there a way to find the differences?

0 replies

beenje · 2020-10-13T07:32:55Z

beenje
Oct 13, 2020
Author

After checking I saw that VS Code is creating that file when discovering the tests. So I guess that's what happened.

You can close this issue. Sorry for the noise.

0 replies

The-Compiler · 2020-10-13T07:58:08Z

The-Compiler
Oct 13, 2020
Maintainer

Hmm, I still wonder how this can happen though! By any chance, can you reproduce when you run pytest --collect-only first, then run pytest normally (with the pyc generated by the first run)?

0 replies

beenje · 2020-10-13T14:03:23Z

beenje
Oct 13, 2020
Author

If I run pytest --collect-only on my mac and then run pytest in the docker container, yes, I can reproduce the issue.
I created this repo https://github.com/beenje/test-pytest-factoryboy and pushed the docker image beenje/test-pytest-factoryboy with the __pycache__ directory that was created locally.

If you pull this image, you can reproduce the problem. Running pytest inside will fail if you don't remove the pyc file:

$ docker run --rm -it beenje/test-pytest-factoryboy bash
dev@34f98d0844d3:/app$ pytest
========================================================================== test session starts ==========================================================================
platform linux -- Python 3.8.6, pytest-6.1.1, py-1.9.0, pluggy-0.13.1
rootdir: /app
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py E                                                                                                                                            [100%]

================================================================================ ERRORS =================================================================================
_________________________________________________________________ ERROR at setup of test_author_factory _________________________________________________________________
file /Users/benjaminbertrand/Dev/web/flask/test-pytest-factoryboy/tests/test_models.py, line 1: source code not available
E       fixture 'author_factory' not found
>       available fixtures: _session_faker, cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, factoryboy_request, faker, monkeypatch, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
>       use 'pytest --fixtures [testpath]' for help on them.

/Users/benjaminbertrand/Dev/web/flask/test-pytest-factoryboy/tests/test_models.py:1
======================================================================== short test summary info ========================================================================
ERROR tests/test_models.py::test_author_factory
=========================================================================== 1 error in 0.05s ============================================================================

0 replies

beenje · 2020-10-15T06:33:28Z

beenje
Oct 15, 2020
Author

To summarise, it seems the full path of the files is used inside the pyc files instead of relative path. This isn't a platform issue. It can easily be reproduced using docker by mounting the same directory in 2 different locations:

$ docker run --rm -it -v $(pwd):/app1 -v $(pwd):/app2 beenje/test-pytest-factoryboy bash
dev@1eef1e791dd8:/app$ cd /app1
dev@1eef1e791dd8:/app1$ rm -rf tests/__pycache__/
dev@1eef1e791dd8:/app1$ pytest
========================================================================== test session starts ==========================================================================
platform linux -- Python 3.8.6, pytest-6.1.1, py-1.9.0, pluggy-0.13.1
rootdir: /app1
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py .                                                                                                                                            [100%]

=========================================================================== 1 passed in 0.11s ===========================================================================
dev@1eef1e791dd8:/app1$ cd /app2
dev@1eef1e791dd8:/app2$ pytest
========================================================================== test session starts ==========================================================================
platform linux -- Python 3.8.6, pytest-6.1.1, py-1.9.0, pluggy-0.13.1
rootdir: /app2
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py E                                                                                                                                            [100%]

================================================================================ ERRORS =================================================================================
_________________________________________________________________ ERROR at setup of test_author_factory _________________________________________________________________
file /app1/tests/test_models.py, line 1
  def test_author_factory(author_factory):
E       fixture 'author_factory' not found
>       available fixtures: _session_faker, cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, factoryboy_request, faker, monkeypatch, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
>       use 'pytest --fixtures [testpath]' for help on them.

/app1/tests/test_models.py:1
======================================================================== short test summary info ========================================================================
ERROR tests/test_models.py::test_author_factory
=========================================================================== 1 error in 0.09s ============================================================================
dev@1eef1e791dd8:/app2$

Same issue with pytest 5 but not with pytest-4.6.11:

dev@1eef1e791dd8:/app1$ pytest
========================================================================== test session starts ==========================================================================
platform linux -- Python 3.8.6, pytest-4.6.11, py-1.9.0, pluggy-0.13.1
rootdir: /app1
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py .                                                                                                                                            [100%]

======================================================================= 1 passed in 0.10 seconds ========================================================================
dev@1eef1e791dd8:/app1$ cd /app2
dev@1eef1e791dd8:/app2$ pytest
========================================================================== test session starts ==========================================================================
platform linux -- Python 3.8.6, pytest-4.6.11, py-1.9.0, pluggy-0.13.1
rootdir: /app2
plugins: Faker-4.9.0, factoryboy-2.0.3
collected 1 item

tests/test_models.py .                                                                                                                                            [100%]

======================================================================= 1 passed in 0.09 seconds ========================================================================

0 replies

The-Compiler · 2020-10-15T09:37:21Z

The-Compiler
Oct 15, 2020
Maintainer

I'm not really familiar with how pytest generates/reads .pyc files as part of its assertion rewriting - maybe someone else can look into this?

0 replies

nicoddemus · 2020-10-17T12:07:21Z

nicoddemus
Oct 17, 2020
Maintainer

We check for the mtime to see if we need to regenerate the .pyc file; because it is the same file in different locations, pytest won't regenerate the .pyc file when executed from the different mount.

This is not pytest specific, Python stores full paths inside .pyc files; often this doesn't matter, but for pytest the file location is important.

I'm not sure there's anything to be done by pytest here. Perhaps we can edit the title and turn this into a discussion for others to find in the future?

0 replies

beenje · 2020-10-18T17:22:34Z

beenje
Oct 18, 2020
Author

I agree. I don't think pytest should try to handle this. It's fine to close this issue. It's more something to be aware.
Feel free to change the title.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Full path in .pyc files causes fixtures not to be found #7890

{{title}}

Replies: 10 comments

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

Select a reply

Full path in .pyc files causes fixtures not to be found #7890

beenje Oct 12, 2020

Replies: 10 comments

The-Compiler Oct 12, 2020 Maintainer

beenje Oct 13, 2020 Author

beenje Oct 13, 2020 Author

beenje Oct 13, 2020 Author

The-Compiler Oct 13, 2020 Maintainer

beenje Oct 13, 2020 Author

beenje Oct 15, 2020 Author

The-Compiler Oct 15, 2020 Maintainer

nicoddemus Oct 17, 2020 Maintainer

beenje Oct 18, 2020 Author

beenje
Oct 12, 2020

The-Compiler
Oct 12, 2020
Maintainer

beenje
Oct 13, 2020
Author

beenje
Oct 13, 2020
Author

beenje
Oct 13, 2020
Author

The-Compiler
Oct 13, 2020
Maintainer

beenje
Oct 13, 2020
Author

beenje
Oct 15, 2020
Author

The-Compiler
Oct 15, 2020
Maintainer

nicoddemus
Oct 17, 2020
Maintainer

beenje
Oct 18, 2020
Author