Guía de estilo para código Python - PEP8

Introducción

Este documento¹ brinda las convenciones de escritura de código Python abarcando la biblioteca estándar en la distribución principal de Python.

Disposición del código

Indentación

Usa 4 espacios por cada nivel de indentación.

¿Tabulaciones o espacios?

Los espacios son el método preferido de indentación.

Python rechaza la mezcla de tabulaciones con espacios para la indentación.

Longitud máxima de línea

Limita todas las líneas a un máximo de 79 caracteres.

Debería saltar de línea antes o después de un operador?

Lo recomendado es usar el operador al principio de cada línea.

income = (gross_wages
          + taxable_interest
          + (dividends - qualified_dividends)
          - ira_deduction
          - student_loan_interest)

Líneas en blanco

Rodear las definiciones de funciones y clases con dos líneas en blanco.

Las definiciones de métodos dentro de una clase son rodeadas por una línea en blanco.

Codificación de ficheros

El código de en la distribución central de Python siempre debe usar UTF-8.

Importaciones

Las importaciones usualmente deben estar en líneas separadas

# Correcto:
import os
import sys

# Incorrecto:
import os, sys

Sin embargo, lo siguiente es correcto:

# Correcto:
from subprocess import Popen, PIPE

Nivel de módulo de nombre dunder

Loa niveles de modulo de nombre dunder tales como __all__, __author__, __version__, etc. deben colocarse después de la documentación del módulo pero antes de cualquier declaración de importación excepto de from __future__.

"""This is the example module.

This module does stuff.
"""

from __future__ import barry_as_FLUFL

__all__ = ['a', 'b', 'c']
__version__ = '0.1'
__author__ = 'Cardinal Biggles'

import os
import sys

Comillas en cadenas de caracteres

En Python, las cadenas de caracteres entre comillas simples (') o dobles (") son lo mismo. Este PEP no hace ninguna recomendación al respecto. Elija una regla y cúmplala. Sin embargo, cuando una cadena contiene comillas simples o dobles, utilice la otra para evitar barras invertidas en la cadena. Mejora la legibilidad.

Para cadenas entre comillas triples, utilice siempre comillas dobles para ser coherente con la convención de cadena de documentos en PEP 257².

En progreso…