Как мне отформатировать длинный URL-адрес в комментарии Python и по-прежнему соответствовать PEP8

Question 1

В комментарии к блоку я хочу сослаться на URL длиной более 80 символов.

Каково предпочтительное соглашение для отображения этого URL-адреса?

Я знаю, что bit.ly - это вариант, но сам URL носит описательный характер. Сокращение его, а затем наличие вложенного комментария, описывающего сокращенный URL-адрес, кажется паршивым решением.

Question 2

Не нарушайте 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

Question 3

Из PEP8

Но самое главное: знайте, когда нужно быть непоследовательным - иногда руководство по стилю просто неприменимо. В случае сомнений используйте здравый смысл. Посмотрите другие примеры и решите, что выглядит лучше всего. И не стесняйтесь спрашивать!

Две веские причины нарушить то или иное правило:

Применение правила сделает код менее читаемым даже для тех, кто привык читать код, который следует правилам.

Лично я бы воспользовался этим советом и оставил бы для людей полный описательный URL-адрес в вашем комментарии.

Question 4

Вы можете использовать # noqaсимвол в конце строки, чтобы PEP8 / Flake8 не запускал эту проверку. Это разрешено PEP8 через:

Особых случаев недостаточно, чтобы нарушать правила.

Question 5

Я бы сказал, оставь это ...

PEP20 :

Особых случаев недостаточно, чтобы нарушать правила.

Хотя практичность лучше чистоты.

Более практично иметь возможность быстро скопировать / вставить URL-адрес, чем удалять разрывы строк при вставке в браузер.

Question 6

Если вы используете 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

Question 7

Вы используете сокращение URL-адресов, например Google, поэтому из этого:

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

Вы получаете:

http://goo.gl/93ZLQ

Question 8

Мой вариант:

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

Answer 1

В комментарии к блоку я хочу сослаться на URL длиной более 80 символов.

Каково предпочтительное соглашение для отображения этого URL-адреса?

Я знаю, что bit.ly - это вариант, но сам URL носит описательный характер. Сокращение его, а затем наличие вложенного комментария, описывающего сокращенный URL-адрес, кажется паршивым решением.

Answer 2

77

Не нарушайте 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

jfs
источник

5

Я согласен; однако PyCharm не позволяет легко игнорировать (не засоряя ваш код уродливыми ссылками '# noinspection LongLine' (и подобными) повсюду. Я думаю, что более серьезная проблема заключается в том, что формат RST имеет ограничение, заключающееся в невозможности иметь разрыв строки (который не отображается) в URL-адресе.

4

Ответ не отвечает на вопрос, как быть совместимым, поэтому, если у вас есть линтер, он остается с предупреждениями.

Эфрен

4

@jfs, так что ответ действительно должен быть: «В данном случае длинная строка соответствует требованиям PEP8»

Эфрен

2

@Efren, это именно мой ответ: * "как мне отформатировать ... и быть совместимым с pep-8" * -> "не нарушайте URL"

jfs

2

Я только что обнаружил Ctrl + щелчок !! Вот почему вы не хотите разбивать URL-адрес в комментарии.

Боб Штейн

Answer 3

5

Я согласен; однако PyCharm не позволяет легко игнорировать (не засоряя ваш код уродливыми ссылками '# noinspection LongLine' (и подобными) повсюду. Я думаю, что более серьезная проблема заключается в том, что формат RST имеет ограничение, заключающееся в невозможности иметь разрыв строки (который не отображается) в URL-адресе.

Answer 4

4

Ответ не отвечает на вопрос, как быть совместимым, поэтому, если у вас есть линтер, он остается с предупреждениями.

Эфрен

Answer 5

4

@jfs, так что ответ действительно должен быть: «В данном случае длинная строка соответствует требованиям PEP8»

Эфрен

Answer 6

2

@Efren, это именно мой ответ: * "как мне отформатировать ... и быть совместимым с pep-8" * -> "не нарушайте URL"

jfs

Answer 7

2

Я только что обнаружил Ctrl + щелчок !! Вот почему вы не хотите разбивать URL-адрес в комментарии.

Боб Штейн

Answer 8

Из PEP8

Но самое главное: знайте, когда нужно быть непоследовательным - иногда руководство по стилю просто неприменимо. В случае сомнений используйте здравый смысл. Посмотрите другие примеры и решите, что выглядит лучше всего. И не стесняйтесь спрашивать!

Две веские причины нарушить то или иное правило:

Применение правила сделает код менее читаемым даже для тех, кто привык читать код, который следует правилам.

Лично я бы воспользовался этим советом и оставил бы для людей полный описательный URL-адрес в вашем комментарии.

Answer 9

46

Вы можете использовать # noqaсимвол в конце строки, чтобы PEP8 / Flake8 не запускал эту проверку. Это разрешено PEP8 через:

Особых случаев недостаточно, чтобы нарушать правила.

Сардатрион - против злоупотребления SE
источник

3

Элегантный. Я использую pyflakes в Vim и не буду фиксировать изменения, пока он не вернет ноль предупреждений из согласованного набора правил (в нашем случае требование maccabe более слабое, но не ограничение в 80 строк). Кратчайший способ сказать коллегам: я не разделял многострочность, потому что в этом нет смысла.

Питер Хост

4

Спасибо, @Sardathrion, должно набрать больше голосов, так как он действительно способствует практическому решению.

ezdazuzena

Answer 10

3

Элегантный. Я использую pyflakes в Vim и не буду фиксировать изменения, пока он не вернет ноль предупреждений из согласованного набора правил (в нашем случае требование maccabe более слабое, но не ограничение в 80 строк). Кратчайший способ сказать коллегам: я не разделял многострочность, потому что в этом нет смысла.

Питер Хост

Answer 11

4

Спасибо, @Sardathrion, должно набрать больше голосов, так как он действительно способствует практическому решению.

ezdazuzena

Answer 12

Я бы сказал, оставь это ...

PEP20 :

Особых случаев недостаточно, чтобы нарушать правила.

Хотя практичность лучше чистоты.

Более практично иметь возможность быстро скопировать / вставить URL-адрес, чем удалять разрывы строк при вставке в браузер.

Answer 13

Если вы используете 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 14

-2

Вы используете сокращение URL-адресов, например Google, поэтому из этого:

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

Вы получаете:

http://goo.gl/93ZLQ

Лоу Киан Сеонг
источник

9

Конечно, существует риск того, что сокращатель ссылок исчезнет, и мы не сможем узнать ссылку. ArchiveTeam (во главе с руководством, связанным с Archive.org) прилагает все усилия, чтобы сохранить средства, сокращающие ссылки…

Ахмед Фасих

1

И не только это, но и исходный URL-адрес содержит информацию о том, что это такое. Сокращатели URL-адресов теряют эту информацию.

Жюльен

Answer 15

9

Конечно, существует риск того, что сокращатель ссылок исчезнет, и мы не сможем узнать ссылку. ArchiveTeam (во главе с руководством, связанным с Archive.org) прилагает все усилия, чтобы сохранить средства, сокращающие ссылки…

Ахмед Фасих

Answer 16

1

И не только это, но и исходный URL-адрес содержит информацию о том, что это такое. Сокращатели URL-адресов теряют эту информацию.

Жюльен

Answer 17

-5

Мой вариант:

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

Медардо Родригес
источник

3

Слишком болезненно копировать пасту таким способом.

Кел Солаар,

Answer 18

3

Слишком болезненно копировать пасту таким способом.

Кел Солаар,

Как мне отформатировать длинный URL-адрес в комментарии Python и по-прежнему соответствовать PEP8

Ответы: