12. 虚拟环境和包

12.1. 简介

Python 应用程序通常会使用不属于标准库的包和模块。应用程序有时需要特定版本的库,因为应用程序可能要求修复特定的错误,或者应用程序可能使用该库的过时接口编写。

这意味着一个 Python 安装可能无法满足每个应用程序的要求。如果应用程序 A 需要特定模块的 1.0 版本,而应用程序 B 需要 2.0 版本,则需求会发生冲突,安装 1.0 或 2.0 版本都会导致一个应用程序无法运行。

解决此问题的方法是创建一个 虚拟环境,这是一个自包含的目录树,其中包含特定 Python 版本的 Python 安装以及许多额外的包。

不同的应用程序随后可以使用不同的虚拟环境。为了解决前面冲突需求的示例,应用程序 A 可以有自己的虚拟环境,安装 1.0 版本,而应用程序 B 则有另一个虚拟环境,安装 2.0 版本。如果应用程序 B 需要将库升级到 3.0 版本,这不会影响应用程序 A 的环境。

12.2. 创建虚拟环境

用于创建和管理虚拟环境的模块称为 venvvenv 将安装运行该命令的 Python 版本(由 --version 选项报告)。例如,使用 python3.12 执行该命令将安装 3.12 版本。

要创建虚拟环境,请确定要放置它的目录,并使用目录路径作为脚本运行 venv 模块

python -m venv tutorial-env

如果 tutorial-env 目录不存在,这将创建该目录,并且还会在其中创建包含 Python 解释器副本和各种支持文件的目录。

虚拟环境的常见目录位置是 .venv。此名称通常使该目录在您的 shell 中保持隐藏状态,因此不会妨碍使用,同时为其指定一个解释该目录存在原因的名称。它还可以防止与某些工具支持的 .env 环境变量定义文件发生冲突。

创建虚拟环境后,您可以激活它。

在 Windows 上,运行

tutorial-env\Scripts\activate

在 Unix 或 MacOS 上,运行

source tutorial-env/bin/activate

(此脚本是为 bash shell 编写的。如果您使用 cshfish shell,则应改用备用的 activate.cshactivate.fish 脚本。)

激活虚拟环境会将您的 shell 提示更改为显示您正在使用的虚拟环境,并修改环境,以便运行 python 将使您获得该特定版本和 Python 安装。例如

$ source ~/envs/tutorial-env/bin/activate
(tutorial-env) $ python
Python 3.5.1 (default, May  6 2016, 10:59:36)
  ...
>>> import sys
>>> sys.path
['', '/usr/local/lib/python35.zip', ...,
'~/envs/tutorial-env/lib/python3.5/site-packages']
>>>

要停用虚拟环境,请在终端中键入

deactivate

到终端中。

12.3. 使用 pip 管理包

您可以使用名为 pip 的程序来安装、升级和删除包。默认情况下,pip 将从 Python 包索引安装包。您可以在 Web 浏览器中访问 Python 包索引来浏览它。

pip 有许多子命令:“install”、“uninstall”、“freeze” 等。(请参阅 安装 Python 模块指南,以获取 pip 的完整文档。)

您可以通过指定包的名称来安装最新版本的包

(tutorial-env) $ python -m pip install novas
Collecting novas
  Downloading novas-3.1.1.3.tar.gz (136kB)
Installing collected packages: novas
  Running setup.py install for novas
Successfully installed novas-3.1.1.3

您还可以通过指定包名称,后跟 == 和版本号来安装特定版本的包

(tutorial-env) $ python -m pip install requests==2.6.0
Collecting requests==2.6.0
  Using cached requests-2.6.0-py2.py3-none-any.whl
Installing collected packages: requests
Successfully installed requests-2.6.0

如果您重新运行此命令,pip 将注意到已安装请求的版本,因此不会执行任何操作。您可以提供不同的版本号来获取该版本,或者您可以运行 python -m pip install --upgrade 将包升级到最新版本

(tutorial-env) $ python -m pip install --upgrade requests
Collecting requests
Installing collected packages: requests
  Found existing installation: requests 2.6.0
    Uninstalling requests-2.6.0:
      Successfully uninstalled requests-2.6.0
Successfully installed requests-2.7.0

python -m pip uninstall 后跟一个或多个包名称将从虚拟环境中删除这些包。

python -m pip show 将显示有关特定包的信息

(tutorial-env) $ python -m pip show requests
---
Metadata-Version: 2.0
Name: requests
Version: 2.7.0
Summary: Python HTTP for Humans.
Home-page: http://python-requests.org
Author: Kenneth Reitz
Author-email: [email protected]
License: Apache 2.0
Location: /Users/akuchling/envs/tutorial-env/lib/python3.4/site-packages
Requires:

python -m pip list 将显示虚拟环境中安装的所有包

(tutorial-env) $ python -m pip list
novas (3.1.1.3)
numpy (1.9.2)
pip (7.0.3)
requests (2.7.0)
setuptools (16.0)

python -m pip freeze 将生成已安装包的类似列表,但输出使用 python -m pip install 期望的格式。常见的约定是将此列表放在 requirements.txt 文件中

(tutorial-env) $ python -m pip freeze > requirements.txt
(tutorial-env) $ cat requirements.txt
novas==3.1.1.3
numpy==1.9.2
requests==2.7.0

然后可以将 requirements.txt 提交到版本控制中,并作为应用程序的一部分进行交付。用户随后可以使用 install -r 安装所有必要的包

(tutorial-env) $ python -m pip install -r requirements.txt
Collecting novas==3.1.1.3 (from -r requirements.txt (line 1))
  ...
Collecting numpy==1.9.2 (from -r requirements.txt (line 2))
  ...
Collecting requests==2.7.0 (from -r requirements.txt (line 3))
  ...
Installing collected packages: novas, numpy, requests
  Running setup.py install for novas
Successfully installed novas-3.1.1.3 numpy-1.9.2 requests-2.7.0

pip 还有许多其他选项。请参阅 安装 Python 模块指南,以获取 pip 的完整文档。当您编写了一个包并希望使其在 Python 包索引上可用时,请参阅 Python 打包用户指南