commercelayer

访问Commerce Layer API的客户端库

用法

首先，创建一个客户端

from commercelayer import Client

client = Client(base_url="https://api.example.com")

如果你要调用的端点需要认证，请使用AuthenticatedClient

from commercelayer import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")

现在调用你的端点并使用你的模型

from commercelayer.models import MyDataModel
from commercelayer.api.my_tag import get_my_data_model
from commercelayer.types import Response

my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)

或者用异步版本做同样的事情

from commercelayer.models import MyDataModel
from commercelayer.api.my_tag import get_my_data_model
from commercelayer.types import Response

my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)

默认情况下，当你调用HTTPS API时，它将尝试验证SSL是否正常工作。大多数情况下，使用证书验证是强烈推荐的，但有时你可能需要使用自定义证书包来认证服务器（尤其是内部服务器）。

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

你也可以完全禁用证书验证，但请注意，这存在安全风险。

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken", 
    verify_ssl=False
)

在生成的Client类中还有更多设置，可以让你控制更多的运行时行为，查看该类的文档字符串以获取更多信息。

注意事项

1. 每个路径/方法组合都成为一个包含四个函数的Python模块

   1. sync：阻塞请求，如果成功则返回解析后的数据或None
   2. sync_detailed：阻塞请求，总是返回一个Request，如果请求成功，则可选地设置parsed
   3. asyncio：类似于sync，但异步而非阻塞
   4. asyncio_detailed：类似于sync_detailed，但异步而非阻塞

2. 所有路径/查询参数和体都成为方法参数。

3. 如果您的端点有任何标签，则第一个标签将用作函数的模块名（如上例中的my_tag）

4. 未标记的端点将位于commercelayer.api.default

构建/发布此客户端

此项目使用Poetry来管理依赖关系和打包。以下是基本步骤

1. 更新pyproject.toml中的元数据（例如，作者、版本）
2. 如果您正在使用私有仓库，请使用Poetry进行配置
   1. poetry config repositories.<your-repository-name> <url-to-your-repository>
   2. poetry config http-basic.<your-repository-name> <username> <password>
3. 使用 poetry publish --build -r <你的仓库名称> 发布客户端，或者如果是在公共PyPI上，只需 poetry publish --build

如果您想在不发布的情况下将此客户端安装到另一个项目中（例如，用于开发），那么

1. 如果该项目使用 诗韵，您可以简单地在该项目中执行 poetry add <此客户端的路径>
2. 如果该项目不使用诗韵
   1. 使用 poetry build -f wheel 构建wheel
   2. 从另一个项目安装该wheel pip install <wheel的路径>