我应该如何格式化一个长的url在python评论,仍然符合PEP8
在块注释中,我想引用长度超过80个字符的URL。
什么是显示此url的首选惯例?
我知道bit.ly是一个选项,但URL本身是描述性的。 缩短它,然后有一个嵌套评论描述缩短的URL似乎是一个糟糕的解决scheme。
不要打破url:
# 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
从PEP8
但最重要的是:知道什么时候不一致 – 有时风格指南不适用。 如有疑问,请使用您的最佳判断。 看看其他例子,并决定什么看起来最好。 不要犹豫,问!
两个很好的理由来打破一个特定的规则:
- 当应用这个规则时,即使对于习惯于阅读规则的代码的人来说,代码的可读性也会降低。
就我个人而言,我会使用这个build议,而将完整的描述性url留在你的评论中。
我会说离开它…
PEP20 :
特例不足以打破规则。
虽然实用性胜过纯净。
能够快速复制/粘贴url,然后在粘贴到浏览器时删除换行符更为实用。
您可以使用行尾的#noqa来停止PEP8 / Flake8运行该检查。 PEP8允许这样做:
特例不足以打破规则。
如果你正在使用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
你使用一个像谷歌这样的url缩短:
http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
你得到:
我的select是:
URL = ('http://stackoverflow.com/questions/10739843/' 'how-should-i-format-a-long-url-in-a-python-' 'comment-and-still-be-pep8-compliant')