超过79个字符的注释行

时间:2018-07-03 05:31:01

标签: python comments flake8

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

2 个答案:

答案 0 :(得分:2)

通常可以在行上方添加如下注释:

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

顺便说一句,在撰写本文时,PEP 8说注释的行数限制仅为72。

  

要使长文本块具有较少的结构限制(文档字符串或注释),应将行长限制为72个字符。

     

...

     

一些团队强烈希望使用更长的线长。对于专门或主要由可以就此问题达成协议的团队维护的代码,可以将标称行长度从80个字符增加到100个字符(有效地将最大长度增加到99个字符),前提是注释和文档字符串仍被包装最多72个字符。

目前尚不清楚这是否适用于内联注释,因为它们不是“长文本块”,但PEP 8也表示,

  

内联注释是不必要的,并且如果它们表明明显的内容,则实际上会分散注意力。

您可以考虑完全删除该评论。考虑到该字符串中包含“ google”,因此很明显是一个Google URL。


在某些情况下,评论确实确实必须与其评论相同-PEP-484 type comments。在这种情况下,请使用括号:

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

答案 1 :(得分:0)

相信一种更Python化的方法可能是:

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)