我应该如何在python注释中格式化长URL并且仍然符合PEP8

Question

在块注释中，我想引用一个超过80个字符的URL。

显示此网址的首选惯例是什么？

我知道bit.ly是一个选项，但URL本身是描述性的。缩短它然后有一个描述缩短的URL的嵌套注释似乎是一个糟糕的解决方案。

Answer 1

不要破坏网址：

# A Foolish Consistency is the Hobgoblin of Little Minds [1]
# [1]: http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds

Answer 2

来自PEP8

  

但最重要的是：知道何时不一致 - 有时风格指南不适用。如有疑问，请使用您的最佳判断。查看其他示例并确定最佳效果。并且毫不犹豫地问！

     

打破特定规则的两个充分理由：

     

  
• 应用规则会降低代码的可读性，即使对于习惯阅读遵循规则的代码的人也是如此。
  

就个人而言，我会使用该建议，而是在评论中留下完整的描述性网址。

Answer 3

您可以使用该行末尾的# noqa来阻止PEP8 / Flake8运行该检查。 PEP8允许这样做：

  

特殊情况不足以打破规则。

Answer 4

我会说离开它......

PEP20：

  

特殊情况不足以打破规则。

     

虽然实用性胜过纯洁。

能够快速复制/粘贴网址然后在粘贴到浏览器时删除换行符更为实用。

Answer 5

如果您使用的是flake8：

"""
long-url: http://stackoverflow.com/questions/10739843/how-should-i-format-a-long-url-in-a-python-comment-and-still-be-pep8-compliant
"""  # noqa

Answer 6

你使用像google这样的url缩短器，所以：

http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds

你得到：

http://goo.gl/93ZLQ

Answer 7

我的选择是：

URL = ('http://stackoverflow.com/questions/10739843/'
       'how-should-i-format-a-long-url-in-a-python-'
       'comment-and-still-be-pep8-compliant')