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

RFC: improve diagnostic formatting

未关闭
  • 哪里不对？
#3,258 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
20/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
python
领域
cli

调研方向

Start by reading the existing handling for --caret-diagnostic, -C/-A/-B, interactive mode, and --stdin_single_line; the issue does not name files or tests. Decide whether to introduce --format, which output formats and context behavior it should support, and how the interactive and stdin cases should work. Done means the discussion settles these design questions before implementation.

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

描述

awaiting review enhancement

In #3256 I introduced the --caret-diagnostic flag in order to report the diagnostic message as it is done by modern compilers.
The name of the flag is derived from https://clang.llvm.org/docs/ClangCommandLineReference.html#cmdoption-clang-fcaret-diagnostics (though I missed the ending s).

@peternewman suggested to add a --format flag, instead, in order to be future proof.

Since this requires more changes to the current code, I would like to open a discussion about the best strategy.
The main problem is how the context (-C/-A/-B) is applied. Here is an example:

:     with fp:
:         # GH-87235: On macOS all file descriptors for /dev/fd/N share the same
>         # file offset, reset the file offset after scanning the zipfile diretory
:         # to not cause problems when some runs 'python3 /dev/fd/9 9<some_script'
:         start_offset = fp.tell()
Lib/zipimport.py:355: diretory ==> directory

This works only when there is one line.

--format flag

Introducing the --format flag has the advantage that we know how many context source lines are printed by a format, so with -C/-A/-B the code only needs to print additional lines around the lines printed by the format.

Possible formats:

plain (default)
if filename != "-":
    f"{cfilename}:{cline}: {cwrongword} "
    f"==> {crightword}{creason}"
else:
    f"{cline}: {cwrongword} ==> {crightword}{creason}"

Not sure if ccolumn can be added.

diagnostic / caret-diagnostics / develop/ ?
if filename != "-":
       f"{cfilename}:{cline}:{ccolumn}: {cwrongword} "
       f"==> {crightword}{creason}\n"
       f"{line}"
       f"{ccaret}\n"                   
else:
       f"{cfilename}:{cline}:{ccolumn}: {cwrongword} "
       f"==> {crightword}{creason}\n"
       f"{line}"
       f"{ccaret}\n"

TODO

Not sure if the code in interactive mode should also be modified. Example:

:         env['LC_ALL'] = 'C'
>         # Empty strings will be quoted by popen so we should just ommit it
:         if args != ('',):
        # Empty strings will be quoted by popen so we should just ommit it
	ommit ==> omit (Y/n)

The same line is printed twice; not sure if it is a good user experience.

Another issue I found is:

elif options.stdin_single_line:
    print(f"{cline}: {cwrongword} ==> {crightword}{creason}")
else:
    print(
        f"{cline}: {line.strip()}\n\t{cwrongword} "
        f"==> {crightword}{creason}"
    )

Should we have the second template be an alternative format?
Should the --stdin_single_line flag be removed before the next release?

Thanks.

主要语言
Python
星标
2.4k
派生
531
平均合并
15 小时 5 分钟
30 天内合并 PR
18

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

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

codespell-project/codespell 的其他 Issue

查看 codespell-project/codespell 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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