hatch test from near-empty project?

[odanoburu]

Hello, I just did hatch new hatch_sandbox, created the following two files, and ran hatch test, but got a ModuleNotFoundError.

src/hatch_sandbox/mymodule.py:

x = 4

tests/test_mymodule.py:

import hatch_sandbox.mymodule as m

def test_x():
    assert m.x == 4

$ hatch test
============================= test session starts ==============================
platform linux -- Python 3.12.4, pytest-8.2.2, pluggy-1.5.0
rootdir: /home/user/sites/hatch-sandbox
configfile: pyproject.toml
plugins: mock-3.14.0, rerunfailures-14.0, xdist-3.6.1
collected 0 items / 1 error                                                    

==================================== ERRORS ====================================
___________________ ERROR collecting tests/test_mymodule.py ____________________
ImportError while importing test module '/home/user/sites/hatch-sandbox/tests/test_mymodule.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.12/importlib/__init__.py:90: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests/test_mymodule.py:1: in <module>
    import hatch_sandbox.mymodule as m
E   ModuleNotFoundError: No module named 'hatch_sandbox'
=========================== short test summary info ============================
ERROR tests/test_mymodule.py
!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!
=============================== 1 error in 0.16s ===============================

I expected this to work out-of-the-box. Did I do something wrong? I also cloned and ran hatch test on the https://github.com/ofek/hatch-showcase/ repository, and it worked, but that repo does include some modifications to the pyproject.toml created by hatch new…

[ofek]

can you please try running hatch run hatch-test.py3.12:python -c "import hatch_sandbox"? then if that doesn't work please create the project again in another directory and run that command, it works for me

[ofek]

can you please give me something I can run to reproduce?

[odanoburu]

Sure! I just ran a similar example on a new machine with no previous Python environment (Debian 12). I installed pip and pipx from the Debian repositories (sudo apt-get install python3-pip pipx), then ran pipx install hatch. I then ran the following:

1. hatch new sandbox
2. cd sandbox
3. echo 'def f(): return 4' > src/sandbox/mymodule.py
4. echo -e 'from sandbox.mymodule import f\n\ndef test_x(): assert f() == 4' > tests/test_mymodule.py
5. hatch test

Which gives me a ModuleNotFoundError.

[mstepan]

I have absolutely the same issue running hatch test on a new project. The main problem is that hatch requires src folder to be added to import, like:

from src.your_module import ...

[noiseOnTheNet]

I also have the same issue, hatch version 1.14.0

I'm using this temporary hack now in my test file:

################BAD HACK################
import sys
from pathlib import Path
src = Path(__file__).parents[1] / "src"
sys.path.append(str(src))
################BAD HACK################

[wgmitchener]

Can this be added to the documentation? It's taken me two days of searching to find this thread and finally figure out how to run a trivial test with hatch.

[wgmitchener]

To add to my confusion, I found a collection of demos. The 01b_terminal_helloworld_hatch subdirectory has a hatch-based project, and its test file imports the main package without a src. prefix with no problem. There's even a comment saying that's how it's supposed to work. What makes the difference?