Source code for woom.ext

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Woom extensions management
"""

import importlib
import os
import sys




def import_from_path(module_name, file_path):
    """Importing a python source file directly

    Source: https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly
    """
    spec = importlib.util.spec_from_file_location(module_name, file_path)
    module = importlib.util.module_from_spec(spec)
    sys.modules[module_name] = module
    spec.loader.exec_module(module)
    return module





def load_extensions(workflow_dir):
    """Load woom extensions

    Extensions are python files situated in the :file:`ext/`
    sub-directory of the workflow directory:

    * :file:`jinja_filters.py`: :mod:`jinja` filters.
    * :file:`validator_functions.py`: :mod:`configobj.validate` functions.

    Parameters
    ----------
    workflow_dir: str
        Workflow directory

    Returns
    -------
    list(str)
        The list of loaded extensions

    """
    ext_dir = os.path.join(workflow_dir, "ext")
    exts = []
    if not os.path.exists(ext_dir):
        return exts

    # Jinja filters
    jinja_ext = os.path.join(ext_dir, "jinja_filters.py")
    if os.path.exists(jinja_ext):
        label = load_jinja_filters(jinja_ext)
        if label:
            exts.append(label)

    # Validator functions
    vf_ext = os.path.join(ext_dir, "validator_functions.py")
    if os.path.exists(vf_ext):
        label = load_validator_functions(vf_ext)
        if label:
            exts.append(label)

    # Artifacts generators
    ag_ext = os.path.join(ext_dir, "artifacts_generators.py")
    if os.path.exists(ag_ext):
        label = load_artifacts_generators(ag_ext)
        if label:
            exts.append(label)

    return exts





def load_jinja_filters(jinja_ext):
    """Load the jinja filters from a python file

    Parameters
    ----------
    jinja_ext: str
        Python file with the :attr:`JINJA_FILTERS` attribute

    Return
    ------
    str
    """
    mm = import_from_path("woom.ext.jinja_filters", jinja_ext)
    if hasattr(mm, "JINJA_FILTERS"):
        from .render import JINJA_ENV

        JINJA_ENV.filters.update(mm.JINJA_FILTERS)
        return "jinja_filters"





def load_validator_functions(vf_ext):
    """Load the validator functions from a python file

    Parameters
    ----------
    vf_ext: str
        Python file with the :attr:`VALIDATOR_FUNCTIONS` attribute

    Return
    ------
    str
    """
    mm = import_from_path("woom.ext.validator_functions", vf_ext)
    if hasattr(mm, "VALIDATOR_FUNCTIONS"):
        from .conf import VALIDATOR_FUNCTIONS

        VALIDATOR_FUNCTIONS.update(mm.VALIDATOR_FUNCTIONS)
        return "validator_functions"





def load_artifacts_generators(ag_ext):
    """Load the generator function of artifact paths from a python file

    Parameters
    ----------
    ag_ext: str
        Python file with the :attr:`ARTIFACTS_GENERATORS` attribute

    Return
    ------
    str
    """
    mm = import_from_path("woom.ext.artifacts_generators", ag_ext)
    if hasattr(mm, "ARTIFACTS_GENERATORS"):
        from .tasks import ARTIFACTS_GENERATORS

        ARTIFACTS_GENERATORS.update(mm.ARTIFACTS_GENERATORS)
        return "artifacts_generators"