feat(poly env): new command for build backends without support for multiple module roots or hooks (#403)

* feat(poly env): add command for Package & Dependency management tools without support for multiple module roots, or build hooks

* bump PDM brick hook to 1.3.5

* bump PDM workspace hook to 1.3.5

* bump CLI to 1.39.0

* test(environment): rename to environment tests

* fix(environment): add function to brick interface

* fix(poly env): check if any projects before continuing

Author: DavidVujic

bases/polylith/cli/core.py

@@ -2,7 +2,7 @@
 from typing import List, Union
 
 from polylith import commands, configuration, info, repo
-from polylith.cli import build, create, options, test
+from polylith.cli import build, create, env, options, test
 from typer import Exit, Option, Typer
 from typing_extensions import Annotated
 
@@ -15,6 +15,12 @@
     no_args_is_help=True,
 )
 
+app.add_typer(
+    test.app,
+    name="test",
+    help="Commands for tests.",
+    no_args_is_help=True,
+)
 
 app.add_typer(
     build.app,
@@ -24,9 +30,9 @@
 )
 
 app.add_typer(
-    test.app,
-    name="test",
-    help="Commands for tests.",
+    env.app,
+    name="env",
+    help="For Package & Dependency Management tools without support for plugins or build hooks.",
     no_args_is_help=True,
 )
 

bases/polylith/cli/env.py

@@ -0,0 +1,24 @@
+import sysconfig
+from pathlib import Path
+
+from polylith import configuration, environment, info, repo
+from typer import Typer
+
+app = Typer()
+
+
+@app.command("setup")
+def setup_command():
+    """Setup the current virtual environment, by adding the bases and components paths as module root."""
+    root = repo.get_workspace_root(Path.cwd())
+    ns = configuration.get_namespace_from_config(root)
+
+    projects_data = info.get_projects_data(root, ns)
+    dev_project = next((p for p in projects_data if p["type"] == "development"), None)
+
+    if not dev_project:
+        return
+
+    env_dir = Path(sysconfig.get_paths().get("purelib"))
+
+    environment.add_paths(dev_project, env_dir, root)

components/polylith/environment/__init__.py

@@ -0,0 +1,3 @@
+from polylith.environment.core import add_paths, parse_paths
+
+__all__ = ["add_paths", "parse_paths"]

components/polylith/environment/core.py

@@ -0,0 +1,41 @@
+from pathlib import Path
+from typing import Set
+
+from polylith import configuration, toml
+
+
+def paths_from_config(ns: str, data: dict) -> Set[str]:
+    packages = toml.get_project_package_includes(ns, data)
+
+    return {p["from"] for p in packages}
+
+
+def parse_paths(root: Path, theme: str, ns: str, data: dict) -> Set[str]:
+    defaults = {"bases", "components"}
+
+    paths = defaults if theme == "loose" else paths_from_config(ns, data)
+
+    return {(root / p).as_posix() for p in paths}
+
+
+def write_pth_file(target_dir: Path, paths: Set[str]) -> None:
+    filepath = target_dir / "polylith_workspace.pth"
+
+    if filepath.exists():
+        return
+
+    with open(filepath, "w") as f:
+        for p in paths:
+            f.write(f"{p}\n")
+
+
+def add_paths(config_data: dict, target_dir: Path, root: Path) -> None:
+    theme = configuration.get_theme_from_config(root)
+    ns = configuration.get_namespace_from_config(root)
+
+    paths = parse_paths(root, theme, ns, config_data)
+
+    if not paths:
+        return
+
+    write_pth_file(target_dir, paths)

components/polylith/pdm/hooks/workspace.py

@@ -1,38 +1,7 @@
 from pathlib import Path
-from typing import Set
 
-from polylith import configuration, toml
-
-
-def paths_from_config(ns: str, data: dict) -> Set[str]:
-    packages = toml.get_project_package_includes(ns, data)
-
-    return {p["from"] for p in packages}
-
-
-def parse_paths(root: Path, theme: str, ns: str, data: dict) -> Set[str]:
-    defaults = {"bases", "components"}
-
-    paths = defaults if theme == "loose" else paths_from_config(ns, data)
-
-    return {(root / p).as_posix() for p in paths}
-
-
-def write_pth_file(build_dir: Path, paths: Set[str]) -> None:
-    filepath = build_dir / "polylith_workspace.pth"
-
-    with open(filepath, "w") as f:
-        for p in paths:
-            f.write(f"{p}\n")
+from polylith import environment
 
 
 def build_initialize(config_data: dict, build_dir: Path, root: Path) -> None:
-    theme = configuration.get_theme_from_config(root)
-    ns = configuration.get_namespace_from_config(root)
-
-    paths = parse_paths(root, theme, ns, config_data)
-
-    if not paths:
-        return
-
-    write_pth_file(build_dir, paths)
+    environment.add_paths(config_data, build_dir, root)

projects/pdm_polylith_bricks/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pdm-polylith-bricks"
-version = "1.3.4"
+version = "1.3.5"
 description = "a PDM build hook for Polylith"
 authors = ["David Vujic"]
 homepage = "https://davidvujic.github.io/python-polylith-docs/"
@@ -12,6 +12,7 @@ packages = [
     {include = "polylith/pdm_project_hooks", from = "../../bases"},
     {include = "polylith/building",from = "../../components"},
     {include = "polylith/configuration",from = "../../components"},
+    {include = "polylith/environment",from = "../../components"},
     {include = "polylith/parsing",from = "../../components"},
     {include = "polylith/pdm",from = "../../components"},
     {include = "polylith/repo",from = "../../components"},

projects/pdm_polylith_workspace/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pdm-polylith-workspace"
-version = "1.3.4"
+version = "1.3.5"
 description = "a PDM build hook for a Polylith workspace"
 homepage = "https://davidvujic.github.io/python-polylith-docs/"
 repository = "https://github.com/davidvujic/python-polylith"
@@ -11,6 +11,7 @@ readme = "README.md"
 packages = [
     {include = "polylith/pdm_workspace_hooks", from = "../../bases"},
     {include = "polylith/building",from = "../../components"},
+    {include = "polylith/environment",from = "../../components"},
     {include = "polylith/configuration",from = "../../components"},
     {include = "polylith/parsing",from = "../../components"},
     {include = "polylith/pdm",from = "../../components"},

projects/polylith_cli/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "polylith-cli"
-version = "1.38.2"
+version = "1.39.0"
 description = "Python tooling support for the Polylith Architecture"
 authors = ['David Vujic']
 homepage = "https://davidvujic.github.io/python-polylith-docs/"
@@ -21,6 +21,7 @@ packages = [
     { include = "polylith/diff", from = "../../components" },
     { include = "polylith/dirs", from = "../../components" },
     { include = "polylith/distributions", from = "../../components" },
+    { include = "polylith/environment", from = "../../components" },
     { include = "polylith/files", from = "../../components" },
     { include = "polylith/imports", from = "../../components" },
     { include = "polylith/info", from = "../../components" },

pyproject.toml

@@ -23,6 +23,7 @@ packages = [
     { include = "polylith/diff", from = "components" },
     { include = "polylith/dirs", from = "components" },
     { include = "polylith/distributions", from = "components" },
+    { include = "polylith/environment", from = "components" },
     { include = "polylith/files", from = "components" },
     { include = "polylith/hatch", from = "components" },
     { include = "polylith/imports", from = "components" },