Skip to content

GUIA_ESTILO.md

Latest commit

 

History

History
136 lines (97 loc) · 3.95 KB

GUIA_ESTILO.md

File metadata and controls

136 lines (97 loc) · 3.95 KB
Raw

Guía de Estilo y Buenas Prácticas

Documento de consulta transversal. Vuelve a él en cualquier momento del curso. Empieza a aplicar estas reglas desde el Módulo 02-03. No esperes al final.

PEP 8 — el estándar de estilo de Python

PEP 8 es la guía oficial de cómo escribir código Python legible. No cambia lo que hace el código, pero sí lo profesional que parece. Las empresas lo dan por sentado.

Nombres

# Variables y funciones: snake_case (minúsculas con guión bajo)
nombre_usuario = "Ruben"
def calcular_total(): ...

# Constantes: MAYÚSCULAS
PI = 3.14159
IVA = 0.21

# Clases: PascalCase (cada palabra en mayúscula)
class CuentaBancaria: ...
class GestorContactos: ...

# Nombres descriptivos, no abreviaturas crípticas
n = 5              # mal
numero_intentos = 5  # bien

Espacios e indentación

# 4 espacios por nivel de indentación (nunca tabs mezclados)
# Espacios alrededor de operadores
total = precio + iva        # bien
total=precio+iva            # mal

# Espacio después de la coma
funcion(a, b, c)            # bien
funcion(a,b,c)              # mal

# Sin espacios dentro de paréntesis
print("hola")               # bien
print( "hola" )             # mal

Líneas y espacios en blanco

  • Máximo ~79-99 caracteres por línea
  • 2 líneas en blanco entre funciones y clases
  • 1 línea en blanco para separar bloques lógicos dentro de una función

Comentarios

# Explica el PORQUÉ, no el QUÉ
contador += 1  # mal: "suma uno al contador" (ya se ve)
contador += 1  # bien: "saltamos la cabecera del CSV"

Herramientas automáticas (cuando llegues al Módulo 08+)

No tienes que recordar todas las reglas de memoria. Hay herramientas que formatean y revisan por ti:

pip install black ruff

black mi_archivo.py    # formatea automáticamente según PEP 8
ruff check mi_archivo.py  # detecta problemas de estilo y errores

black es el formateador estándar de la industria. Lo ejecutas y deja tu código perfecto. En VS Code puedes configurarlo para que se ejecute al guardar.

Git — control de versiones (esencial para tu carrera IT)

Git guarda el historial de tu código: cada cambio queda registrado y puedes volver atrás. Es la herramienta #1 que toda empresa usa. Empieza a usarlo desde tus primeros proyectos.

Comandos básicos

git init                      # inicia un repositorio en la carpeta actual
git status                    # ve qué archivos han cambiado
git add archivo.py            # prepara un archivo para guardar
git add .                     # prepara todos los cambios
git commit -m "Mensaje claro" # guarda una "foto" del estado actual
git log                       # ve el historial de commits

Flujo de trabajo típico

# 1. Trabajas en tu código...
# 2. Guardas un punto de control
git add .
git commit -m "Añade validación de email al gestor de contactos"
# 3. Repites

.gitignore — qué NO subir

Crea un archivo .gitignore para que Git ignore lo que no debe guardarse:

# .gitignore para proyectos Python
venv/
__pycache__/
*.pyc
.env
datos/secretos.json

Nunca subas a Git: entornos virtuales (venv/), contraseñas, claves de API, ni archivos generados automáticamente.

GitHub

Cuando estés listo, sube tus proyectos a GitHub. Es tu portfolio público — lo que mirarán los reclutadores. Cada proyecto del curso (calculadora, gestor de contactos, proyecto final) merece su propio repositorio.

Resumen: el checklist del código profesional

  • Nombres en snake_case, clases en PascalCase, constantes en MAYÚSCULAS
  • Nombres descriptivos, no x ni temp
  • 4 espacios de indentación, espacios alrededor de operadores
  • Funciones con docstring y type hints
  • Comentarios que explican el porqué
  • Código formateado con black
  • Proyecto versionado con Git y un .gitignore
  • Tests para la lógica importante
  • requirements.txt con las dependencias