Pipenv和Python虚拟环境

Pipenv & 虚拟环境

本教程将引导您完成安装和使用 Python 包。

它将向您展现如何安装和使用必要的工具，并就最佳作法作出强烈推荐。请记住， Python 用于许多不一样的目的。准确地说，您但愿如何管理依赖项可能会根据 您如何决定发布软件而发生变化。这里提供的指导最直接适用于网络服务 （包括 Web 应用程序）的开发和部署，但也很是适合管理任意项目的开发和测试环境。

注解

本指南是针对 Python 3 编写。但若是您因为某种缘由仍然使用 Python 2.7， 这些指引应该可以正常工做。

确保您已经有了 Python 和 pip

在您进一步以前，请确保您有 Python，而且可从您的命令行中得到。 您能够经过简单地运行如下命令来检查：

$ python --version

您应该获得像 3.6.2 之类的一些输出。若是没有 Python，请从 python.org 安装最新的 3.x 版本，或参考本指南的 安装 Python 一节。

注解

若是您是新手，您会获得以下错误：

>>> python Traceback (most recent call last): File "<stdin>", line 1, in <module> NameError: name 'python' is not defined 

这是由于此命令要在 shell*（也称为 *终端 或 控制台）中运行。有关使用操做系统的 shell 并和 Python 进行交互的介绍，请参阅面向 Python 新手的 入门教程。

另外，您须要确保 pip 是可用的。您能够经过运行如下命令来检查：

$ pip --version

若是您使用 python.org 或 Homebrew 的安装程序来安装 Python，您应该已经有 pip 了。 若是您使用的是Linux，并使用操做系统的包管理器进行安装，则可能须要单独 安装 pip。

安装 Pipenv

Pipenv 是 Python 项目的依赖管理器。若是您熟悉 Node.js 的 npm 或 Ruby 的 bundler，那么它们在思路上与这些工具相似。尽管 pip 能够安装 Python 包， 但仍推荐使用 Pipenv，由于它是一种更高级的工具，可简化依赖关系管理的常见使用状况。

使用 pip 来安装 Pipenv：

$ pip install --user pipenv

注解

这进行了 用户安装，以防止破坏任何系统范围的包。若是安装后, shell 中没有pipenv，则须要将 用户基础目录 的 二进制文件目录添加到 PATH 中。

在 Linux 和 macOS 上，您能够经过运行 python -m site --user-base 找到 用户基础目录，而后把 bin 加到目录末尾。好比，上述命令典型地会打印出~/.local``（ ``~ 会扩展为您的家目录的局对路径），而后将 ~/.local/bin 添加到 PATH 中。您能够经过 修改 ~/.profile 永久地设置 PATH。

在 Windows 上，您经过运行 py -m site --user-site 找到用户基础目录，而后 将 site-packages 替换为 Scripts。好比，上述命令可能返回为C:\Users\Username\AppData\Roaming\Python36\site-packages，而后您须要在PATH 中包含 C:\Users\Username\AppData\Roaming\Python36\Scripts。 您能够在 控制面板 中永久设置用户的 PATH。您可能须要登出 PATH 更改才能生效。

为您的项目安装包

Pipenv 管理每一个项目的依赖关系。要安装软件包时，请更改到您的项目目录（或只是本教程中的 一个空目录）并运行：

$ cd myproject
$ pipenv install requests

Pipenv 将在您的项目目录中安装超赞的 Requests 库并为您建立一个 Pipfile。 Pipfile用于跟踪您的项目中须要从新安装的依赖，例如在与他人共享项目时。 您应该获得相似的输出（尽管显示的确切路径会有所不一样）：

Creating a Pipfile for this project...
Creating a virtualenv for this project...
Using base prefix '/usr/local/Cellar/python3/3.6.2/Frameworks/Python.framework/Versions/3.6'
New python executable in ~/.local/share/virtualenvs/tmp-agwWamBd/bin/python3.6
Also creating executable in ~/.local/share/virtualenvs/tmp-agwWamBd/bin/python
Installing setuptools, pip, wheel...done.

Virtualenv location: ~/.local/share/virtualenvs/tmp-agwWamBd
Installing requests...
Collecting requests
  Using cached requests-2.18.4-py2.py3-none-any.whl
Collecting idna<2.7,>=2.5 (from requests)
  Using cached idna-2.6-py2.py3-none-any.whl
Collecting urllib3<1.23,>=1.21.1 (from requests)
  Using cached urllib3-1.22-py2.py3-none-any.whl
Collecting chardet<3.1.0,>=3.0.2 (from requests)
  Using cached chardet-3.0.4-py2.py3-none-any.whl
Collecting certifi>=2017.4.17 (from requests)
  Using cached certifi-2017.7.27.1-py2.py3-none-any.whl
Installing collected packages: idna, urllib3, chardet, certifi, requests
Successfully installed certifi-2017.7.27.1 chardet-3.0.4 idna-2.6 requests-2.18.4 urllib3-1.22

Adding requests to Pipfile's [packages]...
P.S. You have excellent taste! ✨ 🍰 ✨

使用安装好的包

如今安装了 Requests，您能够建立一个简单的 main.py 文件来使用它：

import requests response = requests.get('https://httpbin.org/ip') print('Your IP is {0}'.format(response.json()['origin'])) 

而后您就可使用 pipenv run 运行这段脚本：

$ pipenv run python main.py

您应该获取到相似的输出：

Your IP is 8.8.8.8

