Computer >> คอมพิวเตอร์ >  >> การเขียนโปรแกรม >> การเขียนโปรแกรม BASH

setV:ฟังก์ชัน Bash เพื่อรักษาสภาพแวดล้อมเสมือนของ Python

เป็นเวลากว่าหนึ่งปีแล้วที่ setV ถูกซ่อนอยู่ภายในโปรเจ็กต์ bash_scripts ของฉัน แต่ถึงเวลาที่มันจะต้องเผยแพร่สู่สาธารณะ setV เป็นฟังก์ชัน Bash ที่ฉันใช้เป็นทางเลือกแทน virtualenvwrapper มีคุณลักษณะพื้นฐานที่ช่วยให้คุณทำสิ่งต่างๆ เช่น:

  • ใช้ Python 3 เป็นค่าเริ่มต้น
  • สร้างสภาพแวดล้อมเสมือนใหม่
  • สร้างสภาพแวดล้อมเสมือนใหม่โดยใช้เส้นทาง Python ที่กำหนดเองด้วย -p (หรือ --python )
  • ลบสภาพแวดล้อมเสมือนที่มีอยู่
  • แสดงรายการสภาพแวดล้อมเสมือนที่มีอยู่ทั้งหมด
  • ใช้การเติมแท็บ (ในกรณีที่คุณจำชื่อสภาพแวดล้อมเสมือนไม่ได้)

การติดตั้ง

ในการติดตั้ง setV ให้ดาวน์โหลดสคริปต์:

curl https://gitlab.com/psachin/setV/raw/master/install.sh

ตรวจสอบสคริปต์แล้วเรียกใช้:

sh ./install.sh

เมื่อคุณติดตั้ง setV สคริปต์การติดตั้งจะขอให้คุณระบุแหล่งที่มา ~/.bashrc หรือ ~/.bash_profile . อย่าลืมทำเช่นนั้น

การใช้งาน

คำสั่งพื้นฐานคือ setv .

สร้างสภาพแวดล้อมเสมือน:

setv --new rango  # setv -n rango

# Or using a custom Python binary path
setv --new --python /opt/python/python3 rango  # setv -n -p /opt/python/python3 rango

เปิดใช้งานสภาพแวดล้อมที่มีอยู่:

setv VIRTUAL_ENVIRONMENT_NAME

# For example
setv rango

แสดงรายการสภาพแวดล้อมเสมือนทั้งหมด:

setv --list
# or
setv [TAB] [TAB]

ลบสภาพแวดล้อมเสมือน:

setv --delete rango

เปลี่ยนไปใช้สภาพแวดล้อมเสมือนอื่น:

# Assuming you are in 'rango', switch to 'tango' using
setv tango

แท็บเสร็จสิ้น

หากคุณจำชื่อสภาพแวดล้อมเสมือนได้ไม่ครบถ้วน การเติมแท็บให้เหมือน Bash นั้นใช้ได้กับชื่อสภาพแวดล้อมเสมือน

มีส่วนร่วม

setV เป็นโอเพ่นซอร์สภายใต้ GNU GPLv3 และยินดีให้ความช่วยเหลือ หากต้องการเรียนรู้เพิ่มเติม ไปที่ส่วนสนับสนุนของ README ของ setV ในที่เก็บ GitLab

สคริปต์ setV

#!/usr/bin/env bash
# setV - A Lightweight Python virtual environment manager.
# Author: Sachin (psachin) <[email protected]>
# Author's URL: https://psachin.gitlab.io/about
#
# License: GNU GPL v3, See LICENSE file
#
# Configure(Optional):
# Set `SETV_VIRTUAL_DIR_PATH` value to your virtual environments
# directory-path. By default it is set to '~/virtualenvs/'
#
# Usage:
# Manual install: Added below line to your .bashrc or any local rc script():
# ---
# source /path/to/virtual.sh
# ---
#
# Now you can 'activate' the virtual environment by typing
# $ setv <YOUR VIRTUAL ENVIRONMENT NAME>
#
# For example:
# $ setv rango
#
# or type:
# setv [TAB] [TAB]  (to list all virtual envs)
#
# To list all your virtual environments:
# $ setv --list
#
# To create new virtual environment:
# $ setv --new new_virtualenv_name
#
# To delete existing virtual environment:
# $ setv --delete existing_virtualenv_name
#
# To deactivate, type:
# $ deactivate

# Path to virtual environment directory
SETV_VIRTUAL_DIR_PATH="$HOME/virtualenvs/"
# Default python version to use. This decides whether to use `virtualenv` or `python3 -m venv`
SETV_PYTHON_VERSION=3  # Defaults to Python3
SETV_PY_PATH=$(which python${SETV_PYTHON_VERSION})

