web-dev-qa-db-ja.com

pythonコメントで長いURLをフォーマットし、それでもPEP8に準拠する必要があります

ブロックコメントで、80文字を超えるURLを参照したい。

このURLを表示するための優先規則は何ですか？

Bit.lyはオプションですが、URL自体は説明的なものです。短縮して、短縮URLを説明するネストされたコメントを作成するのは、安っぽい解決策のように思えます。

pythonpep8
69
Zach

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
70
jfs

PEP8 から

しかし最も重要なことは、いつ矛盾するかを知ることです。スタイルガイドが当てはまらない場合があります。疑わしいときは、最善の判断をしてください。他の例を見て、最適なものを決定してください。そして、askすることをaskしないでください！

特定の規則に違反する2つの理由：

  • ルールを適用すると、ルールに従うコードを読むことに慣れている人でも、コードが読みにくくなります。

個人的には、私はそのアドバイスを使用し、人々へのコメントに完全な説明的なURLを残します。

61
Christian Witts

行の最後で# noqaを使用して、PEP8/Flake8がそのチェックを実行しないようにすることができます。これは、以下を介してPEP8で許可されています。

特別なケースは、規則を破るほど特別ではありません。

34
Sardathrion

私はそれを残すと言うでしょう...

PEP2 ：

特別なケースは、規則を破るほど特別ではありません。

実用性は純度よりも優れていますが。

ブラウザーに貼り付けるときにURLをすばやくコピー/貼り付けしてから改行を削除する方が実用的です。

22
mata

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
12
guyskk

あなたはグーグルのようなURL短縮サービスを使用していますので、これから：

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

あなたが得る：

http://goo.gl/93ZLQ

1
Low Kian Seong