sábado, 8 de enero de 2011

Cortar líneas de código Python para respetar PEP 8

Las PEP (Python Enhancement Proposal) son documentos técnicos que presentan procedimientos o información relacionada con el desarrollo o uso de Python hacia la comunidad.
La finalidad de éstas es mostrar nuevas implementaciones, formas de uso correcta del lenguaje, estandarización, etc.
La PEP 8, Style Guide for Python Code, entrega las convenciones para la forma en que programamos con Python, describe normas de identación, largo máximo de líneas, líneas en blanco, codificación y comentarios entre otros.
Específicamente sobre el largo de líneas, está definido en 80 caracteres, por lo que es necesario realizar cortes para que no excedan este valor. A continuación detallo las formas aceptadas:
  • Cortar líneas al encerrarlas en paréntesis (preferida)
  • Cortar líneas empleando \

Forma preferida
# -*- coding: utf-8 -*-
 
texto_viola_pep8 = 'Este es un mensaje prueba bastante largo, este mensaje por su extensión está violando la PEP 8'

texto_correcto = ('Este es un mensaje prueba bastante largo, este mensaje por' 
    ' su extensión no está violando la PEP 8')

# Se recomienda también cortar la línea luego de un operador, nunca antes
fecha = ('Buenos días estimado amigo, hoy es %s' %
    date.today().strftime('%d/%m/%Y'))

# También podemos cortar la línea al terminar un parámetro
fecha = 'Buenos días estimado amigo, hoy es %s' % date(2010,
    12, 30).strftime('%d/%m/%Y')

Forma con \
# -*- coding: utf-8 -*-
texto_correcto = 'Este es un mensaje prueba bastante largo, este mensaje por'\ 
    ' su extensión no está violando la PEP 8'

fecha = 'Buenos días estimado amigo, hoy es %s' %\
    date(2010, 12, 30).strftime('%d/%m/%Y')

No hay comentarios: