自动校正Python Sphinx行长度

1 投票
1 回答
807 浏览
提问于 2025-04-16 18:16

通常,关于 Sphinx 的最佳实践建议是,行长度应该限制在 80 个字符以内。

所以我想要一种方法,能够自动将我的行长度限制在 80 个字符以内(不带连字符),而且在进行调整时,尽量保持正确的缩进(如果可以的话)。我看到的唯一一个似乎有点用的函数是 Textwrap,具体可以查看这个链接:http://docs.python.org/library/textwrap.html

有没有人有相关的经验?或者有没有更好的主意?这个函数已经包含在 Sphinx 里,但我找不到?我是不是漏掉了 StackOverflow 上的某个话题?

欢迎任何建议。

1 个回答

2

你需要一个好用的编辑器。

比如在vim这个编辑器里,可以通过以下方式来处理:

:set textwidth=80

然后你只需要开始输入,vim会自动换到下一行继续。

如果你想调整文本格式,可以选中一段文字,然后输入 gq,这样就会根据“textwidth”这个设置来重新格式化你选中的内容。

举个例子:

In those days spirits were brave, the stakes were high, men were real men, women were real women and small furry creatures from Alpha Centauri were real small furry creatures from Alpha Centauri.

在vim中设置 tw=30 后,选中一段文字并输入 gq

In those days spirits were
brave, the stakes were high,
men were real men, women were
real women and small furry
creatures from Alpha Centauri
were real small furry
creatures from Alpha Centauri.

撰写回答