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

docformatter-v1.7.8 mangles r-strings

未关闭
#343 3 条评论 5 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
冷清
技术栈
python
领域
tooling

调研方向

使用提供的 docstring 重现该报告,并比较 docformatter-v1.7.8 与 v1.7.7。以 bzfs_tests/itest/test_lima_vm_sh.py 第 431-464 行中的完整示例为参考;当 r-strings 在不改变其程序语义的情况下完成格式化时,即表示完成。

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

描述

C: convention P: bug U: high

Turns out docformatter-v1.7.8 mangles r-strings in a way that alters the semantics of the program. I had to revert back to v1.7.7 as it doesn't change these r-strings.

Example:

def foo(self) -> str:
    """Returns bash that locates a usable SSH identity and defines `good_ssh`."""
    return r"""
        identity_file=""
        for candidate in "$HOME"/.ssh/id_ed25519 "$HOME"/.ssh/id_rsa "$HOME"/.ssh/id_ecdsa "$HOME"/.ssh/id_dsa; do
        ...
    """

In case it's of any help, complete example is here: https://github.com/whoschek/bzfs/blob/0ce658cc65bac47cb9384ad83f5f54dd9aa6bf0e/bzfs_tests/itest/test_lima_vm_sh.py#L431-L464

主要语言
Python
星标
598
派生
94
平均合并
12 天 10 小时
30 天内合并 PR
1

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

PyCQA/docformatter 的其他 Issue

查看 PyCQA/docformatter 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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