Add the ability to package addons by name and path

Author: vincent-hatakeyama

src/hatch_odoo/build_hook.py

@@ -26,22 +26,21 @@ def initialize(self, version: str, build_data: Dict[str, Any]) -> None:
         hatch_odoo_config = load_hatch_odoo_config(self.root)
         if version == "standard":
             force_include = build_data["force_include"]
-            for addon_dir in iter_addon_dirs(
+            for addon_dir, addon_name in iter_addon_dirs(
                 self.root,
                 hatch_odoo_config,
                 # We force-include addons that are installable False to avoid that the
                 # default hatch behaviour adds them at the wrong place in the wheel.
                 allow_not_installable=True,
             ):
-                addon_name = addon_dir.name
                 force_include[addon_dir] = f"odoo/addons/{addon_name}"
         elif version == "editable" and self.config.get("editable_symlinks", True):
             editable_path = Path(self.root) / "build" / "__editable_odoo_addons__"
             if editable_path.is_dir():
                 shutil.rmtree(editable_path)
             editable_odoo_addons_path = editable_path / "odoo" / "addons"
             has_editable_symlinks = False
-            for addon_dir in iter_addon_dirs(
+            for addon_dir, addon_name in iter_addon_dirs(
                 self.root,
                 hatch_odoo_config,
                 allow_not_installable=False,
@@ -50,7 +49,6 @@ def initialize(self, version: str, build_data: Dict[str, Any]) -> None:
                 if not has_editable_symlinks:
                     editable_odoo_addons_path.mkdir(parents=True)
                     has_editable_symlinks = True
-                addon_name = addon_dir.name
                 editable_addon_path = editable_odoo_addons_path / addon_name
                 editable_addon_path.symlink_to(addon_dir)
             # Add .pth to build/__editable_odoo_addons__ in wheel.

src/hatch_odoo/config.py

@@ -4,7 +4,7 @@
 
 import sys
 from pathlib import Path
-from typing import Iterator
+from typing import Iterator, Tuple
 
 if sys.version_info < (3, 11):
     import tomli as tomllib
@@ -40,8 +40,22 @@ def iter_addon_dirs(
     root: str,
     config: dict,
     allow_not_installable: bool,
-) -> Iterator[Path]:
-    for addons_dir in iter_addons_dirs(root, config):
-        for addon_dir in addons_dir.iterdir():
-            if is_addon_dir(addon_dir, allow_not_installable=allow_not_installable):
-                yield addon_dir
+) -> Iterator[Tuple[Path, str]]:
+    addon_dirs = config.get("addon_dirs")
+    if addon_dirs:
+        with open("/tmp/log", "w") as log:
+            for addon_name in addon_dirs:
+                log.write(f"addon name = {addon_name}\n")
+                addon_dir_path = Path(root, addon_dirs[addon_name])
+                if is_addon_dir(
+                    addon_dir_path, allow_not_installable=allow_not_installable
+                ):
+                    log.write("is an addon\n")
+                    yield addon_dir_path, addon_name
+                else:
+                    log.write("NOT AN addon\n")
+    else:
+        for addons_dir in iter_addons_dirs(root, config):
+            for addon_dir in addons_dir.iterdir():
+                if is_addon_dir(addon_dir, allow_not_installable=allow_not_installable):
+                    yield addon_dir, addon_dir.name

src/hatch_odoo/metadata_hook.py

@@ -29,16 +29,15 @@ def _get_odooo_addons_dependencies(self) -> List[str]:
             )
         )
         depends_override = hatch_odoo_config.get("depends_override", {})
-        for addon_dir in addon_dirs:
-            addon_name = addon_dir.name
+        for addon_dir, addon_name in addon_dirs:
             # Do not add dependencies on addons that are in the project.
             depends_override[addon_name] = None
         options = dict(
             hatch_odoo_config,
             depends_override=depends_override,
             post_version_strategy_override=POST_VERSION_STRATEGY_NONE,
         )
-        for addon_dir in addon_dirs:
+        for addon_dir, _ in addon_dirs:
             try:
                 addon_metadata = metadata_from_addon_dir(addon_dir, options)
             except Exception as e:

tests/data/project7/README.md

@@ -0,0 +1,5 @@
+# project7
+
+A basic project where the root directory is an odoo addon.
+
+This layout can be used when using whool is not possible.

tests/data/project7/__init__.py

@@ -0,0 +1,7 @@
+{
+    "name": "a",
+    "depends": ["mis-builder"],
+    "external_dependencies": {
+        "python": ["wrapt"],
+    },
+}

tests/data/project7/__manifest__.py

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["hatchling", "hatch-odoo"]
+build-backend = "hatchling.build"
+
+[project]
+name = "project7"
+version = "1.0"
+readme = "README.md"
+dynamic = ["dependencies"]
+
+[tool.hatch.metadata.hooks.odoo-addons-dependencies]
+
+[tool.hatch.build.hooks.odoo-addons-dirs]
+
+[tool.hatch-odoo]
+odoo_version_override = "15.0"
+dependencies = ["click-odoo-contrib"]
+
+[tool.hatch-odoo.addon_dirs]
+project7 = "."

