Repolode
cloudflare

cloudflare/cloudflare-python

Cloudflare REST API 的官方 Python SDK,提供同步与异步客户端及类型化的请求和响应。

Star
516
Fork
159
未关闭 Issue
33
最近提交
前天

这是什么?

cloudflare-python 是 Cloudflare REST API 的官方 Python 客户端。使用它可以通过方法调用管理 zone、账户、KV 命名空间等 Cloudflare 资源,无需手动拼接 HTTP 请求。库支持 Python 3.9 及以上版本,并为所有请求参数和响应字段提供类型定义。

库同时提供同步客户端 Cloudflare 和异步客户端 AsyncCloudflare,底层基于 httpx,异步客户端还可选用 aiohttp 作为 HTTP 后端。列表接口返回自动翻页的迭代器,文件上传支持 bytes、路径或 (文件名, 内容, 媒体类型) 元组。响应对象为 Pydantic 模型,并带有 to_json() 和 to_dict() 等辅助方法。

客户端内置可配置的指数退避重试、按请求设置超时、按 HTTP 状态码划分的异常体系,并支持获取原始响应或流式读取。代码由 Stainless 生成,对于文档外的接口,可通过客户端的 get、post 等方法直接调用。

核心功能

  • 01同时提供 Cloudflare REST API 的同步与异步客户端。
  • 02请求参数和响应字段均有类型定义,响应为 Pydantic 模型。
  • 03列表接口支持自动翻页迭代。
  • 04内置指数退避自动重试,超时可配置,异常按 HTTP 状态码划分。
  • 05异步客户端可选用 aiohttp 作为 HTTP 后端。

适用场景

  • 在 Python 脚本或基础设施工具中自动化 DNS 与 zone 配置。
  • 在异步 Python 服务中管理 Cloudflare 账户和 KV 数据。
  • 在带类型检查的代码库中调用 Cloudflare API,并获得编辑器自动补全。

快速上手

  1. 1

    从 PyPI 安装库

    pip install cloudflare
  2. 2

    使用 API 令牌创建客户端并调用 API

使用前须知

  • 需要 Cloudflare API 令牌才能发起请求。
  • 需要 Python 3.9 或更高版本。

收录于专题

标签

常见问题

cloudflare-python 是什么?
Cloudflare REST API 的官方 Python SDK,提供同步与异步客户端及类型化的请求和响应。 cloudflare-python 是 Cloudflare REST API 的官方 Python 客户端。使用它可以通过方法调用管理 zone、账户、KV 命名空间等 Cloudflare 资源,无需手动拼接 HTTP 请求。库支持 Python 3.9 及以上版本,并为所有请求参数和响应字段提供类型定义。
cloudflare-python 可以免费使用吗?用的什么许可证?
cloudflare-python 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
cloudflare-python 还在维护吗?
活跃维护中。cloudflare-python 最近一次提交是在 2026年11月5日。
cloudflare-python 适合用来做什么?
在 Python 脚本或基础设施工具中自动化 DNS 与 zone 配置。 在异步 Python 服务中管理 Cloudflare 账户和 KV 数据。 在带类型检查的代码库中调用 Cloudflare API,并获得编辑器自动补全。
cloudflare-python 怎么安装和运行?
从 PyPI 安装库: pip install cloudflare 使用 API 令牌创建客户端并调用 API
在哪里获取 cloudflare-python?
源代码和安装说明在 GitHub 上:https://github.com/cloudflare/cloudflare-python

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目