En un comentario de bloque, quiero hacer referencia a una URL que tiene más de 80 caracteres.¿Cómo debo formatear una url larga en un comentario de Python y aún cumplir con PEP8?
¿Cuál es la convención preferida para mostrar esta URL?
Sé que bit.ly es una opción, pero la URL en sí es descriptiva. Acortarlo y luego tener un comentario anidado que describe la URL acortada parece una solución horrible.
No romper la 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
De PEP8
Pero lo más importante: saber cuándo ser inconsistente - a veces el libro de estilo simplemente no se aplica. En caso de duda, use su mejor juicio. Mire otros ejemplos y decida qué se ve mejor. ¡Y no dudes en preguntar!
Dos buenas razones para romper una regla particular:
- Al aplicar la regla haría que el código menos legible, incluso para alguien que está acostumbrado a la lectura de código que sigue las reglas.
En lo personal, me gustaría utilizar ese consejo, y más bien dejar la URL descriptiva completa en su comentario a la gente.
yo diría que lo deje ...
casos especiales no son lo suficientemente especial como para romper las reglas.
Aunque la practicidad supera la pureza.
Es más práctico poder copiar/pegar rápidamente una url y luego eliminar los saltos de línea al pegar en el navegador.
Mi opción sería:
URL = ('http://stackoverflow.com/questions/10739843/'
'how-should-i-format-a-long-url-in-a-python-'
'comment-and-still-be-pep8-compliant')
. Demasiado doloroso para copiar pasta de una manera utilizable de esta manera. –
Ese es el código que se ejecutará, no un comentario. –
Se utiliza un acortador de URL como Google de lo que desde este:
http://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
obtienes:
El riesgo, por supuesto, es que el acortador de enlaces desaparece y no tenemos forma de saber el enlace. ArchiveTeam (liderado por un líder afiliado a Archive.org) tiene un esfuerzo dedicado a guardar enlaces acortadores ... –
Puede usar el # noqa al final de la línea para detener la ejecución de ese control por parte de PEP8/Flake8. Esto es permitido por PEP8 a través de:
Los casos especiales no son lo suficientemente especiales como para infringir las reglas.
Elegante. Yo uso pyflakes en Vim y no comprometeré un cambio hasta que devuelva cero advertencias del conjunto de reglas acordadas (el requisito de maccabe es más flexible en nuestro caso, pero no el límite de 80 líneas). La forma más corta de decirles a los compañeros de trabajo: No dividí multilínea porque no tiene sentido hacerlo. –
Gracias @Sardathrion, debería tener más votos ya que en realidad aporta una solución práctica. – ezdazuzena
Si su están utilizando 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
no puede entender por qué esto está upvoted tantas veces. No funciona para mi –
@DmitrySorin: si "no rompa la url" no está claro; sigue el enlace en la respuesta. O si no puede abrir la url; lea la cita directa en [@Cristian Witts 'answer] (http://stackoverflow.com/a/10739989/4279). – jfs
Estoy de acuerdo; sin embargo, PyCharm no lo hace fácil de ignorar (sin mezclar su código con feos '# noinspection LongLine' (y referencias similares) por todas partes. Creo que el problema más grande es que el formato RST tiene la limitación de no poder tiene un salto de línea (que no se muestra) dentro de la URL. –