使用 $ pipenv run 可确保您的安装包可用于您的脚本。咱们还能够生成一个新的 shell， 确保全部命令均可以使用 $ pipenv shell 访问已安装的包。

下一步

恭喜，您如今知道如何安装和使用Python包了！ ✨ 🍰 ✨

更低层次: virtualenv

virtualenv 是一个建立隔绝的Python环境的 工具。virtualenv建立一个包含全部必要的可执行文件的文件夹，用来使用Python工程所需的包。

它能够独立使用，代替Pipenv。

经过pip安装virtualenv：

$ pip install virtualenv

测试您的安装：

$ virtualenv --version

基本使用

1. 为一个工程建立一个虚拟环境：

$ cd my_project_folder $ virtualenv venv 

virtualenv venv 将会在当前的目录中建立一个文件夹，包含了Python可执行文件， 以及 pip 库的一份拷贝，这样就能安装其余包了。虚拟环境的名字（此例中是 venv ） 能够是任意的；若省略名字将会把文件均放在当前目录。

在任何您运行命令的目录中，这会建立Python的拷贝，并将之放在叫作 venv 的文件中。

您能够选择使用一个Python解释器（好比``python2.7``）：

$ virtualenv -p /usr/bin/python2.7 venv

或者使用``~/.bashrc``的一个环境变量将解释器改成全局性的：

$ export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python2.7 

2. 要开始使用虚拟环境，其须要被激活：

$ source venv/bin/activate 

当前虚拟环境的名字会显示在提示符左侧（好比说 (venv)您的电脑:您的工程 用户名$）以让您知道它是激活的。从如今起，任何您使用pip安装的包将会放在 ``venv 文件夹中， 与全局安装的Python隔绝开。

像日常同样安装包，好比：

$ pip install requests

3. 若是您在虚拟环境中暂时完成了工做，则能够停用它：

$ deactivate

这将会回到系统默认的Python解释器，包括已安装的库也会回到默认的。

要删除一个虚拟环境，只需删除它的文件夹。（要这么作请执行 rm -rf venv ）

而后一段时间后，您可能会有不少个虚拟环境散落在系统各处，您将有可能忘记它们的名字或者位置。

其余注意事项

运行带 --no-site-packages 选项的 virtualenv 将不会包括全局安装的包。 这可用于保持包列表干净，以防之后须要访问它。（这在 virtualenv 1.7及以后是默认行为）

为了保持您的环境的一致性，“冷冻住（freeze）”环境包当前的状态是个好主意。要这么作，请运行：

$ pip freeze > requirements.txt

这将会建立一个 requirements.txt 文件，其中包含了当前环境中全部包及 各自的版本的简单列表。您可使用 pip list 在不产生requirements文件的状况下， 查看已安装包的列表。这将会使另外一个不一样的开发者（或者是您，若是您须要从新建立这样的环境） 在之后安装相同版本的相同包变得容易。

$ pip install -r requirements.txt

这能帮助确保安装、部署和开发者之间的一致性。

最后，记住在源码版本控制中排除掉虚拟环境文件夹，可在ignore的列表中加上它。 （查看 版本控制忽略）

virtualenvwrapper

virtualenvwrapper 提供了一系列命令使得和虚拟环境工做变得愉快许多。它把您全部的虚拟环境都放在一个地方。

安装（确保 virtualenv 已经安装了）：

$ pip install virtualenvwrapper
$ export WORKON_HOME=~/Envs $ source /usr/local/bin/virtualenvwrapper.sh 

(virtualenvwrapper 的完整安装指引.)

对于Windows，您可使用 virtualenvwrapper-win 。

安装（确保 virtualenv 已经安装了）：

$ pip install virtualenvwrapper-win

在Windows中，WORKON_HOME默认的路径是 %USERPROFILE%\Envs 。

基本使用

1. 建立一个虚拟环境：

$ mkvirtualenv my_project

这会在 ~/Envs 中建立 my_project 文件夹。

2. 在虚拟环境上工做：

$ workon my_project

或者，您能够建立一个项目，它会建立虚拟环境，并在 $WORKON_HOME 中建立一个项目目录。 当您使用 workon myproject 时，会 cd 到项目目录中。

$ mkproject myproject

virtualenvwrapper 提供环境名字的tab补全功能。当您有不少环境， 而且很难记住它们的名字时，这就显得颇有用。

workon 也能中止您当前所在的环境，因此您能够在环境之间快速的切换。

3. 中止是同样的：

$ deactivate

4. 删除：

$ rmvirtualenv my_project

其余有用的命令

lsvirtualenv

列举全部的环境。

cdvirtualenv

导航到当前激活的虚拟环境的目录中，好比说这样您就可以浏览它的  site-packages。

cdsitepackages

和上面的相似，可是是直接进入到  site-packages 目录中。

lssitepackages

显示  site-packages 目录中的内容。

virtualenvwrapper 命令的彻底列表 。

virtualenv-burrito

有了 virtualenv-burrito ， 您就能使用单行命令拥有virtualenv + virtualenvwrapper的环境。

autoenv

当您 cd 进入一个包含 .env 的目录中，就会 autoenv 自动激活那个环境。

使用 brew 在Mac OS X上安装它：

$ brew install autoenv

在Linux上:

$ git clone git://github.com/kennethreitz/autoenv.git ~/.autoenv
$ echo 'source ~/.autoenv/activate.sh' >> ~/.bashrc