hatchling editable install not importable

[sfoster1]

Hey folks, I'm looking at switching a project to using pyproject.toml and so on from its current setup with nice old setup.py. The critical feature for me is that editable installs of the package work nicely when done with pip install -e.

To test this, I

• ran hatch new hatch-editables (the venv here is because I installed hatch there):

(pep660-venv) me@computer:~/dev/pep660/test-hatch$ hatch new hatch-editables
hatch-editables
├── src
│   └── hatch_editables
│       ├── __about__.py
│       └── __init__.py
├── tests
│   └── __init__.py
├── LICENSE.txt
├── README.md
└── pyproject.toml

• made a new venv with nothing but the defaults and pip 24 and ran pip install -e ./hatch-editables:

me@computer:dev/pep660/test-hatch$ python -m venv ./hatch-editables-venv
me@computer:~/dev/pep660/test-hatch$ . ./hatch-editables-venv/bin/activate
(hatch-editables-venv) me@computer:~/dev/pep660/test-hatch$ pip install --upgrade pip
Requirement already satisfied: pip in ./hatch-editables-venv/lib/python3.10/site-packages (23.0.1)
Collecting pip
  Using cached pip-24.0-py3-none-any.whl (2.1 MB)
Installing collected packages: pip
  Attempting uninstall: pip
    Found existing installation: pip 23.0.1
    Uninstalling pip-23.0.1:
      Successfully uninstalled pip-23.0.1
Successfully installed pip-24.0
(hatch-editables-venv) me@computer:~dev/pep660/test-hatch$ pip install -e ./hatch-editables/
Obtaining file:///home/me/dev/pep660/test-hatch/hatch-editables
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... done
  Preparing editable metadata (pyproject.toml) ... done
Building wheels for collected packages: hatch-editables
  Building editable for hatch-editables (pyproject.toml) ... done
  Created wheel for hatch-editables: filename=hatch_editables-0.0.1-py3-none-any.whl size=2292 sha256=b6be3df086d6061f1404460192af5d1648c32fd3cca3d7976048ecc45f8fc0f1
  Stored in directory: /tmp/pip-ephem-wheel-cache-4ldzfd53/wheels/d3/e5/6e/3816f17e200575df749735a5d700b97903b2b3424bb2eaa10b
Successfully built hatch-editables
Installing collected packages: hatch-editables
Successfully installed hatch-editables-0.0.1

• moved into a different workdir to make sure there was no path confusion, still in the venv

(hatch-editables-venv) me@computer:~/dev/pep660/test-hatch$ mkdir testdir
(hatch-editables-venv) me@computer:~/dev/pep660/test-hatch$ cd testdir

• and then tried to import the editable install and could not:

(hatch-editables-venv) me@computer:~/dev/pep660/test-hatch/testdir$ python
Python 3.10.11 (main, Feb 16 2024, 12:37:53) [GCC 11.4.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import hatch_editables
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'hatch_editables'

Here is the configuration:

[build-system]
requires = ["hatchling==1.21.1"]
build-backend = "hatchling.build"

[project]
name = "hatch-editables"
dynamic = ["version"]
description = ''
readme = "README.md"
requires-python = ">=3.8"
license = "MIT"
keywords = []
authors = [
  { name = "Seth Foster", email = "[email protected]" },
]
classifiers = [
  "Development Status :: 4 - Beta",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3.8",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: Implementation :: CPython",
  "Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = []

[project.urls]
Documentation = "https://github.com/unknown/hatch-editables#readme"
Issues = "https://github.com/unknown/hatch-editables/issues"
Source = "https://github.com/unknown/hatch-editables"

[tool.hatch.version]
path = "src/hatch_editables/__about__.py"

[tool.hatch.envs.default]
dependencies = [
  "coverage[toml]>=6.5",
  "pytest",
]
[tool.hatch.envs.default.scripts]
test = "pytest {args:tests}"
test-cov = "coverage run -m pytest {args:tests}"
cov-report = [
  "- coverage combine",
  "coverage report",
]
cov = [
  "test-cov",
  "cov-report",
]

[[tool.hatch.envs.all.matrix]]
python = ["3.8", "3.9", "3.10", "3.11", "3.12"]

[tool.hatch.envs.types]
dependencies = [
  "mypy>=1.0.0",
]
[tool.hatch.envs.types.scripts]
check = "mypy --install-types --non-interactive {args:src/hatch_editables tests}"

[tool.coverage.run]
source_pkgs = ["hatch_editables", "tests"]
branch = true
parallel = true
omit = [
  "src/hatch_editables/__about__.py",
]

[tool.coverage.paths]
hatch_editables = ["src/hatch_editables", "*/hatch-editables/src/hatch_editables"]
tests = ["tests", "*/hatch-editables/tests"]

[tool.coverage.report]
exclude_lines = [
  "no cov",
  "if __name__ == .__main__.:",
  "if TYPE_CHECKING:",
]

This seems to be because the pth is empty:

(hatch-editables-venv) me@computer:~/dev/pep660/test-hatch$ file ./hatch-editables-venv/lib/python3.10/sit
e-packages/_hatch_editables.pth
./hatch-editables-venv/lib/python3.10/site-packages/_hatch_editables.pth: empty

And oddly enough the direct-url.json has a path that doesn't point to the package:

(hatch-editables-venv) me@computer:~/dev/pep660/test-hatch$ cat ./hatch-editables-venv/lib/python3.10/site
-packages/hatch_editables-0.0.1.dist-info/direct_url.json
{"dir_info": {"editable": true}, "url": "file:///home/me/dev/pep660/test-hatch/hatch-editables"}
``
(would expect it to end in `/src`)

Is there something I'm doing wrong?

[sfoster1]

This is on an ubuntu-22.04 WSL2 VM with cpython 3.10.11, if that helps.

[ofek]

Does this work inside of a Docker image? If not, perhaps you could send me steps to reproduce.

[sfoster1]

This was a good idea, because not only did I try and I couldn't, when I copy-pasted the command string from the docker file it worked fine. One of life's little mysteries, I suppose. Closing this, sorry to bother you!

[ofek]

No worries, better safe than sorry!