71 votes

Comment formater une longue URL dans un commentaire Python tout en restant conforme à PEP8

Dans un commentaire de bloc, je souhaite référencer une URL de plus de 80 caractères.

Quelle est la convention préférée pour afficher cette URL?

Je sais que bit.ly est une option, mais l’URL elle-même est descriptive. Le raccourcir et ensuite avoir un commentaire imbriqué décrivant l'URL raccourcie semble être une solution de merde.

71voto

J.F. Sebastian Points 102961

Ne pas casser l'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
 

62voto

Christian Witts Points 4369

De PEP8

Mais le plus important: savoir quand être incohérent, parfois le style guide ne s'applique pas. En cas de doute, utilisez votre meilleur jugement. Regarder d'autres exemples et de décider ce qui semble la meilleure. Et n'hésitez pas à demander!

Deux bonnes raisons pour briser une règle particulière:

  • Lors de l'application de la règle serait de rendre le code moins lisible, même pour quelqu'un qui est utilisé pour la lecture de code qui suit les règles.

Personnellement, je voudrais utiliser que des conseils, et plutôt laisser la pleine descriptif URL dans votre commentaire pour les gens.

34voto

Sardathrion Points 1690

Vous pouvez utiliser les # noqa en fin de ligne pour empêcher PEP8 / Flake8 d’exécuter cette vérification. Ceci est autorisé par PEP8 via:

Les cas spéciaux ne sont pas assez spéciaux pour enfreindre les règles. "

22voto

mata Points 22446

Je dirais le laisser ...

PEP20 :

Les cas spéciaux ne sont pas assez spéciaux pour enfreindre les règles.

Bien que la praticité bat la pureté.

Il est plus pratique de pouvoir copier / coller rapidement une URL puis de supprimer les sauts de ligne lors du collage dans le navigateur.

0voto

Low Kian Seong Points 389

Vous utilisez un raccourcisseur d'URL, comme celui de Google, à partir de ceci:

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

vous obtenez:

http://goo.gl/93ZLQ

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by: