Source code for pyquickhelper.pycode.insetup_helper

"""
Function to use inside setup.py


:githublink:`%|py|5`
"""
import os
import sys

from .. loghelper import run_cmd


def must_build(argv=None):
    """
    Determines if the module must be built before running the command
    in *argv*.

    :param      argv:        if None, default to sys.argv
    :return:                 boolean

    *built* means calling ``setup.py build_ext --inplace``.


    :githublink:`%|py|20`
    """
    if argv is None:
        argv = sys.argv  # pragma: no cover
    for k in {'unittests', 'unittests_LONG', 'unittests_SKIP',
              'unittests_GUI', 'build_sphinx'}:
        if k in argv:
            return True
    return False


def run_build_ext(setup_file):
    """
    Runs ``setup.py build_ext --inplace``.

    :param      setup_file:      setup_file
    :return:                     output


    :githublink:`%|py|36`
    """
    exe = sys.executable
    setup = os.path.normpath(os.path.join(os.path.abspath(
        os.path.dirname(setup_file)), "setup.py"))
    cmd = "{0} -u {1} build_ext --inplace".format(exe, setup)
    chd = os.path.abspath(os.path.dirname(setup_file))
    out, err = run_cmd(cmd, wait=True, change_path=chd)
    err0 = _filter_out_warning(err)
    if len(err0) > 0:
        mes0 = "\n".join("### " + _ for _ in err.split("\n"))
        mes = "Unable to run '{2}'\nin '{3}'\nCMD: '{0}'\n[pyqerror]\n{1}".format(
            cmd, mes0, setup_file, chd)
        raise RuntimeError(mes)
    return out


def _filter_out_warning(out):
    """
    Filters out (import) warnings from error.

    :param      out:     string
    :return:             filtered string


    :githublink:`%|py|58`
    """
    lines = out.split("\n")
    new_lines = []
    skip = False
    for line in lines:
        if len(line) == 0:
            skip = True
        elif line[0] != " ":
            skip = "ImportWarning" in line or "warning D9002: option '-std=c++11'" in line
            skip = skip or "RuntimeWarning: Config variable 'Py_DEBUG'" in line
            skip = skip or "RuntimeWarning: Config variable 'WITH_PYMALLOC'" in line
            skip = skip or "UserWarning: Unbuilt egg for Unknown" in line
            skip = skip or "pkg_resources.working_set.add" in line
            for mod in ['pyquickhelper', 'nbconvert', 'six']:
                skip = skip or "UserWarning: Module {} was already imported".format(
                    mod) in line
        if not skip:
            new_lines.append(line)  # pragma: no cover
    return "\n".join(new_lines)