进阶 docs.pypi.org 2026-10-20 06:39:13 · 25 阅读
第25章 Index API 详解:PyPI 的 PEP 503 与 PEP 691 实现
Index API
本页介绍了 PyPI 对 PEP 503(HTML)和 PEP 691(JSON)Index API 的实现。请查阅 Simple Repository API 以获取该 API 的官方实时规范。
注
Index API 有时也被称为“遗留 API(legacy API)”,因为它与 PyPI 遗留代码库功能保持一致。
注
该 API 支持 HTML 和 JSON 两种格式。建议新集成使用 JSON 版本。
路由
列出所有项目
路由:GET /simple/
返回所有已注册的项目。
响应头:
X-PyPI-Last-Serial - 任何项目的最新序列号。
状态码:
200 OK - 无错误
HTML
HTML 请求示例(如果未传递 Accept 头,则默认使用此格式):
GET /simple/ HTTP/1.1
Host: pypi.org
Accept: application/vnd.pypi.simple.v1+html
HTML 响应示例
HTTP/1.0 200 OK
Content-Type: application/vnd.pypi.simple.v1+html
X-PyPI-Last-Serial: 24888689
Simple index
0
0-._.-._.-._.-._.-._.-._.-0
JSON
JSON 请求示例:
GET /simple/ HTTP/1.1
Host: pypi.org
Accept: application/vnd.pypi.simple.v1+json
JSON 响应示例
HTTP/1.1 200 OK
Content-Type: application/vnd.pypi.simple.v1+json
X-PyPI-Last-Serial: 24888689
{
"meta": {
"_last-serial": 24888689,
"api-version": "1.4"
},
"projects": [
{
"_last-serial": 3075854,
"name": "0"
},
{
"_last-serial": 1448421,
"name": "0-._.-._.-._.-._.-._.-._.-0"
},
"更多项目..."
]
}
获取项目分发版本
路由:GET /simple/<project>/
获取项目可用发行版(wheel 包和源码分发)的所有分发下载 URL。项目名称匹配不区分大小写,且 `_`、`-` 和 `.` 被视为等同。链接中可选地包含使用 URL 片段(fragment)表示的哈希值。该片段格式为 `#<hashname>=<hexdigest>`。如果存在,下载的必须对该哈希值进行验证。有效的哈希值包括 `md5`、`sha1`、`sha224`、`sha256`、`sha384` 和 `sha512`。
如果 PyPI 中存在分发文件的 PGP/GPG 签名,它将与文件位于相同的 URL 下,只是添加了 `.asc` 后缀。但上述 URL 列表中不会提供指向该签名的链接。因此,一旦你拥有了 wheel 或 sdist 文件名(例如 `https://file.pythonhosted.org/.../foo-1.0.tar.gz`),就可以通过单独的 GET 请求检查 `https://file.pythonhosted.org/.../foo-1.0.tar.gz.asc` 是否存在。
响应头:
X-PyPI-Last-Serial - 该项目的最新序列号。
状态码:
200 OK - 无错误
HTML
HTML 请求示例(如果未传递 Accept 头,则默认使用此格式):
GET /simple/beautifulsoup4/ HTTP/1.1
Host: pypi.org
Accept: application/vnd.pypi.simple.v1+html
HTML 响应示例
HTTP/2 200 OK
Content-Type: application/vnd.pypi.simple.v1+html
Etag: "q4SqZutq1tfRDqhh3zQ4gQ"
X-PyPI-Last-Serial: 2857110
<!DOCTYPE html>
<html>
<head>
<meta name="pypi:repository-version" content="1.4">
<meta name="pypi:project-status" content="active">
<title>Links for beautifulsoup4</title>
</head>
<body>
<a href="https://files.pythonhosted.org/packages/6f/be/99dcf74d947cc1e7abef5d0c4572abcb479c33ef791d94453a8fd7987d8f/beautifulsoup4-4.0.1.tar.gz#sha256=dc6bc8e8851a1c590c8cc8f25915180fdcce116e268d1f37fa991d2686ea38de" >beautifulsoup4-4.0.1.tar.gz</a>
beautifulsoup4-4.0.2.tar.gz
beautifulsoup4-4.13.0b2-py3-none-any.whl
beautifulsoup4-4.13.0b2.tar.gz
beautifulsoup4-4.0.2.tar.gz
beautifulsoup4-4.13.0b2-py3-none-any.whl
beautifulsoup4-4.13.0b2.tar.gz