Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Python 3.13/3.14 SyntaxWarning in v1 LogsPipelinesApi docstring

未关闭 适合新手
#3,535 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1-3 小时
新手友好度
72/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
冷清
技术栈
python
领域
api

调研方向

从 src/datadog_api_client/v1/api/logs_pipelines_api.py 开始,检查 LogsPipelinesApi 类 docstring 中报告的 regex 文本附近的内容。启用警告后运行所提供的 Python 命令以复现该警告,然后验证导入该模块不再发出此警告。当有问题的序列被安全地表示且导入仍然成功时,即表示完成。

由索引模型根据 Issue 内容生成。

描述

stale

Describe the bug
Importing datadog_api_client.v1.api.logs_pipelines_api emits a SyntaxWarning on Python 3.13+ because the LogsPipelinesApi class docstring contains an unescaped regex sequence: \s.

The warning appears to come from this docstring text in src/datadog_api_client/v1/api/logs_pipelines_api.py:

that uses a regex pattern like ``\s`` for spaces, you will

Because Python docstrings are normal string literals, \s is parsed as an invalid escape sequence. Escaping it as \\s or generating the docstring as a raw string should avoid the warning.

To Reproduce
Run this with warnings enabled on Python 3.13 or 3.14:

python -W default -c "from datadog_api_client.v1.api.logs_pipelines_api import LogsPipelinesApi; print(ok)"

Observed output:

.../datadog_api_client/v1/api/logs_pipelines_api.py:38: SyntaxWarning: "\s" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\s"? A raw string is also an option.
  """
ok

Expected behavior
Importing the SDK module should not emit warnings.

Screenshots
Not applicable.

Environment and Versions (please complete the following information):

  • datadog-api-client: observed locally with 2.54.0
  • Python: reproduced locally with Python 3.14.0rc2; expected to affect Python 3.13+ warning behavior
  • Module: datadog_api_client.v1.api.logs_pipelines_api
  • Repository master checked on 2026-05-17 still contains the same unescaped docstring sequence
  • Latest PyPI version observed on 2026-05-17: 2.55.0

Additional context
This surfaced when importing CLI code that depended on the Logs Pipelines API. The workaround on our side was to lazy-load this SDK module so unrelated CLI invocations do not emit SDK import warnings, but the underlying issue appears to be in the generated SDK docstring.

主要语言
Python
星标
166
派生
55
平均合并
2 天 17 小时
30 天内合并 PR
73

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

DataDog/datadog-api-client-python 的其他 Issue

查看 DataDog/datadog-api-client-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。