From 3e2676f7dcafbec3c8e481e6ebfb2454bd3c232c Mon Sep 17 00:00:00 2001 From: Celestino Gomes Date: Fri, 24 Sep 2021 17:37:09 -0300 Subject: feat(python): add `pyserver` alias to start an HTTP server (#10217) Closes #10217 --- plugins/python/README.md | 20 +++++++++++--------- plugins/python/python.plugin.zsh | 3 +++ 2 files changed, 14 insertions(+), 9 deletions(-) (limited to 'plugins/python') diff --git a/plugins/python/README.md b/plugins/python/README.md index b95ffe679..eeaa1148a 100644 --- a/plugins/python/README.md +++ b/plugins/python/README.md @@ -3,17 +3,19 @@ The plugin adds several aliases for useful [python](https://www.python.org/) commands. To use it, add `python` to the plugins array of your zshrc file: -``` + +```zsh plugins=(... python) ``` ## Aliases -| Command | Description | -|------------------|---------------------------------------------------------------------------------| -| `py` | Runs `python` | -| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv | -| `pyfind` | Finds .py files recursively in the current directory | -| `pyclean [dirs]` | Deletes byte-code and cache files from a list of directories or the current one | -| `pygrep ` | Looks for `text` in .py files | -| `pyuserpaths` | Add --user site-packages to PYTHONPATH, for all installed python versions. | +| Command | Description | +| ---------------- | ------------------------------------------------------------------------------------- | +| `py` | Runs `python` | +| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv | +| `pyfind` | Finds .py files recursively in the current directory | +| `pyclean [dirs]` | Deletes byte-code and cache files from a list of directories or the current one | +| `pygrep ` | Looks for `text` in .py files | +| `pyuserpaths` | Add --user site-packages to PYTHONPATH, for all installed python versions. | +| `pyserver` | Starts an http.server on the current directory. Use `--directory` for a different one | diff --git a/plugins/python/python.plugin.zsh b/plugins/python/python.plugin.zsh index 276eb6f91..896fae3ca 100644 --- a/plugins/python/python.plugin.zsh +++ b/plugins/python/python.plugin.zsh @@ -48,3 +48,6 @@ alias pygrep='grep -nr --include="*.py"' # Run proper IPython regarding current virtualenv (if any) alias ipython="python -c 'import IPython; IPython.terminal.ipapp.launch_new_instance()'" + +# Share local directory as a HTTP server +alias pyserver="python -m http.server" -- cgit v1.2.3-70-g09d2 From 02eb548d5ac41c57d37af6817c77dfbb57a8d281 Mon Sep 17 00:00:00 2001 From: Marijan Smetko Date: Thu, 1 Apr 2021 23:35:00 +0200 Subject: feat(python): add utilities to manage simple virtual environments (#9776) Closes #9776 --- plugins/python/README.md | 9 +++++++++ plugins/python/python.plugin.zsh | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) (limited to 'plugins/python') diff --git a/plugins/python/README.md b/plugins/python/README.md index eeaa1148a..4968cca6d 100644 --- a/plugins/python/README.md +++ b/plugins/python/README.md @@ -10,6 +10,7 @@ plugins=(... python) ## Aliases +<<<<<<< HEAD | Command | Description | | ---------------- | ------------------------------------------------------------------------------------- | | `py` | Runs `python` | @@ -19,3 +20,11 @@ plugins=(... python) | `pygrep ` | Looks for `text` in .py files | | `pyuserpaths` | Add --user site-packages to PYTHONPATH, for all installed python versions. | | `pyserver` | Starts an http.server on the current directory. Use `--directory` for a different one | + +## Virtual environments + +The plugin provides two utilities to manage Python venvs: + +- `mkv [name]`: make a new virtual environment called `name` (default: `venv`) in current directory. + +- `vrun [name]`: activate virtual environment called `name` (default: `venv`) in current directory. diff --git a/plugins/python/python.plugin.zsh b/plugins/python/python.plugin.zsh index 896fae3ca..6c7fc6cbb 100644 --- a/plugins/python/python.plugin.zsh +++ b/plugins/python/python.plugin.zsh @@ -51,3 +51,36 @@ alias ipython="python -c 'import IPython; IPython.terminal.ipapp.launch_new_inst # Share local directory as a HTTP server alias pyserver="python -m http.server" + + +## venv utilities + +# Activate a the python virtual environment specified. +# If none specified, use 'venv'. +function vrun() { + local name="${1:-venv}" + local venvpath="${name:P}" + + if [[ ! -d "$venvpath" ]]; then + echo >&2 "Error: no such venv in current directory: $name" + return 1 + fi + + if [[ ! -f "${venvpath}/bin/activate" ]]; then + echo >&2 "Error: '${name}' is not a proper virtual environment" + return 1 + fi + + . "${venvpath}/bin/activate" || return $? + echo "Activated virtual environment ${name}" +} + +# Create a new virtual environment, with default name 'venv'. +function mkv() { + local name="${1:-venv}" + local venvpath="${name:P}" + + python3 -m venv "${name}" || return + echo >&2 "Created venv in '${venvpath}'" + vrun "${name}" +} -- cgit v1.2.3-70-g09d2 From 9c01dbc30bdfedebb986190309106d01d49f9851 Mon Sep 17 00:00:00 2001 From: vladislav doster Date: Fri, 31 Dec 2021 01:55:01 -0600 Subject: chore(python): minor corrections on README (#10548) Closes #10548 --- plugins/python/README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) (limited to 'plugins/python') diff --git a/plugins/python/README.md b/plugins/python/README.md index 4968cca6d..c1f0adef8 100644 --- a/plugins/python/README.md +++ b/plugins/python/README.md @@ -1,8 +1,8 @@ -# python plugin +# Python plugin -The plugin adds several aliases for useful [python](https://www.python.org/) commands. +The plugin adds several aliases for useful [Python](https://www.python.org/) commands. -To use it, add `python` to the plugins array of your zshrc file: +To use it, add `python` to the plugins array in your zshrc file: ```zsh plugins=(... python) @@ -10,16 +10,15 @@ plugins=(... python) ## Aliases -<<<<<<< HEAD -| Command | Description | -| ---------------- | ------------------------------------------------------------------------------------- | -| `py` | Runs `python` | -| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv | -| `pyfind` | Finds .py files recursively in the current directory | -| `pyclean [dirs]` | Deletes byte-code and cache files from a list of directories or the current one | -| `pygrep ` | Looks for `text` in .py files | -| `pyuserpaths` | Add --user site-packages to PYTHONPATH, for all installed python versions. | -| `pyserver` | Starts an http.server on the current directory. Use `--directory` for a different one | +| Command | Description | +| ---------------- | -------------------------------------------------------------------------------------- | +| `py` | Runs `python` | +| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv | +| `pyfind` | Finds .py files recursively in the current directory | +| `pyclean [dirs]` | Deletes byte-code and cache files from a list of directories or the current one | +| `pygrep ` | Looks for `text` in `*.py` files in the current directory, recursively | +| `pyuserpaths` | Add user site-packages folders to `PYTHONPATH`, for Python 2 and 3 | +| `pyserver` | Starts an HTTP server on the current directory (use `--directory` for a different one) | ## Virtual environments -- cgit v1.2.3-70-g09d2 From 78c91ccbf99c77bd4d9cdb74279a40776721f66d Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Fri, 31 Dec 2021 20:45:12 +0100 Subject: style(python): fix code style and some hidden bugs --- plugins/python/python.plugin.zsh | 53 +++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 28 deletions(-) (limited to 'plugins/python') diff --git a/plugins/python/python.plugin.zsh b/plugins/python/python.plugin.zsh index 6c7fc6cbb..7a73ab92a 100644 --- a/plugins/python/python.plugin.zsh +++ b/plugins/python/python.plugin.zsh @@ -7,40 +7,37 @@ alias pyfind='find . -name "*.py"' # Remove python compiled byte-code and mypy/pytest cache in either the current # directory or in a list of specified directories (including sub directories). function pyclean() { - ZSH_PYCLEAN_PLACES=${*:-'.'} - find ${ZSH_PYCLEAN_PLACES} -type f -name "*.py[co]" -delete - find ${ZSH_PYCLEAN_PLACES} -type d -name "__pycache__" -delete - find ${ZSH_PYCLEAN_PLACES} -depth -type d -name ".mypy_cache" -exec rm -r "{}" + - find ${ZSH_PYCLEAN_PLACES} -depth -type d -name ".pytest_cache" -exec rm -r "{}" + + find "${@:-.}" -type f -name "*.py[co]" -delete + find "${@:-.}" -type d -name "__pycache__" -delete + find "${@:-.}" -depth -type d -name ".mypy_cache" -exec rm -r "{}" + + find "${@:-.}" -depth -type d -name ".pytest_cache" -exec rm -r "{}" + } # Add the user installed site-packages paths to PYTHONPATH, only if the # directory exists. Also preserve the current PYTHONPATH value. # Feel free to autorun this when .zshrc loads. function pyuserpaths() { - local targets=("python2" "python3") # bins - - # Get existing interpreters. - local interps=() - for target in $targets; do - [ `command -v $target` ] && interps+=($target) - done - - # Check for a non-standard install directory. - local user_base="${HOME}/.local" - [ $PYTHONUSERBASE ] && user_base=$PYTHONUSERBASE - - # Add version specific paths, if: - # it exists in the filesystem; - # it isn't in PYTHONPATH already. - for interp in $interps; do - # Get minor release version. - local ver=`$interp -V 2>&1` - ver=`echo ${ver:7} | cut -d '.' -f 1,2` # The patch version is variable length, truncate it. - - local site_pkgs="${user_base}/lib/python${ver}/site-packages" - [[ -d $site_pkgs && ! $PYTHONPATH =~ $site_pkgs ]] && export PYTHONPATH=${site_pkgs}:$PYTHONPATH - done + setopt localoptions extendedglob + + # Check for a non-standard install directory. + local user_base="${PYTHONUSERBASE:-"${HOME}/.local"}" + + local python version site_pkgs + for python in python2 python3; do + # Check if command exists + (( ${+commands[$python]} )) || continue + + # Get minor release version. + # The patch version is variable length, truncate it. + version=${(M)${"$($python -V 2>&1)":7}#[^.]##.[^.]##} + + # Add version specific path, if: + # - it exists in the filesystem + # - it isn't in $PYTHONPATH already. + site_pkgs="${user_base}/lib/python${version}/site-packages" + [[ -d "$site_pkgs" && ! "$PYTHONPATH" =~ (^|:)"$site_pkgs"(:|$) ]] || continue + export PYTHONPATH="${site_pkgs}${PYTHONPATH+":${PYTHONPATH}"}" + done } # Grep among .py files -- cgit v1.2.3-70-g09d2