Josix is Only Joking

建立一個方便開發的 Python 環境(二)- 使用 pipx 管理基於 Python 的 Command-Line 工具

October 05, 2020

為什麼要使用 pipx

上一篇文章中有提到,pip 有幾點使用時需要注意的地方,其中有包含 「安裝套件時一定要使用虛擬環境」、「永遠不要使用 sudo pip install」、「不要將套件安裝至全域」,針對這三點,非常合理的照做就會是自己創建一個獨立的虛擬環境,並且 activate 該虛擬環境或直接使用虛擬環境 bin/ 中的指令來安裝自己想要的工具,最後再將該安裝完成的執行檔加入到 PATH 環境變數中。舉例來說,想要安裝一個 commandline 使用的 pipenv 工具並不會直接使用 pip3 install pipenv 來進行安裝,而是輸入下列的指令:

mkdir -p ~/.local/bin ~/.local/venvs
python3 -m venv ~/.local/venvs/pipenv
~/.local/venvs/pipenv/bin/pip install pipenv
ln -s ~/.local/venvs/pipenv/bin/pipenv ~/.local/bin

(擷取自:這樣的開發環境沒問題嗎? — TP@PyConTW’18)

而 Flask 的作者大大 Armin Ronacher 也製作了 pipsi(現已不維護) 來將上面所進行的工具打包起來提供使用者更好的使用體驗,受此影響 pipx 也跟著被 Chad Smith 大大創造出來,並且包含了相似於 npx 的功能,讓使用者可以安裝使用該套件並隨後刪除。

這讓 pipx 有著以下的主要特色:

  • 基於 pip 同樣也有 listupgradeuninstall 套件的功能。
  • 可以在安裝套件時為每個套件建出一個分離的環境,並可以在不啟動虛擬環境的情況下直接使用。
  • 使用 pipx run 可以在暫時的虛擬環境中執行最新版的套件功能。
  • 另外,所有指令都不會需要 root 權限,一切都在使用者權限下進行。

完美解決了上述提到的所以要注意的地方。

pipx 基本使用方式

使用 brew install pipx 安裝 pipx (macOS)

首先需要確認系統支援 Python 3.6+ 和 pip

接者只需要輸入下方指令別可以使用 Homebrew 安裝 pipx:

brew install pipx
pipx ensurepath

pipx 也可以使用 pip 安裝,至於安裝 pipx 建議還是使用虛擬環境,使用 Python 的 venv 模組先建出虛擬環境再用其中的 pip 安裝,這樣確保系統的 pip 完全乾淨。

預設的虛擬環境位置會開設在 ~/.local/pipx/venvs 下,而預設的 binary 執行檔會在 ~/.local/bin 下,分別可以由 PIPX_HOMEPIPX_BIN_DIR 環境變數來覆寫成放置在 $PIPX_HOME/venvs$PIPX_BIN_DIR/bin

pipx ensurepath 作用為確認 pipx 所下載的 app 其執行檔位置有被加入至 PATH 環境變數中,若沒有則會加進去

使用 pipx completions 顯示自動補全設定指示

輸入 pipx completions 後將會輸出:

Add the appropriate command to your shell's config file
so that it is run on startup. You will likely have to restart
or re-login for the autocompletion to start working.

bash:
    eval "$(register-python-argcomplete pipx)"

zsh:
    To activate completions for zsh you need to have
    bashcompinit enabled in zsh:

    autoload -U bashcompinit
    bashcompinit

    Afterwards you can enable completion for pipx:

    eval "$(register-python-argcomplete pipx)"

tcsh:
    eval `register-python-argcomplete --shell tcsh pipx`

fish:
    register-python-argcomplete --shell fish pipx | source

有對於不同 shell 給予不同的指示,遵循其操作便可以讓 pipx 可以自動補全。以 zsh 舉例,只需要將

autoload -U bashcompinit
bashcompinit
eval "$(register-python-argcomplete pipx)"

加入至 .zshrc 就可以在 shell 中讓 pipx 可以按 tab 自動補全。

使用 pipx install <package_spec> 安裝套件

當使用 pipx install <package_spec> 後, pipx 會為要安裝的套件開啟一個虛擬環境,並且將該套件安裝到裡面,再為其執行檔複製或建立一個 sympolic link 到 $PIPX_BIN_DIR/bin 下,供使用者直接調用。

<package_spec> 並不限定是套件名稱只要是符合 pip 安裝規範(pip installation spec)的都可以,如 VCS_URL, ZIP_FILE, TAR_GZ_FILE 都是可以的,使用範例如下:

pipx install pycowsay
pipx install --python python3.6 pycowsay
pipx install --python python3.7 pycowsay
pipx install git+https://github.com/psf/black
pipx install git+https://github.com/psf/black.git@branch-name
pipx install git+https://github.com/psf/black.git@git-hash
pipx install https://github.com/psf/black/archive/18.9b0.zip
pipx install black[d]

其中可以發現有 --python 這個選項是用於要開啟虛擬環境的 Python 版本,其限定必須是 Python3.5 以上。

其他常見的選項還有 --force -f 用於安裝時允許修改已經存在的虛擬環境及已安裝的檔案, --editable -e 用於使用可編輯模式(editable mode)安裝,讓你可以在開發套件同時可以直接在環境下使用開發中的版本。

安裝完套件之後將可以發現有幾個目錄依照預設會出現在 ~/.local/pipx 或覆寫的 $PIPX_HOME 路經當中:

  • shared: shared 為 pipx 在執行安裝套件之前建立之前,預設會透過 python -m venv --clear shared 會建立的第一個虛擬環境,其中包含了供後續安裝其他套件共用的 pip, wheel, setuptools,建立過一次之後每次安裝套件都會檢查是否可用,並且會隔特定時間(30 天)升級更新,可參照 venv.__init__(), shared_libs.needs_upgrade
  • venvs: venvs 中會包含每個套件所屬的虛擬環境,預設會以套件名稱作為虛擬環境的名稱,並且也可以透過加入 --suffix 加入後綴至環境預設的名稱。虛擬環境中將安裝所需要使用的相依套件及執行檔,除了 pip 會是透過在虛擬環境中寫入的 pipx_shared.pth 路徑設定檔共用 shared 環境中的 pip
  • .cache: 為 pipx run 指令使用,於 pipx run 段落中會再做說明,由於是在使用 pipx 時便會建立的,因此這個資料夾下的內容在還沒使用 pipx run 指令時都會是空的。

使用 pipx uninstall <package> 解除安裝套件

解除安裝只需要輸入 pipx uninstall <package> 來解除安裝給定的套件,例如 pipx uninstall pycowsay 將會解除安裝 pycowsay 並且也會一併將其所屬的虛擬環境刪除,也將 $PIPX_BIN_DIR/bin 下的 symbolic link 解除。

使用 pipx upgrade <package> 升級安裝的套件

當想要升級安裝的套件只需要輸入 pipx upgrade <package> 升級該套件,例如 pipx upgrade Commitizen 將會升級 commitizen 的版本,並且也可透過加入 --force -f 選項允許修改虛擬環境及已安裝的檔案。

除了 pipx uninstallpipx upgrade 用於單一套件以外,pipx 另外提供了 pipx uninstall-allpipx upgrade-all 作用於所有已安裝的套件。

使用 pipx list 列出已安裝的套件

使用 pipx list 可以列出已經安裝的套件,其中會列出 $PIPX_HOME/venvs$PIPX_BIN_DIR/bin 設定的位置、目前安裝的套件、其版本以及可以使用的指令有哪寫,以安裝 Commitizen 後的 pipx list 輸出如下:

venvs are in /Users/wilson/.local/pipx/venvs
apps are exposed on your $PATH at /Users/wilson/.local/bin
   package Commitizen 2.4.1, Python 3.8.5
    - cz
    - git-cz

使用 pipx run <app> 直接執行該套件指令

當不想要長時期安裝該套件,並希望短時間內可以使用該套件的最新版本,可以使用 pipx run <app> [...] 來執行該套件提供的功能,舉例來說若想要使用 pipenv install 但不希望長期安裝 pipenv,可以透過 pipx run pipenv install 來達成目的。

使用 pipx run 時 pipx 將會於 $PIPX_HOME/.cache 中開啟一個暫時的虛擬環境並使用 sharedpip 安裝該套件,接著直接執行該虛擬環境中 bin/ 下的執行檔,並且將要執行的子指令或參數帶入。

此暫時的虛擬環境會存在 14 天,方便在下次執行時因為保留虛擬環境可以跳過了下載階段而執行比較快,若超過 14 天則會在下次執行 pipx run 時將該虛擬環境刪除並重新安裝新版執行。

pipx 怎麼運作

pipx install 的執行內容

  1. 首次在 pipx 接收到 pipx installpipx run 指令後,會先建立一個 shared 的虛擬環境,後續都會使用該虛擬環境的 pip 來安裝指定的套件,並共用其中的 pip, wheel, setuptools
  2. 會確認是否該更新 shared 環境中的套件至最新的版本。
  3. 接著會再建立該套件所屬的虛擬環境,除了 pip 是使用 shared 的虛擬環境以外,其他都會是獨立的。
  4. 安裝該套件至虛擬環境中。
  5. 安裝完畢後會在建立 symbolic link 到 $PIPX_BIN_DIR/bin 下。
  6. 接著因為 ensurepah 有將 $PIPX_BIN_DIR/bin 加到 $PATH 中所以可以在全域下使用。

pipx run 的執行內容

  1. 同樣會重複 pipx 的第一步建立或使用 shared 中的環境。
  2. 建立一個透過 hash 命名的暫時虛擬環境。
  3. 安裝該套件至虛擬環境中。
  4. 直接調用該虛擬環境下 bin 的執行檔。

資料來源


Hi, I'm Josix 興趣是沒事把玩各式各樣的 FOSS ,喜愛專研技術、參與社群交流,有著各種天馬行空的 Idea 想去實現

Josix Wang © 2021