超过 79 个字符符合评论



当我有例如这一行时,我该怎么办:full_path = "https://www.google.cz/search?q=" + website_keywords # google link url Flake8 报告我,行中的字符最大长度超过 79。那么当 PEP 8 说内联注释应该与特定语句在同一行时,我应该如何处理注释。

通常可以在行上方添加这样的注释:

# google link url
full_path = "https://www.google.cz/search?q=" + website_keywords

顺便说一下,在撰写本文时,PEP 8 表示评论的行限制仅为 72。

对于结构限制较少(文档字符串或注释(的流动长文本块,行长应限制为 72 个字符。

一些团队强烈喜欢更长的线长。对于完全或主要由可以就此问题达成一致的团队维护的代码,可以将标称行长度从 80 个字符增加到 100 个字符(有效地将最大长度增加到 99 个字符(,前提是注释和文档字符串仍然以 72 个字符换行。

目前尚不清楚这是否适用于内联评论,因为它们不是"长文本块",但 PEP 8 也说,

内联注释是不必要的,如果它们陈述显而易见的内容,实际上会分散注意力。

您可以考虑完全删除该评论。考虑到字符串中包含"google",它是一个谷歌URL的事实很明显。


有一种情况,评论确实必须与它评论的内容在同一行 - PEP-484 类型的评论。在这种情况下,请使用括号:

full_path = (
"https://www.google.cz/search?q=" + website_keywords
)  # type: str

我相信一种更pythonic的方法可能是:

from urllib.parse import urlencode
def format_url(website_keywords):
"""Return google link url."""
parameters = urlencode({"q": website_keywords}, True)
root_url = "https://www.google.cz/search"
return "%s/%s" % (root_url, parameters)

最新更新