[python]pip换源详解

[python]pip换源详解

前言

‍

现有的各个网站上的pip换源方式，很零散，或者是很单调的重复，又或者只是给出命令，尽管这通常就够用了。

但是，我希望汇总一下，然后再结合pip的官方文档来做一些补充。

因为，换源是一个很基础的操作，很多操作，久了不用的话，也很容易忘，所以总结一下，也是很有意义的。

目前本文章仅仅涉及Windows​环境下的操作，暂未包括其他系统下的换源操作。

‍

---

‍

目录

‍

‍

---

‍

了解pip配置文件

‍

配置文件

‍

• ​global​：系统范围的配置文件，在用户之间共享
• ​user​：每个用户的配置文件
• ​site​：每个环境的配置文件，i.e. per-virtualenv​

‍

---

‍

对应级别的配置文件在对应的系统的所在路径

‍

Windows：

‍

• ​Global​

  • 在Windows 7 及以上版本：（隐藏但可写）C:\ProgramData\pip\pip.ini​
  • Windows Vista：不支持全局配置
  • Windows XP：C:\Documents and Settings\All Users\Application Data\pip\pip.ini​

• ​User​（笔者试验后只有此文件）

  • ​%APPDATA%\pip\pip.ini​
  • ​C:\Users\Administrator\AppData\Roaming\pip\pip.ini​
  • 还会加载旧版“每个用户”的配置文件（如果存在）：%HOME%\pip\pip.ini​

• ​Site​

  • ​%VIRTUAL_ENV%\pip.ini​

• ​PIP_CONFIG_FILE​

  • 环境变量可以指定最后加载的配置文件，其值将覆盖上述文件中设置的值。
  • 在os.devnull​中设置它，可以禁用所有的配置文件，如果设置的位置已经存在该文件，用户的配置文件不会被加载

‍

---

‍

配置文件加载顺序

‍

如果pip找到多个配置文件，pip会按照下面的次序加载它们：

‍

• Global
• User
• Site
• ​PIP_CONFIG_FILE​, 如果存在该文件

‍

每次加载配置文件，都会覆盖从之前加载的文件中读取的任何值，例如，在全局（global）设置中和用户（User）设置中，如果都设置了timeout​的数值，那么pip会使用后者（User）的值。

‍

---

命令选项配置

‍

配置文件内的命名都派生于命令行长选项。

比如，如果你想使用一个不同的包索引--index-url​，并且将HTTP​超时设置为60秒--default-timeout​，那么你的配置文件将如下所示：

‍

[global]
timeout = 60
index-url = https://download.zope.org/ppix

‍

每个子命令都可以在其自己的部分中选择配置，而这将会覆盖具有相同名称的全局设置。

例如，如果你在运行pip freeze​时希望减少秒数为10秒，并且为所有其他的命令使用减少后的秒数：

‍

[global]
timeout = 60

[freeze]
timeout = 10

‍

对于布尔选项的设置，如--ignore-installed​ 或者 --no-dependencies​可以像这样设置：

‍

[install]
ignore-installed = true
no-dependencies = yes

‍

如果要启用布尔选项--no-compile​, --no-warn-script-location​ 和 --no-cache-dir​必须使用假值(false​|no​)：

‍

[global]
no-cache-dir = false

[install]
no-compile = no
no-warn-script-location = false

‍

可重复选项的选项，如--verbose​ 和 --quiet​，一个非负整数可以被用来代表被指定的级别：

‍

[global]
quiet = 0
verbose = 2

‍

给在配置文件里的部分添加值时有可能的。给可以被写在多行中的选项如--find-links​ 或者 --trusted-host​添加数值是被允许的。

这就使得用户能够按照命令行参数加入的顺序附加参数。

‍

[global]
find-links =
    http://download.example.com

[install]
find-links =
    http://mirror1.example.com
    http://mirror2.example.com

trusted-host =
    mirror1.example.com
    mirror2.example.com

‍

可以使用格式化的PIP_<UPPER_LONG_NAME>​来设置pip命令行选项的环境变量，破折号-​必须被下划线_​替代：

‍

• ​PIP_DEFAULT_TIMEOUT=60​ 等同于 --default-timeout=60​

• ​PIP_FIND_LINKS="http://mirror1.example.com http://mirror2.example.com"​ 等同于 --find-links=http://mirror1.example.com --find-links=http://mirror2.example.com​