tests/data/project7/pyproject.toml

@@ -1,31 +1,35 @@
 # SPDX-FileCopyrightText: 2022-present Stéphane Bidoul <stephane.bidoul@acsone.eu>
 # SPDX-FileCopyrightText: 2022-present ACSONE <https://acsone.eu>
+# SPDX-FileCopyrightText: 2025-present XCG SAS <https://orbeet.io>
 #
 # SPDX-License-Identifier: MIT
 
 import subprocess
 import sys
 import zipfile
 from pathlib import Path
+from typing import Tuple
 
 import pytest
 
 
 @pytest.mark.parametrize(
-    "project, addons_only",
+    "project, addons_only, addon_names",
     [
-        ("project1", False),
-        ("project2", False),
-        ("project3", False),
-        ("project4", False),
-        ("project5", False),
-        ("project6", True),
+        ("project1", False, ("addona", "addonb", "addon_uninstallable")),
+        ("project2", False, ("addona", "addonb", "addon_uninstallable")),
+        ("project3", False, ("addona", "addonb", "addon_uninstallable")),
+        ("project4", False, ("addona", "addonb", "addon_uninstallable")),
+        ("project5", False, ("addona", "addonb", "addon_uninstallable")),
+        ("project6", True, ("addona", "addonb", "addon_uninstallable")),
+        ("project7", True, ("project7",)),
     ],
 )
 @pytest.mark.parametrize("build_via_sdist", [True, False])
 def test_build(
     project: str,
     addons_only: bool,
+    addon_names: Tuple[str],
     build_via_sdist: bool,
     data_path: Path,
     tmp_path: Path,
@@ -48,7 +52,7 @@ def test_build(
     wheel_file = next(tmp_path.glob(f"{project}-*.whl"))
     with zipfile.ZipFile(wheel_file) as zip_file:
         files = set(zip_file.namelist())
-        for addon_name in ("addona", "addonb", "addon_uninstallable"):
+        for addon_name in addon_names:
             assert f"odoo/addons/{addon_name}/__init__.py" in files
             assert f"odoo/addons/{addon_name}/__manifest__.py" in files
         assert addons_only or f"{project}/__init__.py" in files

tests/test_build.py

@@ -1,5 +1,6 @@
 # SPDX-FileCopyrightText: 2022-present Stéphane Bidoul <stephane.bidoul@acsone.eu>
 # SPDX-FileCopyrightText: 2022-present ACSONE <https://acsone.eu>
+# SPDX-FileCopyrightText: 2025-present XCG SAS <https://orbeet.io>
 #
 # SPDX-License-Identifier: MIT
 
@@ -19,19 +20,21 @@
 
 
 @pytest.mark.parametrize(
-    "project_name,expected_editable_pth_lines",
+    "project_name,expected_editable_pth_lines,expected_editable_addon_names",
     [
-        ("project1", ["src"]),
-        ("project2", ["src", "build/__editable_odoo_addons__"]),
-        ("project3", [""]),
-        ("project4", ["src", "addons_group1", "addons_group2"]),
-        ("project5", ["", "build/__editable_odoo_addons__"]),
-        ("project6", ["build/__editable_odoo_addons__"]),
+        ("project1", ["src"], ["addona", "addonb"]),
+        ("project2", ["src", "build/__editable_odoo_addons__"], ["addona", "addonb"]),
+        ("project3", [""], ["addona", "addonb"]),
+        ("project4", ["src", "addons_group1", "addons_group2"], ["addona", "addonb"]),
+        ("project5", ["", "build/__editable_odoo_addons__"], ["addona", "addonb"]),
+        ("project6", ["build/__editable_odoo_addons__"], ["addona", "addonb"]),
+        ("project7", ["build/__editable_odoo_addons__"], ["project7"]),
     ],
 )
 def test_odoo_addons_dependencies(
     project_name: str,
     expected_editable_pth_lines: List[str],
+    expected_editable_addon_names: List[str],
     data_path: Path,
     tmp_path: Path,
 ) -> None:
@@ -64,7 +67,6 @@ def test_odoo_addons_dependencies(
         str(data_path / project_name / line) for line in expected_editable_pth_lines
     }
     # Check all addons are in the editable paths.
-    expected_editable_addon_names = ["addona", "addonb"]
     editable_addon_names = []
     for pth_line in pth_lines:
         addons_dir = Path(pth_line) / "odoo" / "addons"

tests/test_editable.py

@@ -12,7 +12,15 @@
 
 @pytest.mark.parametrize(
     "project_name",
-    ["project1", "project2", "project3", "project4", "project5", "project6"],
+    [
+        "project1",
+        "project2",
+        "project3",
+        "project4",
+        "project5",
+        "project6",
+        "project7",
+    ],
 )
 def test_odoo_addons_dependencies(
     project_name: str, data_path: Path, tmp_path: Path