Configuración de PEP 8 y formateo automático con Ruff en Python

Adopta PEP 8 desde el primer archivo y mejora la legibilidad y calidad de tu código en Python. Aquí verás cómo estructurar main.py, documentar correctamente, aplicar snake case, usar comillas consistentes y automatizar el formateo con Ruff en Visual Studio Code. Sin rodeos: reglas claras, ejemplos prácticos y flujos de trabajo que escalan.

¿Cómo iniciar un archivo Python con PEP 8 y buena documentación?

La primera línea define el tono del proyecto. La documentación del archivo va al inicio, escrita con tres comillas, explicando el propósito general. Mantén una convención consistente en todo el proyecto.

"""
Sistema de análisis de noticias con APIs múltiples.
"""

# Constantes en MAYÚSCULAS con guion bajo.
DEFAULT_LANGUAGE = "español"

• Documentación de módulo al inicio con triple comilla.
• Constantes en mayúsculas y con guion bajo para legibilidad.
• Comillas consistentes en todo el proyecto. Preferencia por comillas dobles.

¿Qué nombres y estilos favorecen la legibilidad en Python?

• Funciones y variables en snake_case: nombres claros y descriptivos.
• Identación de cuatro espacios: nunca tabuladores.
• Líneas en blanco dobles para separar funciones no relacionadas.
• Longitud de línea: máximo 88 caracteres.

def clean_test(texto: str) -> str:
    """Limpia y formatea texto."""
    # Implementación posterior.
    pass



def validate_api_key(api_key: str) -> bool:
    """Valida una API key para conectar servicios externos."""
    # Implementación posterior.
    pass

¿Qué reglas prácticas conviene aplicar desde el día uno?

Agrupa y ordena el código para facilitar mantenimiento. Primero utilidades, luego funciones principales. Mantén nombres en inglés para el código y documentación en español si así lo decides.

¿Cómo ordenar imports según PEP 8?

• Estándar de Python primero: por ejemplo, import json.
• Terceros después: paquetes instalados.
• Locales al final: módulos del propio proyecto.
• Orden explícito y consistente. Si un import no se usa, elimínalo.

¿Qué convenciones de cadenas y espacios aplicar?

• Usa un único estilo de comillas de forma consistente. Ejemplo con dobles:

DEFAULT_LANGUAGE = "español"

• Activa la visualización de espacios en el editor con Settings → JSON → Editor Render White Space: All.

¿Cómo automatizar formato y calidad con Ruff y VS Code?

Para recordar cada detalle de PEP 8 no hace falta memorizarlo todo. Usa Ruff, del equipo de Astral, escrito en Rust, para formatear y analizar el código.

¿Cómo instalar y usar Ruff como formatter en VS Code?

• Instala la extensión Ruff desde Extensiones en Visual Studio Code.
• Clic derecho → Formatear documento: corrige comillas, espacios y más.
• Configura el guardado con formato automático en settings.json:

{
  "format_on_save": true
}

• Al guardar, se aplicará el formato consistente. Ejemplo: cambiar comillas simples a dobles automáticamente.

¿Cómo organizar imports y automatizar acciones al guardar?

• Configura acciones al guardar para organizar imports en el orden recomendado: estándar, terceros y locales.
• Los imports no usados pueden eliminarse automáticamente.

¿Qué comandos de Ruff son clave para el flujo de trabajo?

• Formatear archivos o carpetas completas:

ruff format

• Ver ayuda detallada del formatter:

ruff format help

• Además, Ruff incluye un linter que señala variables no usadas y posibles problemas antes de ejecutar el código, directamente en el editor.

¿Te animas a compartir tu regla favorita de PEP 8 y cómo la aplicas? Deja tu comentario y conversa con alguien más para mejorar entre todos.