gOdoo-cli 0.1.2__tar.gz → 0.1.4__tar.gz

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/PKG-INFO

@@ -1,8 +1,10 @@
 Metadata-Version: 2.1
 Name: godoo-cli
-Version: 0.1.2
+Version: 0.1.4
 Summary: Wrapper around Odoo-Bin with some convinience RPC functions.
+Home-page: https://github.com/OpenJKSoftware/gOdoo
 License: LGPL-3
+Keywords: odoo,godoo,devcontainer
 Author: Joshua Kreuder
 Author-email: Joshua_Kreuder@outlook.com
 Requires-Python: >=3.8,<3.11
@@ -30,6 +32,7 @@ Requires-Dist: rope (==0.23.0); extra == "devcontainer"
 Requires-Dist: ruamel-yaml (==0.17.21)
 Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
 Requires-Dist: watchdog (==2.1.7); extra == "devcontainer"
+Project-URL: Repository, https://github.com/OpenJKSoftware/gOdoo
 Description-Content-Type: text/markdown
 
 # gOdoo Dev Environment

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/pyproject.toml

@@ -1,11 +1,13 @@
 [tool.poetry]
 name = "gOdoo-cli"
-version = "0.1.2"
+version = "0.1.4"
 description = "Wrapper around Odoo-Bin with some convinience RPC functions."
 authors = ["Joshua Kreuder <Joshua_Kreuder@outlook.com>"]
 license = "LGPL-3"
 readme = "README.md"
 packages = [{include = "godoo_cli",  from = "src"}]
+repository = "https://github.com/OpenJKSoftware/gOdoo"
+keywords = ["odoo", "godoo","devcontainer"]
 
 [tool.poetry_bumpversion.file."src/godoo_cli/__init__.py"]
 
@@ -53,6 +55,9 @@ codequality = [
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
+[tool.pyright]
+ignore="**/__manifest__.py"
+
 [tool.black]
 line-length = 120
 

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/setup.py

@@ -40,14 +40,14 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'godoo-cli',
-    'version': '0.1.2',
+    'version': '0.1.4',
     'description': 'Wrapper around Odoo-Bin with some convinience RPC functions.',
     'long_description': '# gOdoo Dev Environment\n\n![OdooLogo](https://raw.githubusercontent.com/OpenJKSoftware/gOdoo/main/assets/odoo_logo.png)\n![ComposeLogo](https://raw.githubusercontent.com/docker/compose/v2/logo.png)\n\n[<img src="https://raw.githubusercontent.com/OpenJKSoftware/gOdoo/main/assets/godoo-main-cli.png" width="1000"/>](image.png)\n\n**gOdoo** is short for **go Odoo**. \\\nIt is a [Vscode Devcontainer](https://code.visualstudio.com/docs/remote/containers) Environment for [Odoo](https://odoo.com/)\nwith Python CLI `godoo` convenience wrapper around `odoo-bin`.\n\nThis repository is the base source for the Python package [godoo-cli](https://pypi.org/project/godoo-cli/) and serves as\nan all batteries included development environment.\n\nMade Possible by: [WEMPE Elektronic GmbH](https://wetech.de)\n\n# gOdoo-cli\n\nPython package that provides `godoo` command line interface around `odoo-bin`.\n\nIt\'s build with [Typer](https://github.com/tiangolo/typer) to provide some convenience Wrappers for Odoo development and\nDeployment.\n\nMost flags can be configured by Env variables. \\\nUse `godoo --help` to find out more. HINT: Install tab-completion with `godoo --install-completion`\n\n# Docker\n\nThis workspace also contains Docker and Docker-Compose files. \\\n\nThey are used to provide either easy Odoo instances where the source is pulled according to\n[ODOO_MANIFEST.yml](./ODOO_MANIFEST.yml), or as a all batteries included devcontainer for VScode.\n\n## Requirements\n\n- [Docker Compose](https://github.com/docker/compose)\n- [Traefik](https://doc.traefik.io/traefik/) container running with docker provider and "traefik" named docker network.\n  Example: [Traefik Devproxy](https://github.com/joshkreud/traefik_devproxy)\n- SSH Agent running. (check `echo $SSH_AUTH_SOCK`)\\\n  This gets passed trough in the Buildprocess to clone Thirdparty repos.\n\n## Just wanna have a quick and easy Odoo Instance?\n\n```bash\ngit clone https://github.com/OpenJKSoftware/gOdoo\ncd godoo\n. scripts/container_requirements.sh # Check Requirements\ndocker-compose build\ndocker-compose up\n# wait......\n# wait a bit mode ...\n# just a little bit longer ..\n# There we go.\n# Odoo should be reachable on \'https://godoo.docker.localhost\' assuming you didn\'t change .env TRAEFIK_HOST_RULE or COMPOSE_PROJECT_NAME\n```\n\n# Devcontainer\n\n## Features\n\n- All batteries included [Devcontainer](https://code.visualstudio.com/docs/remote/containers) with postgres service\n  Container and local DNS resolvig managed by [Traefik](https://doc.traefik.io/traefik/).\n- Easy fully working Odoo instance by `docker-compose up` with https access.\n- `godoo` CLI wrapper around Odoo. (Most flags can be configured by Environment Variables and are already preconfigured\n  in the Containers. See [.env.sample](./.env.sample))\n- `odoo-bin` is added to PATH and can thus be invoked from every folder.\n- Odoo will run in Proxy_Mode behind a Traefik reverse proxy for easy access on\n  `https://$COMPOSE_PROJECT_NAME.docker.localhost`\n- [Odoo Pylint plugin](https://github.com/OCA/pylint-odoo) preconfigured in vscode\n- Preinstalled vscode Extensions Highlights:\n  - [SQL Tools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) with preconfigured connection for\n    easy Database access in the Sidebar.\n  - [Docker Extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) controls\n    container host.\n  - [Odoo Snippets](https://marketplace.visualstudio.com/items?itemName=mstuttgart.odoo-snippets)\n  - [Odoo Developments](https://marketplace.visualstudio.com/items?itemName=scapigliato.vsc-odoo-development) can Grab\n    Odoo Model information from a running Server\n  - [Todo Tree](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree)\n\n## Usage\n\n1. For Docker on windows: Clone the repo into the WSL2 Filesystem for better IO performance\n2. Have [Traefik](https://github.com/traefik/traefik) Running on `docker.localhost`\n   [Example](https://github.com/joshkreud/traefik_devproxy) \\\n   There must be a Docker network called `traefik` that can reach traefik.\n3. Open Devcontianer:\n   - If you have the Devcontainer CLI: `devcontainer open .`\n   - If not open the workspace in Local Vscode. In the Command pallete search for `Reopen in container`\n4. From **within the container** start Odoo using one of the following commands:\n   - You can enable godoo tab-completion by `godoo --install-completion`\n   - `make` -> Loads Odoo + Workspace Addons\n   - `make bare` -> Loads Odoo with ony `web` installed.\n   - `make enterprise` -> godoo launch with `-i web_enterprise` parameter\n   - `make kill` -> Search for `odoo-bin` processes and kill them\n   - `make reset` -> Drops DB, deletes config file and datafolder\n   - The full init script is available via "`godoo`". (See --help for Options)\n5. Open Odoo `https://$COMPOSE_PROJECT_NAME.docker.localhost`\\\n   For example `COMPOSE_PROJECT_NAME=godoo` --> [https://godoo.docker.localhost](https://godoo.docker.localhost)\n6. Login with `admin:admin`\n7. Profit!\n\n### Access to Odoo and Thirdparty addon Source\n\nYou can access the Odoo source by opening the VsCode workspace [full.code-workspace](full.code-workspace) from within\nthe Container. This will open a [Multi-Root Workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces).\nReally waiting for https://github.com/microsoft/vscode-remote-release/issues/3665 here.\n\n## Reset Devcontainer Data\n\nWhen you screwed up so bad its time to just start Over godoo has you covered:\n\n### Automatic Reset\n\nThere are 3 Options to reset the Dev Env.\n\n1. From **Outside** the Container run `make reset` in the project root to delete docker volumes and restart the\n   container. (Vscode will prompt to reconnect if still open)\n2. From **Outside** the Container run `make reset-hard` in the project root to force rebuild the main Odoo container and\n   then do the same as `make reset`\n3. From **Inside** the Container run `make reset` to drop the DB and delete varlib and the bootstrap flag, which is way\n   quicker than the other options.\n\n### Manual Reset\n\n1. Close vscode\n2. Remove `app` and `db` container from docker.\n3. Remove volumes: `db, odoo_thirdparty, odoo_web, vscode_extensions`\n4. Restart Devcontainer\n\n## Python Debugging\n\n### VsCode Debugging\n\nDebugging doesn\'t reliably work with\n[Odoo Multiprocess](https://www.odoo.com/documentation/14.0/developer/misc/other/cmdline.html#multiprocessing) mode\nenabled. \\\nThe container ships with a Vscode Debug profile, that sets `--workers 0` to allow for Debugging Breakpoints. See [.vscode/launch.json](./.vscode/launch.json)\n\n### Interactive Shell\n\nUse `godoo shell` to enter an interactive shell on the Database.\n\n# Odoo Modules\n\n## Third Party Modules (manifest.yml)\n\nThe `godoo` bootstrap function, will download some modules using git. \\\nWhich Repos to download is specified in `ODOO_MANIFEST.yml` ([Default](./ODOO_MANIFEST.yml)) \\\nNot all of the cloned addons are automatically installed. \\\nInstall them via the Apps Page in Odoo using `godoo rpc modules install` or using `odoo-bin`.\\\nModules downloaded on the Odoo Marketplace can be dropped as a `.zip` archive in [./thirdparty](./thirdparty)\n',
     'author': 'Joshua Kreuder',
     'author_email': 'Joshua_Kreuder@outlook.com',
     'maintainer': 'None',
     'maintainer_email': 'None',
-    'url': 'None',
+    'url': 'https://github.com/OpenJKSoftware/gOdoo',
     'package_dir': package_dir,
     'packages': packages,
     'package_data': package_data,

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/src/godoo_cli/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "0.1.2"
+__version__ = "0.1.4"
 from .cli import launch_cli

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/src/godoo_cli/commands/bootstrap.py

@@ -1,21 +1,64 @@
 import logging
-import os
+import re
 from pathlib import Path
 from typing import List
 
 import typer
 
+from ..helpers import run_cmd
 from ..helpers.cli import typer_retuner, typer_unpacker
-from ..helpers.odoo_files import get_addon_paths, get_odoo_addons_in_folder
+from ..helpers.odoo_files import _get_python_requirements_of_modules, get_addon_paths, get_odoo_module_paths
 from .source_get import get_source
 
 LOGGER = logging.getLogger(__name__)
 
 
+def _install_py_reqs_for_modules(addon_paths: List[Path], module_names: List[str] = None):
+    """Install Python Requirements mentioned in odoo module manifests of given modules
+
+    Parameters
+    ----------
+    addon_paths : List[Path]
+        odoo-bin addons path
+    module_names : List[str], Optional
+        List of modules to filter for, by default "all available modules"
+
+    Returns
+    -------
+    CompletedProcess
+    """
+    py_reqs = _get_python_requirements_of_modules(addon_paths=addon_paths, filter_module_names=module_names)
+    if py_reqs:
+        LOGGER.info("Installing Python requirements: %s", ", ".join(py_reqs))
+        return run_cmd(f"pip install {' '.join(py_reqs)}")
+    LOGGER.debug("No py Requirements to be installed")
+
+
+def _install_py_reqs_by_odoo_cmd(addon_paths: List[Path], odoo_bin_cmd: str):
+    """Install Python reqs for modules mentioned in odoo-bin commandline --init or -i directives.
+
+    Parameters
+    ----------
+    addon_paths : List[Path]
+        odoo-bin addons-path
+    odoo_bin_cmd : str
+        odoo-bin commandline
+
+    Returns
+    -------
+    CompletedProcess
+    """
+    install_modules = []
+    for m in re.finditer(r'(--init|-i) "?([^ \n]+)"?', odoo_bin_cmd):
+        install_modules += m.group(2).split(",")
+    if install_modules:
+        return _install_py_reqs_for_modules(addon_paths=addon_paths, module_names=install_modules)
+
+
 def _boostrap_command(
     odoo_main_path: Path,
     odoo_conf_path: Path,
-    thirdparty_addon_path: Path,
+    addon_paths: List[Path],
     workspace_addon_path: Path,
     db_host: str,
     db_filter: str,
@@ -38,8 +81,8 @@ def _boostrap_command(
         folder with odoo-bin
     odoo_conf_path : Path
         path to odoo.conf
-    thirdparty_addon_path : Path
-        path that contains thirdparty addon repo folders
+    addon_paths : List[Path]
+        odoo bin --addons-path
     workspace_addon_path : Path
         path to addons in dev repo
     db_host : str
@@ -85,8 +128,8 @@ def _boostrap_command(
 
     LOGGER.info("Getting Addon Paths")
 
-    workspace_addons = get_odoo_addons_in_folder(workspace_addon_path)
-    if any(["-i" in i or "--init" in i for i in extra_cmd_args]):
+    workspace_addons = get_odoo_module_paths(workspace_addon_path)
+    if any([re.match(r"( |^)(-i|--init)", i) for i in extra_cmd_args]):
         init_modules = []
     else:
         init_modules = ["base", "web"] if install_base else []
@@ -94,12 +137,6 @@ def _boostrap_command(
             init_modules += [f.name for f in workspace_addons]
     init_cmd = "--init " + ",".join(init_modules) if init_modules else ""
 
-    addon_paths = get_addon_paths(
-        odoo_main_repo=odoo_main_path,
-        workspace_addon_path=workspace_addon_path,
-        zip_addon_path=thirdparty_addon_path / "custom",  # !Todo Pull out into variable
-        thirdparty_addon_path=thirdparty_addon_path,
-    )
     addon_paths = [str(p.absolute()) for p in addon_paths]
     addon_paths = ", ".join(list(filter(None, addon_paths)))
 
@@ -155,11 +192,18 @@ def bootstrap_odoo(
     if update_source:
         get_source(ctx=ctx, remove_unspecified_addons=addons_remove_unspecified)
 
+    addon_paths = get_addon_paths(
+        odoo_main_repo=ctx.obj.odoo_main_path,
+        workspace_addon_path=ctx.obj.workspace_addon_path,
+        zip_addon_path=thirdparty_addon_path / "custom",  # !Todo Pull out into variable
+        thirdparty_addon_path=thirdparty_addon_path,
+    )
+
     cmd_string = _boostrap_command(
         odoo_main_path=ctx.obj.odoo_main_path,
         odoo_conf_path=ctx.obj.odoo_conf_path,
-        thirdparty_addon_path=thirdparty_addon_path,
         workspace_addon_path=ctx.obj.workspace_addon_path,
+        addon_paths=addon_paths,
         db_host=db_host,
         db_name=db_name,
         db_filter=db_filter,
@@ -172,8 +216,12 @@ def bootstrap_odoo(
         multithread_worker_count=multithread_worker_count,
         languages=languages,
     )
-    LOGGER.info('Launching Bootstrap Commandline: "%s"', cmd_string)
-    ret = os.system(cmd_string)
+
+    if update_source:
+        _install_py_reqs_by_odoo_cmd(addon_paths=addon_paths, odoo_bin_cmd=cmd_string)
+
+    LOGGER.info("Launching Bootstrap Commandline")
+    ret = run_cmd(cmd_string).returncode
     if ret == 0:
         ctx.obj.bootstrap_flag_location.touch()
     else:

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/src/godoo_cli/commands/launch.py

@@ -1,5 +1,4 @@
 import logging
-import os
 import threading
 from pathlib import Path
 from typing import List
@@ -7,8 +6,9 @@ from typing import List
 import typer
 
 from ..commands.rpc.cli import rpc_callback
+from ..helpers import run_cmd
 from ..helpers.cli import typer_retuner, typer_unpacker
-from ..helpers.odoo_files import get_odoo_addons_in_folder
+from ..helpers.odoo_files import get_odoo_module_paths
 from .bootstrap import bootstrap_odoo
 from .makedev import makedev_config, makedev_rpc
 from .rpc import import_to_odoo
@@ -38,9 +38,7 @@ def _launch_command(
     upgrade_workspace_modules : bool, optional
         upgrade workspace addons, by default True
     """
-    upgrade_addons = (
-        [f.name for f in get_odoo_addons_in_folder(workspace_addon_path)] if upgrade_workspace_modules else []
-    )
+    upgrade_addons = [f.name for f in get_odoo_module_paths(workspace_addon_path)] if upgrade_workspace_modules else []
     if any(["-u" in i or "--update" in i for i in extra_cmd_args]):
         upgrade_addons = []
     update_addon_string = "--update " + ",".join(upgrade_addons) if upgrade_addons else ""
@@ -54,39 +52,6 @@ def _launch_command(
     return " ".join(odoo_cmd)
 
 
-def _launch(
-    odoo_path: Path,
-    odoo_conf_path: Path,
-    extra_cmd_args: List[str],
-    workspace_addon_path: Path,
-    upgrade_workspace_modules: bool = True,
-):
-    """Launches Odoo
-
-    Parameters
-    ----------
-    odoo_path : Path
-        Path to odoo-bin folder
-    odoo_conf_path : Path
-        Path to odoo.conf
-    extra_cmd_args : List[str]
-        extra args to pass to odoo-bin
-    workspace_addon_path : Path
-        Path to dev workspace addons folder
-    upgrade_workspace_modules : bool, optional
-        upgrade workspace addons, by default True
-    """
-    cmd_string = _launch_command(
-        odoo_path=odoo_path,
-        odoo_conf_path=odoo_conf_path,
-        extra_cmd_args=extra_cmd_args,
-        workspace_addon_path=workspace_addon_path,
-        upgrade_workspace_modules=upgrade_workspace_modules,
-    )
-    LOGGER.info("Launching Odoo: '%s'", cmd_string)
-    return os.system(cmd_string)
-
-
 @typer_unpacker
 def launch_odoo(
     ctx: typer.Context,
@@ -116,20 +81,19 @@ def launch_odoo(
 
     if ctx.obj.odoo_conf_path.exists() and prep_stage:
         makedev_config(ctx)
-
     LOGGER.info("Bootstrap Flag Status: %s", ctx.obj.bootstrap_flag_location.exists())
     bootstraped = False
     ret = ""
     if not ctx.obj.bootstrap_flag_location.exists():
-        extra_odoo_args_bootstrap = extra_odoo_args.copy()
+        _extra_bootstrap_args = extra_odoo_args.copy()
         if ea := extra_bootstrap_args:
-            extra_odoo_args_bootstrap += ea
+            _extra_bootstrap_args += ea
         if not odoo_demo:
-            extra_odoo_args_bootstrap += ["--without-demo all"]
+            _extra_bootstrap_args += ["--without-demo all"]
 
         ret = bootstrap_odoo(
             ctx=ctx,
-            extra_cmd_args=extra_odoo_args_bootstrap,
+            extra_cmd_args=_extra_bootstrap_args,
             install_base=install_modules,
             install_workspace_modules=install_workspace_addons and install_modules,
             multithread_worker_count=multithread_worker_count,
@@ -172,14 +136,15 @@ def launch_odoo(
         )
         loader_thread.start()
 
-    ret = _launch(
+    cmd_string = _launch_command(
         odoo_path=ctx.obj.odoo_main_path,
         odoo_conf_path=ctx.obj.odoo_conf_path,
         extra_cmd_args=extra_odoo_args,
         workspace_addon_path=ctx.obj.workspace_addon_path,
         upgrade_workspace_modules=install_workspace_addons,
     )
-    return typer_retuner(ret)
+    LOGGER.info("Launching Odoo")
+    return typer_retuner(run_cmd(cmd_string).returncode)
 
 
 def launch_cli_app():

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/src/godoo_cli/commands/rpc/translations.py

@@ -6,7 +6,7 @@ import typer
 from godoo_rpc.login import wait_for_odoo
 
 from ...helpers.cli import typer_retuner
-from ...helpers.odoo_files import get_odoo_addons_in_folder
+from ...helpers.odoo_files import get_odoo_module_paths
 from .cli import rpc_callback
 from .modules import rpc_get_modules
 
@@ -71,7 +71,7 @@ def dump_translations(
 ):
 
     addon_path = ctx.obj.workspace_addon_path
-    addon_folders = get_odoo_addons_in_folder(addon_path)
+    addon_folders = get_odoo_module_paths(addon_path)
     valid_module_names = [str(p.stem) for p in addon_folders]
     LOGGER.debug("Found modules:\n%s", "\n".join(["\t" + mn for mn in valid_module_names]))
 

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/src/godoo_cli/commands/shell.py

@@ -1,9 +1,9 @@
 import logging
-import os
 from typing import List
 
 import typer
 
+from ..helpers import run_cmd
 from ..helpers.cli import typer_retuner, typer_unpacker
 
 LOGGER = logging.getLogger(__name__)
@@ -21,7 +21,7 @@ def uninstall_modules(
     uninstall_cmd = f"env['ir.module.module'].search([('name','in',{module_list_str})]).filtered(lambda m: m.state not in ['uninstallable','uninstalled']).button_immediate_uninstall()"
     uninstall_shell = f'echo "{uninstall_cmd}" | {str(ctx.obj.odoo_main_path.absolute())}/odoo-bin shell -c {str(ctx.obj.odoo_conf_path.absolute())} --no-http'
     LOGGER.info("Launching Uninstaller: '%s'", uninstall_shell)
-    ret = os.system(uninstall_shell)
+    ret = run_cmd(uninstall_shell).returncode
     return typer_retuner(ret)
 
 
@@ -39,4 +39,4 @@ def odoo_shell(
     if pipe_in_command:
         shell_cmd = f'echo "{pipe_in_command}" |' + shell_cmd
     LOGGER.debug("Running Command: %s", shell_cmd)
-    os.system(shell_cmd)
+    return typer_retuner(run_cmd(shell_cmd).returncode)

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/src/godoo_cli/commands/test.py

@@ -6,7 +6,7 @@ from typing import List
 import typer
 
 from ..helpers.cli import typer_retuner
-from ..helpers.odoo_files import get_changed_modules, get_depends_of_modules, get_odoo_addons_in_folder
+from ..helpers.odoo_files import get_changed_modules, get_depends_of_modules, get_odoo_module_paths
 from .launch import launch_odoo as launch_odoo
 
 LOGGER = logging.getLogger(__name__)
@@ -17,7 +17,7 @@ def _test_modules_special_cases(in_modules: List[str], workspace_addon_path: Pat
         command = in_modules[0]
         out_modules = []
         if command == "all":
-            out_modules = get_odoo_addons_in_folder(workspace_addon_path)
+            out_modules = get_odoo_module_paths(workspace_addon_path)
 
         if re_match := re.match(r"changes\:(.*)", command):
             compare_branch = re_match.group(1)

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/src/godoo_cli/helpers/__init__.py

@@ -2,6 +2,7 @@
 
 import logging
 import os
+import subprocess
 import sys
 from pathlib import Path
 
@@ -11,6 +12,24 @@ from rich.logging import RichHandler
 LOGGER = logging.getLogger(__name__)
 
 
+def run_cmd(command: str) -> subprocess.CompletedProcess:
+    """Runs command via subprocess
+
+    Parameters
+    ----------
+    command : str
+        _description_
+
+    Returns
+    -------
+    _type_
+        _description_
+    """
+    LOGGER.debug("Launching Commandline: '%s'", command)
+    proc = subprocess.run(command, shell=True)
+    return proc
+
+
 def ensure_dotenv(varname: str) -> str:
     """
     Load Env Var.

{godoo_cli-0.1.2 → godoo_cli-0.1.4}/src/godoo_cli/helpers/odoo_files.py

@@ -2,32 +2,36 @@
 import logging
 from ast import literal_eval
 from pathlib import Path
-from typing import List
+from typing import List, Union
 
 from git import Repo
 
 LOGGER = logging.getLogger(__name__)
 
 
-def get_odoo_addons_in_folder(search_folder: Path) -> List[Path]:
-    """List all Valid odoo module names in the Workspace addon folder.
+def get_odoo_module_paths(search_folders: Union[List[Path], Path]) -> List[Path]:
+    """List all Valid odoo module names in one or many Odoo addons folder.
 
     Parameters
     ----------
-    search_folder : Path
-        Folder to search in.
+    search_folders : Path
+        Folder(s) to search in.
 
     Returns
     -------
     List[Path]
         List of Valid Module Folders within search_folder
     """
+    if not isinstance(search_folders, List):
+        search_folders = [search_folders]
+
     module_paths = []
-    if not search_folder.exists():
-        return
-    for folder in search_folder.iterdir():
-        if folder.is_dir() and any(folder.glob("__manifest__.py")):
-            module_paths.append(folder)
+    for folder in search_folders:
+        if not folder.exists():
+            return
+        for folder in folder.iterdir():
+            if folder.is_dir() and any(folder.glob("__manifest__.py")):
+                module_paths.append(folder)
     return module_paths
 
 
@@ -82,7 +86,7 @@ def get_depends_of_modules(addon_path: Path, in_module_paths: List[Path]) -> Lis
     List[Path]
         Union of in_module_paths and all their downstream depends.
     """
-    all_modules = get_odoo_addons_in_folder(addon_path)
+    all_modules = get_odoo_module_paths(addon_path)
     if not in_module_paths:
         return
     added = True
@@ -130,12 +134,47 @@ def get_addon_paths(
         List of valid addon Paths
     """
     odoo_addon_paths = [odoo_main_repo / "addons"]
-    if get_odoo_addons_in_folder(workspace_addon_path):
+    if get_odoo_module_paths(workspace_addon_path):
         odoo_addon_paths.append(workspace_addon_path)
-    zip_addon_repos = [f for f in zip_addon_path.iterdir() if f.is_dir() and get_odoo_addons_in_folder(f)]
+    zip_addon_repos = [f for f in zip_addon_path.iterdir() if f.is_dir() and get_odoo_module_paths(f)]
     odoo_addon_paths += zip_addon_repos
     git_thirdparty_addon_repos = [
         p for p in thirdparty_addon_path.iterdir() if p.is_dir() and not p.resolve() == zip_addon_path.resolve()
     ]
     odoo_addon_paths += git_thirdparty_addon_repos
     return odoo_addon_paths
+
+
+def _get_python_requirements_of_modules(addon_paths: List[Path], filter_module_names: List[str] = None):
+    """Install python requirements mentioned in module manifests
+
+    Parameters
+    ----------
+    addon_paths : List[Path]
+        Paths to look for addons. (same as odoo-bin)
+    filter_module_names : List[str], optional
+        Modules to look for manifests, by default all available modules
+    """
+    LOGGER.debug("Checking python requirements of Modules: %s", ", ".join(filter_module_names))
+    available_modules = get_odoo_module_paths(addon_paths)
+    available_module_names = [p.stem for p in available_modules]
+    if not filter_module_names:
+        filter_module_names = available_module_names
+    filter_module_names = [f for f in filter_module_names if f not in ["base", "web"]]
+
+    if unavailable_modules := [m for m in filter_module_names if m not in available_module_names]:
+        LOGGER.warning("Couldn't search Python reqs for unavailable Modules: %s", ", ".join(unavailable_modules))
+
+    check_modules = [mp for mp in available_modules if mp.stem in filter_module_names]
+    if not check_modules:
+        LOGGER.debug("No Modules provided to check for python Requirements")
+        return
+    python_depends = []
+    for module_path in check_modules:
+        manifest_path = module_path / "__manifest__.py"
+        LOGGER.debug("Loading Manifest: %s", manifest_path.absolute())
+        manifest = literal_eval(manifest_path.read_text())
+        if module_depends := manifest.get("external_dependencies", {}).get("python"):
+            python_depends += module_depends
+
+    return python_depends