파이썬 주석에서 긴 URL 형식을 지정하고 여전히 PEP8을 준수해야합니다.

블록 주석에서 80 자 이상의 URL을 참조하고 싶습니다.

이 URL을 표시하는 데 선호되는 규칙은 무엇입니까?

bit.ly가 옵션이라는 것을 알고 있지만 URL 자체는 설명 적입니다. 단축 한 다음 단축 된 URL을 설명하는 중첩 된 주석을 갖는 것은 엉터리 해결책처럼 보입니다.

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

그러나 가장 중요한 것은 일관성이없는시기를 아는 것입니다. 때로는 스타일 가이드가 적용되지 않는 경우도 있습니다. 의심스러운 경우 최선의 판단을 사용하십시오. 다른 예를보고 가장 잘 보이는 것을 결정하십시오. 그리고 주저하지 말고 물어보세요!

특정 규칙을 어기는 두 가지 이유 :

• 규칙을 적용하면 규칙을 따르는 코드를 읽는 데 익숙한 사람에게도 코드의 가독성이 떨어집니다.

개인적으로 나는 그 조언을 사용하고 오히려 사람들을 위해 귀하의 의견에 전체 설명 URL을 남겨 둡니다.

# noqa줄 끝에있는를 사용하여 PEP8 / Flake8이 해당 검사를 실행하지 못하도록 할 수 있습니다 . 이것은 PEP8에서 다음을 통해 허용됩니다.

특별한 경우는 규칙을 어길만큼 특별하지 않습니다.

놔둬 야겠다 ...

PEP20 :

특별한 경우는 규칙을 어길만큼 특별하지 않습니다.

실용성이 순결을 능가하지만.

URL을 빠르게 복사 / 붙여 넣기 한 다음 브라우저에 붙여 넣을 때 줄 바꿈을 제거하는 것이 더 실용적입니다.

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

다음과 같이 Google과 같은 URL 단축기를 사용합니다.

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

당신은 얻는다 :

http://goo.gl/93ZLQ

내 옵션은 다음과 같습니다.

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