Function setup_pack_virtualenv

st2common/st2common/util/virtualenvs.py:53–167

Setup virtual environment for the provided pack. :param pack_name: Name of the pack to setup the virtualenv for. :type pack_name: ``str`` :param update: True to update dependencies inside the virtual environment. :type update: ``bool`` :param logger: Optional logger insta

(
    pack_name,
    update=False,
    logger=None,
    include_pip=True,
    include_setuptools=True,
    include_wheel=True,
    proxy_config=None,
    no_download=True,
    force_owner_group=True,
    inject_parent_virtualenv_sites=True,
)

def setup_pack_virtualenv(
    pack_name,
    update=False,
    logger=None,
    include_pip=True,
    include_setuptools=True,
    include_wheel=True,
    proxy_config=None,
    no_download=True,
    force_owner_group=True,
    inject_parent_virtualenv_sites=True,
):

    """
    Setup virtual environment for the provided pack.

    :param pack_name: Name of the pack to setup the virtualenv for.
    :type pack_name: ``str``

    :param update: True to update dependencies inside the virtual environment.
    :type update: ``bool``

    :param logger: Optional logger instance to use. If not provided it defaults to the module
                   level logger.

    :param no_download: Do not download and install latest version of pre-installed packages such
                        as pip and setuptools.
    :type no_download: ``bool``
    """
    logger = logger or LOG

    if not re.match(PACK_REF_WHITELIST_REGEX, pack_name):
        raise ValueError('Invalid pack name "%s"' % (pack_name))

    if pack_name in RESERVED_PACK_LIST:
        raise ValueError(
            f"Pack name {pack_name} is a reserved name, and cannot be used"
        )

    base_virtualenvs_path = os.path.join(cfg.CONF.system.base_path, "virtualenvs/")
    virtualenv_path = os.path.join(base_virtualenvs_path, quote_unix(pack_name))

    # Ensure pack directory exists in one of the search paths
    pack_path = get_pack_directory(pack_name=pack_name)

    logger.debug('Setting up virtualenv for pack "%s" (%s)' % (pack_name, pack_path))

    if not pack_path:
        packs_base_paths = get_packs_base_paths()
        search_paths = ", ".join(packs_base_paths)
        msg = 'Pack "%s" is not installed. Looked in: %s' % (pack_name, search_paths)
        raise Exception(msg)

    # 1. Create virtualenv if it doesn't exist
    if not update or not os.path.exists(virtualenv_path):
        # 0. Delete virtual environment if it exists
        remove_virtualenv(virtualenv_path=virtualenv_path, logger=logger)