function _setvcomplete_()
{
    # Bash-autocompletion.
    # This ensures Tab-auto-completions work for virtual environment names.
    local cmd="${1##*/}" # to handle command(s).
                         # Not necessary as such. 'setv' is the only command

    local word=${COMP_WORDS[COMP_CWORD]} # Words thats being completed
    local xpat='${word}'                 # Filter pattern. Include
                                         # only words in variable '$names'
    local names=$(ls -l "${SETV_VIRTUAL_DIR_PATH}" | egrep '^d' | awk -F " " '{print $NF}') # Virtual environment names

    COMPREPLY=($(compgen -W "$names" -X "$xpat" -- "$word")) # compgen generates the results
}

function _setv_help_() {
    # Echo help/usage message
    echo "Usage: setv [OPTIONS] [NAME]"
    echo Positional argument:
    echo -e "NAME                       Activate virtual env."
    echo Optional arguments:
    echo -e "-l, --list                 List all Virtual Envs."
    echo -e "-n, --new NAME             Create a new Python Virtual Env."
    echo -e "-d, --delete NAME          Delete existing Python Virtual Env."
    echo -e "-p, --python PATH          Python binary path."
}

function _setv_custom_python_path()
{
    if [ -f "${1}" ];
    then
        if [ "`expr $1 : '.*python\([2,3]\)'`" = "3" ];
        then
            SETV_PYTHON_VERSION=3
        else
            SETV_PYTHON_VERSION=2
        fi
        SETV_PY_PATH=${1}
        _setv_create $2
    else
        echo "Error: Path ${1} does not exist!"
    fi
}

function _setv_create()
{
    # Creates new virtual environment if ran with -n|--new flag
    if [ -z ${1} ];
    then
        echo "You need to pass virtual environment name"
        _setv_help_
    else
        echo "Creating new virtual environment with the name: $1"

        if [ ${SETV_PYTHON_VERSION} -eq 3 ];
        then
            ${SETV_PY_PATH} -m venv ${SETV_VIRTUAL_DIR_PATH}${1}
        else
            virtualenv -p ${SETV_PY_PATH} ${SETV_VIRTUAL_DIR_PATH}${1}
        fi

        echo "You can now activate the Python virtual environment by typing: setv ${1}"
    fi
}

function _setv_delete()
{
    # Deletes virtual environment if ran with -d|--delete flag
    # TODO: Refactor
    if [ -z ${1} ];
    then
        echo "You need to pass virtual environment name"
        _setv_help_
    else
        if [ -d ${SETV_VIRTUAL_DIR_PATH}${1} ];
        then
            read -p "Really delete this virtual environment(Y/N)? " yes_no
            case $yes_no in
                Y|y) rm -rvf ${SETV_VIRTUAL_DIR_PATH}${1};;
                N|n) echo "Leaving the virtual environment as it is.";;
                *) echo "You need to enter either Y/y or N/n"
            esac
        else
            echo "Error: No virtual environment found by the name: ${1}"
        fi
    fi
}

function _setv_list()
{
    # Lists all virtual environments if ran with -l|--list flag
    echo -e "List of virtual environments you have under ${SETV_VIRTUAL_DIR_PATH}:\n"
    for virt in $(ls -l "${SETV_VIRTUAL_DIR_PATH}" | egrep '^d' | awk -F " " '{print $NF}')
    do
        echo ${virt}
    done
}

function setv() {
    # Main function
    if [ $# -eq 0 ];
    then
        _setv_help_
    elif [ $# -le 3 ];
    then
        case "${1}" in
            -n|--new) _setv_create ${2};;
            -d|--delete) _setv_delete ${2};;
            -l|--list) _setv_list;;
            *) if [ -d ${SETV_VIRTUAL_DIR_PATH}${1} ];
               then
                   # Activate the virtual environment
                   source ${SETV_VIRTUAL_DIR_PATH}${1}/bin/activate
               else
                   # Else throw an error message
                   echo "Sorry, you don't have any virtual environment with the name: ${1}"
                   _setv_help_
               fi
               ;;
        esac
    elif [ $# -le 5 ];
    then
        case "${2}" in
            -p|--python) _setv_custom_python_path ${3} ${4};;
            *) _setv_help_;;
        esac
    fi
}

# Calls bash-complete. The compgen command accepts most of the same
# options that complete does but it generates results rather than just
# storing the rules for future use.
complete  -F _setvcomplete_ setv