utils

_init_venv_v1(*, path, python_version=None, logger_name) async

Set a virtual environment at path/venv

Parameters:

Name	Type	Description	Default
path		Path path to directory in which to set up the virtual environment	required
python_version		default=None Python version the virtual environment will be based upon	None

Returns:

Name	Type	Description
python_bin	Path	Path path to python interpreter

Source code in fractal_server/tasks/v1/utils.py

async def _init_venv_v1(
    *,
    path: Path,
    python_version: Optional[str] = None,
    logger_name: str,
) -> Path:
    """
    Set a virtual environment at `path/venv`

    Args:
        path : Path
            path to directory in which to set up the virtual environment
        python_version : default=None
            Python version the virtual environment will be based upon

    Returns:
        python_bin : Path
            path to python interpreter
    """
    logger = get_logger(logger_name)
    logger.debug(f"[_init_venv] {path=}")
    interpreter = get_python_interpreter_v1(version=python_version)
    logger.debug(f"[_init_venv] {interpreter=}")
    await execute_command_async(
        cwd=path,
        command=f"{interpreter} -m venv venv",
        logger_name=logger_name,
    )
    python_bin = path / "venv/bin/python"
    logger.debug(f"[_init_venv] {python_bin=}")
    return python_bin

get_python_interpreter_v1(version=None)

Return the path to the python interpreter

Parameters:

Name	Type	Description	Default
version	Optional[str]	Python version	None

Raises:

Type	Description
ValueError	If the python version requested is not available on the host.

Returns:

Name	Type	Description
interpreter	str	string representing the python executable or its path

Source code in fractal_server/tasks/v1/utils.py

def get_python_interpreter_v1(version: Optional[str] = None) -> str:
    """
    Return the path to the python interpreter

    Args:
        version: Python version

    Raises:
        ValueError: If the python version requested is not available on the
                    host.

    Returns:
        interpreter: string representing the python executable or its path
    """
    import shutil
    import sys

    if version:
        interpreter = shutil.which(f"python{version}")
        if not interpreter:
            raise ValueError(
                f"Python version {version} not available on host."
            )
    else:
        interpreter = sys.executable

    return interpreter