API 文档

本节将引导您进一步了解 Tencent Cloud SDK for Python 所提供的更多功能和高级特性

前提

阅读 Tencent Cloud SDK for Python 技术文档之前,强烈建议您先阅读入门文档。

异步

Tencent Cloud SDK for Python 建立在全异步 API 支持的基础之上,这意味着所有 API 均以异步编程方式编写。不过,我们仍为同步编程方式提供兼容 API 支持,这些适用于同步编程方式的兼容 API 将在内部调用其适用于异步编程方式的 API 版本。

适用于异步编程方式的 API 命名均以 _async 结尾。

例如我们在无服务器云函数产品客户端中使用的方法 easy_invoke,其具有适用于同步和异步编程方式共 2 个 API 版本,其方法符号名分别为:

  • 同步编程方式:easy_invoke

  • 异步编程方式:easy_invoke_async

在 API 文档中我们将以便于理解的同步编程方式向您介绍和演示,其适用于异步编程方式的 API 版本在行为和参数定义上与适用于同步编程方式的 API 版本一致。

请注意,适用于同步编程方式的 API 不支持在异步编程方式中使用,否则行为是未定义的。

建议

Tencent Cloud SDK for Python 面向开发者提供低级 API 和高级 API。除非必要或拥有 API 文档的兼容性承诺,否则您应该始终使用高级 API 编写应用程序。

低级 API 通常是 Tencent Cloud SDK for Python 为面向内部高级 API 实现提供的底层 API 实现,低级 API 签名和行为可能会因 Tencent Cloud SDK for Python 的版本更新而改变甚至废止、删除,这将导致依赖低级 API 的应用程序无法在集成更高版本的 Tencent Cloud SDK for Python 时正确工作。

例如高级 API 方法 tencent.cloud.core.client.UniversalClient.action 在内部调用低级 API 方法 tencent.cloud.core.client.BaseClient._request_action_async 以实现对 Tencent Cloud API 的调用并获得结果。

请注意,如果一个高级 API 未在 API 文档中声明,表明该 API 可能是实验性的并可能会在未来的某一个版本中被废止、删除,应该谨慎在应用程序中使用。

Tencent Cloud 产品

目前 Tencent Cloud SDK for Python 面向以下 Tencent Cloud 产品提供抽象的产品客户端:

无服务器云函数

其他 Tencent Cloud 产品

您需要集成并使用的 Tencent Cloud 产品未列出?没关系,您仍然可以使用 Tencent Cloud SDK for Python 提供的通用客户端直接快速、安全地访问 Tencent Cloud API 并获得结果,Tencent Cloud SDK for Python 将代您管理 Tencent Cloud API 身份验证和签名、底层互联网通信和请求与响应解析等实现细节:

请注意,目前 Tencent Cloud SDK for Python 所有类型均不是线程安全的。在多线程应用程序模型中,您应该在每一条超线程上下文中实例化一个或多个独立的类型实例。