Show Menu
Cheatography
  1. Home >
  2. Programming >

Reglas de estilos en PEP 8 Cheat Sheet (DRAFT) by

PEP 8 es la Guía de estilo para el código en Python. Fue creada para proporcionar recomendaciones sobre la escritura de código Python de forma legible y coherente, ayudando a los programadores a seguir un conjunto de estándares comunes.

This is a draft cheat sheet. It is a work in progress and is not finished yet.

Tabula­ciones

Una altern­ativa a los espacios son las tabula­ciones, pero como su tamaño varía entre editores y puede afectar la legibi­lidad o incluso dar errores, no se recomienda su uso.
Ademas en Python 3 no está permitida la mezcla de espacios y tabula­dores
 
def es_par(num):
     if num % 2 == 0 
         return True 
     return False

Cadenas de caracteres

Python soporta diferentes dos tipos de caracteres para crear cadenas de caracteres
Comillas simples o dobles: Para cadenas de caracteres de una línea o varias.
Triples comillas dobles: Para cadenas de docume­ntación y bloques de cadenas de caract­eres.
Docstring 
"­"­"­Sección de documentación
 con triples comillas dobles­"­"­"


Cadena de texto 
print(­"­Hola, mundo!­")

Variables de módulo

Las variables de módulo definen ciertos aspectos generales:
__all__: Define qué objetos se importarán al hacer uso de import *.
__author__: Define el autor del módulo.
__vers­ion__: Define la versión del módulo actual.
 

Espacios en blanco

Los espacios en blanco en Python ayudan a mejorar la claridad del código, pero deben usarse con modera­ción.
Se debe añadir espacios entre elementos separados por comas, en ambos lados de una evaluación operativa y en asigna­ciones.

Hay que evitar espacios entre el nombre de funciones y su llamada, entre variables y el acceso interno con [], en operac­iones lógica­mente unidas y en paréntesis vacíos.

# Uso correcto de espacios
resultado = (a + b, c - d)

Import­aciones de código

Cada import­ación debe estar en una línea separada.
El orden es: librerías estándar, de terceros y luego las locales.
Se recomi­endan import­aciones absolutas.
Las import­aciones relativas deben ser explícitas y breves.
Evitar el uso de * en import­aci­ones.
 
import json
 import sys

from json import dump, load

Evitar hacer 
from pkg import *

Longitud de líneas

La longitud de las líneas es un tema debatido que admite cierta flexibilidad.

Las longitudes idoneas son 79 caracteres por línea, 72 para coment­arios, y 99 si el equipo acuerda usar líneas más largas.

El propósito es tener una mejor lectura del código sin que tenga que haber saltos de linea.
  

Posición de los operadores

Cuando se tienen muchos operadores en nuevas líneas, las líneas deben de comenzar con el operador.
 
suma_total = (a 
 	      + b )

Posición de líneas en blanco

En Python, el uso de líneas en blanco es clave para mejorar la organi­zación y legibi­lidad del código.
2 líneas en blanco: rodean funciones y defini­ciones de clases de nivel principal.

1 línea en blanco: entre la definición de métodos dentro de una clase.

1 línea adicional: entre bloques lógicos de código para mayor claridad.

1 línea en blanco al final del archivo: todo archivo con contenido debe terminar con una línea en blanco.

class MiClase:

  def metodo_1(self):


def funcion_principal():

Saltos de linea

Cuando se pretenda hacer un salto de línea se utiliza el carácter \
 
if kg > 93 and dias_h­ast­a_v­erano < 10\ 
and destino == 'Playa':()