################################################################################
#
# NAME
-# lf-activate-venv [-p|--python python] [--no-path]
+# lf-activate-venv [-p|--python python] [-v|--venv-file] [--no-path]
# [--system-site-packages] [package]...
#
# SYNOPSIS
# or
# lf-activate-venv --python python3.8 git-review
#
+# lf-activate-venv --python python3.8 --venv-file /tmp/.myvenv git-review
+#
# DESCRIPTION
# This function will create a new Python Virtual Environment (venv) and
# install the specified packages in the new venv. The venv will be installed
# to the PATH.
#
# The 'lf_venv' variable will be set so you can directly execute commands
-# in the venv with: $lf_venv/bin/command. Beware that subsequent calls to
-# lf-activate-venv() will overwrite 'lf_venv'.
+# in the venv with: $lf_venv/bin/command. lf-activate-venv() will check for
+# existing file '/tmp/.os_lf_venv' and set 'lf_venv' if the file exists.
+#
+# The function provides a --venv-file path for saving the value of the 'lf_env'
+# that can re-used later. By default '/tmp/.os_lf_venv' venv file is created
+# when the --venv-file option is not specified.
+#
+# Subsequent calls to lf-activate-venv() will re-use the existing venv
+# throught and will NOT overwrite 'lf_venv', if the '/tmp/.os_lf_venv'
+# already exists.
+#
+# If a new venv is required delete the file '/tmp/.os_lf_venv' before
+# calling lf-activate-venv() will create a fresh venv.
#
# By default all packages are installed with '--upgrade-strategy eager'.
# The venv will always contain pip & virtualenv.
lf-activate-venv () {
lf_venv=$(mktemp -d /tmp/venv-XXXX)
+ local venv_file="/tmp/.os_lf_venv"
local python=python3
local options
local set_path=true
local install_args=""
- options=$(getopt -o 'n:p:' -l 'no-path,python:,system-site-packages' \
+ # set -x
+ options=$(getopt -o 'np:v:' -l 'no-path,system-site-packages,python:,venv-file:' \
-n "${FUNCNAME[0]}" -- "$@" )
eval set -- "$options"
while true; do
case $1 in
-n|--no-path) set_path=false ; shift ;;
- -p|--python) python=$2 ; shift 2 ;;
+ -p|--python) python="$2" ; shift 2 ;;
+ -v|--venv-file) venv_file="$2" ; shift 2 ;;
--system-site-packages) install_args="--system-site-packages" ;
shift ;;
--) shift; break ;;
return 1 ;;
esac
done
- if ! type "$python" > /dev/null; then
- lf-echo-stderr "${FUNCNAME[0]}(): ERROR: Unknown Python: $python"
- return 1
- fi
-
- echo "${FUNCNAME[0]}(): INFO: Creating $python venv at $lf_venv"
case $python in
python2*)
;;
python3*)
local pkg_list=""
+ # Use pyenv for selecting the python version
+ if [[ -d "/opt/pyenv" ]]; then
+ echo "Setup pyenv:"
+ export PYENV_ROOT="/opt/pyenv"
+ export PATH="$PYENV_ROOT/bin:$PATH"
+ pyenv versions
+ if command -v pyenv 1>/dev/null 2>&1; then
+ eval "$(pyenv init - --no-rehash)"
+ # shellcheck disable=SC2046
+ pyenv local $(lf-pyver "${python}")
+ fi
+ fi
+
# Add version specifier for some packages
for arg in "$@"; do
case $arg in
*) pkg_list+="$arg " ;;
esac
done
- $python -m venv "$install_args" "$lf_venv" || return 1
- "$lf_venv/bin/pip" install --upgrade --quiet pip virtualenv || return 1
+
+ # Precedence:
+ # - Re-use venv:
+ # 1. --venv-file <path/to/file> as lf_venv
+ # 2. default: "/tmp/.os_lf_venv"
+ # - Create new venv when 1. and 2. is absent
+ if [[ -f "$venv_file" ]]; then
+ lf_venv=$(cat "$venv_file")
+ echo "${FUNCNAME[0]}(): INFO: Reuse venv:$lf_venv from" \
+ "file:$venv_file"
+ elif [[ ! -f "$venv_file" ]]; then
+ if [[ -n "$install_args" ]]; then
+ $python -m venv "$install_args" "$lf_venv" || return 1
+ else
+ $python -m venv "$lf_venv" || return 1
+ fi
+ echo "${FUNCNAME[0]}(): INFO: Creating $python venv at $lf_venv"
+ echo "$lf_venv" > "$venv_file"
+ echo "${FUNCNAME[0]}(): INFO: Save venv in file: $venv_file"
+ fi
+
+ "$lf_venv/bin/python3" -m pip install --upgrade --quiet pip \
+ virtualenv || return 1
if [[ -z $pkg_list ]]; then
echo "${FUNCNAME[0]}(): WARNING: No packages to install"
- return 0
+ else
+ echo "${FUNCNAME[0]}(): INFO: Installing: $pkg_list"
+ # $pkg_list is expected to be unquoted
+ # shellcheck disable=SC2086
+ "$lf_venv/bin/python3" -m pip install --upgrade --quiet \
+ --upgrade-strategy eager $pkg_list || return 1
fi
- echo "${FUNCNAME[0]}(): INFO: Installing: $pkg_list"
- # $pkg_list is expected to be unquoted
- # shellcheck disable=SC2086
- "$lf_venv/bin/pip" install --upgrade --quiet --upgrade-strategy eager \
- $pkg_list || return 1
;;
*)
lf-echo-stderr "${FUNCNAME[0]}(): ERROR: No support for: $python"
return 1
;;
esac
+
+ if ! type "$python" > /dev/null; then
+ lf-echo-stderr "${FUNCNAME[0]}(): ERROR: Unknown Python: $python"
+ return 1
+ fi
+
if $set_path; then
echo "${FUNCNAME[0]}(): INFO: Adding $lf_venv/bin to PATH"
PATH=$lf_venv/bin:$PATH
-Dmaven.repo.local=/tmp/r \
-Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r"
}
+
+################################################################################
+#
+# NAME
+# lf-pyver [python-version X.Y]
+#
+# SYNOPSIS
+# pyver 3.8 (outputs 3.8.13)
+# or
+# pyver 3.10 (outputs 3.10.6)
+# or
+# pyver 3 (outputs the most recent version 3.10.6)
+#
+# DESCRIPTION
+# The function takes short python version in the format and X.Y and prints
+# the semver format (X.Y.Z) of the version that has been installed on the system
+# with pyenv.
+#
+# When the expected version is not installed, nothing is returned.
+#
+# RETURN VALUES
+# OK: 0
+# Fail: 1
+#
+################################################################################
+
+lf-pyver() {
+ local py_version_xy="${1:-python3}"
+ local py_version_xyz=""
+
+ pyenv versions | sed 's/^[ *]* //' | awk '{ print $1 }' | grep -E '^[0-9.]*[0-9]$' \
+ > "/tmp/.pyenv_versions"
+ if [[ ! -s "/tmp/.pyenv_versions" ]]; then
+ lf-echo-stderr "${FUNCNAME[0]}(): ERROR: pyenv not available"
+ return 1
+ fi
+
+ # strip out any prefix for (ex: 'python3.8' or 'v3.8') and match regex
+ # to the output return by pyenv
+ py_version_xyz=$(grep "^${py_version_xy//[a-zA-Z]/}" "/tmp/.pyenv_versions" |
+ sort -V | tail -n 1;)
+ if [[ -z ${py_version_xyz} ]]; then
+ lf-echo-stderr "${FUNCNAME[0]}(): ERROR: Not installed on host: ${py_version_xy}"
+ return 1
+ fi
+ echo "${py_version_xyz}"
+ return 0
+}
Code Review / releng / global-jjb.git / blobdiff