Làm cách nào để tôi định dạng một url dài trong một nhận xét python và vẫn tuân thủ PEP8

Trong một nhận xét khối, tôi muốn tham chiếu đến một URL dài hơn 80 ký tự.

Quy ước ưa thích để hiển thị URL này là gì?

Tôi biết bit.ly là một tùy chọn, nhưng bản thân URL là mô tả. Việc rút ngắn nó và sau đó có một nhận xét lồng nhau mô tả URL được rút ngắn có vẻ như là một giải pháp tồi tệ.

Đừng phá vỡ 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

Từ PEP8

Nhưng quan trọng nhất: biết khi nào cần nhất quán - đôi khi hướng dẫn phong cách không áp dụng. Khi nghi ngờ, hãy sử dụng phán đoán tốt nhất của bạn. Xem các ví dụ khác và quyết định xem điều gì trông đẹp nhất. Và đừng ngần ngại hỏi!

Hai lý do chính đáng để phá vỡ một quy tắc cụ thể:

• Khi áp dụng quy tắc sẽ làm cho mã khó đọc hơn, ngay cả đối với một người quen đọc mã tuân theo quy tắc.

Cá nhân tôi sẽ sử dụng lời khuyên đó và thay vì để lại URL mô tả đầy đủ trong nhận xét của bạn cho mọi người.

Bạn có thể sử dụng # noqaở cuối dòng để ngăn PEP8 / Flake8 chạy kiểm tra đó. Điều này được PEP8 cho phép thông qua:

Các trường hợp đặc biệt không đủ đặc biệt để phá vỡ các quy tắc.

Tôi muốn nói rằng hãy để nó ...

PEP20 :

Các trường hợp đặc biệt không đủ đặc biệt để phá vỡ các quy tắc.

Mặc dù tính thực tế đánh bại sự thuần khiết.

Thực tế hơn là có thể nhanh chóng sao chép / dán một url sau đó xóa dấu ngắt dòng khi dán vào trình duyệt.

Nếu bạn đang sử dụng 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

Bạn sử dụng một công cụ rút gọn url như của google để từ đó:

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

bạn lấy:

http://goo.gl/93ZLQ

Lựa chọn của tôi sẽ là:

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