First try at accommodating "modern" editable python packages (#52)

* First try at accomidating "modern" editable python packages

* `ruff` fixes

* Python 3.8 fixes for `glob.glob`

* Fix for the Python 3.8 fix

* `catch` TypeError when finding editable packages

* Better `_find_editable_deps_files` thanks to @cjdoris

* Fix up `ruff` complaints

* revert version

* update changelog

* tweak deps.py

* update readme

* add test

* move package out of src to force the particular installation method we are testing

---------

Co-authored-by: Christopher Doris <github.com/cjdoris>

Author: dingraha

.github/workflows/tests.yml

@@ -27,8 +27,8 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install ruff pytest pytest-cov
-          pip install -e .
+          pip install ruff pytest pytest-cov 
+          pip install -e . -e test/juliapkg_test_editable_setuptools
       - name: Lint with ruff
         run: |
           ruff format --check

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## Unreleased
+* Support editable dependencies from setuptools (experimental).
+
 ## v0.1.17 (2025-05-13)
 * Respect `JULIAUP_DEPOT_PATH` when searching for Julia using juliaup.
 * Add special handling of `<=python` version for OpenSSL compatibility between Julia and Python.

README.md

@@ -104,7 +104,7 @@ More strategies may be added in a future release.
 
 JuliaPkg looks for `juliapkg.json` files in many locations, namely:
 - `{project}/pyjuliapkg` where project is as above (depending on your environment).
-- Every directory and direct sub-directory in `sys.path`.
+- Every installed package (looks through `sys.path` and `sys.meta_path`).
 
 The last point means that if you put a `juliapkg.json` file in a package, then install that
 package, then JuliaPkg will find those dependencies and install them.

pyproject.toml

@@ -25,7 +25,10 @@ build-backend = "hatchling.build"
 select = ["E", "W", "F", "I"]
 
 [tool.uv]
-dev-dependencies = ["pytest", "pre-commit"]
+dev-dependencies = ["pytest", "pre-commit", "juliapkg_test_editable_setuptools"]
+
+[tool.uv.sources]
+juliapkg_test_editable_setuptools = { path = "test/juliapkg_test_editable_setuptools", editable = true }
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/juliapkg"]

src/juliapkg/deps.py

@@ -169,6 +169,26 @@ def can_skip_resolve():
     return deps
 
 
+def editable_deps_files():
+    """Finds setuptools-style editable dependencies."""
+    ans = []
+    for finder in sys.meta_path:
+        module_name = finder.__module__
+        if module_name.startswith("__editable___") and module_name.endswith("_finder"):
+            m = sys.modules[module_name]
+            paths = m.MAPPING.values()
+            for path in paths:
+                if not os.path.isdir(path):
+                    continue
+                fn = os.path.join(path, "juliapkg.json")
+                ans.append(fn)
+                for subdir in os.listdir(path):
+                    fn = os.path.join(path, subdir, "juliapkg.json")
+                    ans.append(fn)
+
+    return ans
+
+
 def deps_files():
     ans = []
     # the default deps file
@@ -184,6 +204,9 @@ def deps_files():
         for subdir in os.listdir(path):
             fn = os.path.join(path, subdir, "juliapkg.json")
             ans.append(fn)
+
+    ans += editable_deps_files()
+
     return list(
         set(
             os.path.normcase(os.path.normpath(os.path.abspath(fn)))

test/juliapkg_test_editable_setuptools/juliapkg_test_editable_setuptools/__init__.py

@@ -0,0 +1,3 @@
+"""Test package for editable installs with juliapkg.json."""
+
+__version__ = "0.1.0"

test/juliapkg_test_editable_setuptools/juliapkg_test_editable_setuptools/juliapkg.json

@@ -0,0 +1,8 @@
+{
+  "julia": "1.6",
+  "packages": {
+    "Example": {
+      "uuid": "7876af07-990d-54b4-ab0e-23690620f79a"
+    }
+  }
+}

test/juliapkg_test_editable_setuptools/pyproject.toml

@@ -0,0 +1,14 @@
+[build-system]
+requires = ["setuptools>=42"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "juliapkg_test_editable_setuptools"
+version = "0.1.0"
+description = "Test package for editable installs with juliapkg.json"
+authors = [{name = "Test User", email = "[email protected]"}]
+requires-python = ">=3.7"
+
+[tool.setuptools]
+packages = ["juliapkg_test_editable_setuptools"]
+package-data = { "juliapkg_test_editable_setuptools" = ["juliapkg.json"] }

test/test_all.py

@@ -112,3 +112,15 @@ def deps():
         juliapkg.rm("Example1", target=tdir)
 
         assert deps() == {"packages": {"Example2": {"uuid": "0002"}}}
+
+
+def test_editable_setuptools():
+    # test that editable deps files are found for setuptools packages
+    fn = os.path.join(
+        os.path.dirname(__file__),
+        "juliapkg_test_editable_setuptools",
+        "juliapkg_test_editable_setuptools",
+        "juliapkg.json",
+    )
+    assert os.path.exists(fn)
+    assert any(os.path.samefile(fn, x) for x in juliapkg.deps.deps_files())