• 没有数值的可重复选项（例如--verbose​ ）可以通过使用重复的数值来指定数值

  ​PIP_VERBOSE=3​ 等同于 pip install -vvv​

  注意：

  设置空字串的环境变量不能被视为假值，使用no​，false​，0​来替代

‍

命令行选项覆盖环境变量，环境变量覆盖配置文件中的值。在配置文件中，命令特定部分的值覆盖全局部分的值。

‍

• ​--host=foo​ 覆盖 PIP_HOST=foo​
• ​PIP_HOST=foo​ 覆盖配置文件中的 [global] host = foo​
• 在配置文件中的一个命令的特定部分 [<command>] host = bar​ 覆盖在配置文件部分[global]​ 中的同名选项.

‍

---

‍

配置方式

‍

法一：直接打开配置文件进行编辑

‍

直接打开%APPDATA%\pip\pip.ini​（C:\Users\Administrator\AppData\Roaming\pip\pip.ini​），然后对其进行编辑。

‍

​-i​，--index-url <url>​ ：

Python包索引的基本URL(默认为https://pypi.org/simple)。这应该指向符合PEP 503(简单存储库API)的存储库或以相同格式布局的本地目录。

​--extra-index-url <url>​：
除了--index-url​之外要使用的包索引的额外url。应该遵循与--index-url​相同的规则。

​-f​，--find-links <url>​：

如果是html文件的URL或路径，那么解析到归档文件的链接，例如sdist (.tar.gz)或wheel (.whl)文件。如果本地路径或file:// URL是一个目录，那么在目录列表中查找存档。不支持VCS项目url的链接。

​--trusted-host <hostname>​：

将此主机或(主机:端口)标记为受信任，即使它是无效的链接或任何HTTPS。

根据前面的命令选项配置部分，我们可以在配置文件里设置参数（包索引的基本URL和包索引的额外URL）的数值，从而实现换源。

‍

示例为pip多源配置：

‍

[global]
index-url = http://mirrors.aliyun.com/pypi/simple/
extra-index-url =
    https://pypi.mirrors.ustc.edu.cn/simple/
    http://pypi.douban.com/simple/
    https://pypi.tuna.tsinghua.edu.cn/simple/
    http://pypi.mirrors.ustc.edu.cn/simple/
    https://pypi.org/simple
[install]
trusted-host=
    mirrors.aliyun.com
    pypi.mirrors.aliyun.com
    pypi.douban.com
    pypi.tuna.tsinghua.edu.cn
    pypi.mirrors.ustc.edu.cn

---

‍

法二：通过命令设置

‍

使用pip config set​命令，直接设置相关命令选项的数值

‍

py -m pip config [<file-option>] list
py -m pip config [<file-option>] [--editor <editor-path>] edit
py -m pip config [<file-option>] get command.option
py -m pip config [<file-option>] set command.option value
py -m pip config [<file-option>] unset command.option
py -m pip config [<file-option>] debug

‍

• list：列出活动的配置（或者从指定的文件）
• edit：在编辑器里面编辑配置文件
• get：获得和命令选项相关的数值
• set：设置命令选项的数值
• unset：取消设置命令选项的数值
• debug：列出配置文件和在它们中定义的数值

‍

• pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple​：

  设置配置文件global​的index-url​的数值为https://pypi.tuna.tsinghua.edu.cn/simple​

  也就是，设置你的Python包索引的基本URL为https://pypi.tuna.tsinghua.edu.cn/simple​

  这也就是我们常说的换源操作。

• ​pip config set global.extra-index-url "<url1> <url2>..."​：

  如果说，你想要设置备用源的话（其他几个国内镜像源，以及以防万一的，默认的源https://pypi.org/simple），那么你需要这个命令。

  其中<url1>​和<url2>​指的是你需要设置的备用源的URL地址，它们之间需要用空格隔开。

  这也就是我们设置的多个备用源的操作

• ​pip config set install.trusted-host pypi.tuna.tsinghua.edu.cn​：

  这条命令的作用在前面提到过，标记主机或者主机:端口为信任。

  当你选用了非默认源后，似乎通常需要设置非默认源为信任。

  如果不设置会怎样，笔者暂时未尝试过。

‍

参考资料

‍

• pip官方文档

  https://pip.pypa.io/en/stable/

‍