В блочном комментарии я хочу ссылаться на URL длиной более 80 символов.
Какое предпочтительное соглашение для отображения этого 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 в вашем комментарии для людей.
Я бы сказал, оставьте его...
Особые случаи не являются достаточно сложными, чтобы нарушать правила.
Хотя практичность превосходит чистоту.
Более практично иметь возможность быстро скопировать/вставить 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-адрес, например google:
http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
вы получаете:
Мой вариант:
URL = ('http://stackoverflow.com/info/10739843/'
'how-should-i-format-a-long-url-in-a-python-'
'comment-and-still-be-pep8-compliant')