teroshdl/src/nopy/python_tools.js

Backend for terosHDL IDE

// Copyright 2021
// Carlos Alberto Ruiz Naranjo, Ismael Pérez Rojo,
// Alfredo Enrique Sáez Pérez de la Lastra
//
// This file is part of TerosHDL.
//
// TerosHDL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// TerosHDL is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with TerosHDL.  If not, see <https://www.gnu.org/licenses/>.

async function check_python(python_path) {
    let complete_python_path = await get_complete_python_path(python_path);

    let result = {
        'python_path': complete_python_path,
        'python_directories': await get_python_directories(python_path),
        'vunit': await check_vunit(python_path),
        'edalize': await check_edalize(python_path),
        'vsg': await check_vsg(python_path),
        'cocotb': await check_cocotb(python_path),
        'yowasp_yosys': await check_yowasp_yosys(python_path),
        'make': await check_make(),
    };
    return result;
}

async function get_python_directories(python_path) {
    let python_exec = await get_python_exec(python_path);
    let command = `${python_exec} -c "import sys; print( ','.join(sys.path)[1:] )"`;
    let result_command = await _exec_command(command);
    if (result_command.error === 0) {
        return result_command.stdout.trim();
    } else {
        return '';
    }
}

async function get_complete_python_path(python_path) {
    let python_exec = await get_python_exec(python_path);
    let command = `${python_exec} -c "import sys; print(sys.executable)"`;
    let result_command = await _exec_command(command);
    if (result_command.error === 0) {
        return result_command.stdout.trim();
    } else {
        return '';
    }
}

async function check_make() {
    let check = await check_if_program_exist('make --help');
    return check;
}

async function check_if_program_exist(command) {
    let result_command = await _exec_command(command);
    if (result_command.error === 0) {
        return true;
    } else {
        return false;
    }
}

async function check_vunit(python_path) {
    let check = check_python_package(python_path, 'vunit');
    return check;
}

async function check_vsg(python_path) {
    let check = check_python_package(python_path, 'vsg');
    return check;
}

async function check_edalize(python_path) {
    let check = check_python_package(python_path, 'edalize');
    return check;
}

async function check_cocotb(python_path) {
    let check = check_python_package(python_path, 'cocotb');
    return check;
}

async function check_yowasp_yosys(python_path) {
    let check = check_python_package(python_path, 'yowasp_yosys');
    return check;
}

async function check_python_package(python_path, python_package) {
    let python_exec = await get_python_exec(python_path);
    // eslint-disable-next-line max-len
    let command = `${python_exec} -c "import ${python_package}; exit(0)"`;
    let result_command = await _exec_command(command);
    if (result_command.error === 0) {
        return true;
    } else {
        return false;
    }
}

async function get_python_exec(python_path) {
    if (python_path === undefined) {
        python_path = '';
    }
    // python_path = python_path.replace(/ /g, '\\ ');
    // Check custom python3 path
    if (python_path !== '') {
        python_path = `${python_path}`;
        let python_path_check = await check_custom_python_path(python_path);
        return python_path_check;
    }

    //Check system python3 path with binary python3
    let binary = 'python3';
    let python_path_check = await check_custom_python_path(binary);
    if (python_path_check !== '') {
        return python_path_check;
    }

    //Check system python3 path with binary python
    binary = 'python';
    python_path_check = await check_custom_python_path(binary);
    return python_path_check;
}

async function check_custom_python_path(python_path) {
    // eslint-disable-next-line max-len
    let command = `${python_path} -c "import sys; check_version = sys.version_info > (3,0); exit(0) if check_version == True else exit(-1)"`;
    let result_command = await _exec_command(command);
    if (result_command.error === 0) {
        return python_path;
    } else {
        return "";
    }
}

async function _exec_command(command) {
    const exec = require("child_process").exec;
    return new Promise((resolve) => {
        exec(command, (error, stdout, stderr) => {
            let error_code = 0;
            if (error !== undefined && error !== null) {
                error_code = -1;
            }
            let result = { error: error_code, stdout: stdout, stderr: stderr };
            resolve(result);
        });
    });
}

async function exec_python_script(python3_path, python_script_path) {
    let python_path = await get_python_exec(python3_path);
    let command = `${python_path} ${python_script_path}`;
    let result = await _exec_command(command);
    result.cmd = command;
    return result;
}

module.exports = {
    check_python,
    check_vunit,
    check_vsg,
    check_cocotb,
    get_python_exec,
    exec_python_script,
};