🧩 Buenas prácticas desde el inicio

🎯 Objetivo
Formar hábitos de código limpio y profesional que faciliten la lectura, mantenimiento y escalabilidad del software desde las primeras líneas de código.

📘 1. PEP8: Guía oficial de estilo en Python
Qué es:
PEP8 es la guía de estilo oficial de Python. Establece reglas sobre cómo formatear el código para que sea más legible y coherente entre distintos desarrolladores.

Puntos clave:

• Usa 4 espacios por indentación:

  if True:
      print("OK")

• Longitud máxima de línea: 79 caracteres.
• Espacios alrededor de operadores:

  x = y + 2

• Nombres descriptivos:

  total_ventas = 100

• Funciones en minúsculas y guiones bajos:

  def calcular_promedio():

Herramientas útiles:

pip install flake8 black

black mi_script.py

⚙️ 2. Manejo básico de excepciones
Qué es:
Las excepciones permiten manejar errores sin interrumpir el flujo del programa.

Estructura básica:

try:
    numero = int(input("Ingresa un número: "))
    resultado = 10 / numero
except ValueError:
    print("Error: Debes ingresar un número válido.")
except ZeroDivisionError:
    print("Error: No puedes dividir entre cero.")
else:
    print("El resultado es:", resultado)
finally:
    print("Fin del programa.")

Buenas prácticas:

• Captura solo las excepciones necesarias.
• Usa mensajes descriptivos.
• Utiliza finally para liberar recursos.

🧾 3. Documentación: comentarios y docstrings

Comentarios simples (#): explican secciones o decisiones del código.

# Calcula el promedio de una lista de números
suma = sum(lista)
promedio = suma / len(lista)

Docstrings (""" """): describen funciones, clases o módulos.

def calcular_promedio(numeros: list[float]) -> float:
    """
    Calcula el promedio de una lista de números.

    Parámetros:
        numeros (list[float]): Lista de valores numéricos.

    Retorna:
        float: Promedio de los valores.
    """
    return sum(numeros) / len(numeros)

Recomendación: Usa triple comillas y formato estándar con secciones “Parámetros” y “Retorna”.

🧠 4. Uso de typing: tipado estático
Qué es:
Permite indicar el tipo de dato esperado en variables y funciones.
Facilita el autocompletado, la lectura y la detección temprana de errores.

def sumar(a: int, b: int) -> int:
    return a + b

Ejemplo completo:

from typing import List, Dict

def procesar_datos(datos: List[Dict[str, float]]) -> float:
    """
    Procesa una lista de diccionarios con datos numéricos y devuelve el promedio.

    Args:
        datos: Lista de diccionarios con clave 'valor' y número asociado.

    Returns:
        Promedio de los valores.
    """
    valores = [d["valor"] for d in datos]
    return sum(valores) / len(valores)

Herramienta recomendada:

pip install mypy

mypy mi_script.py

✅ Resultado esperado
El alumno podrá:

• Escribir código limpio siguiendo las normas PEP8.
• Manejar errores comunes sin detener el programa.
• Documentar correctamente sus funciones.
• Aplicar tipado estático para mejorar claridad y robustez.

🧩 Actividad práctica sugerida
Desarrolla un pequeño programa que:

1. Pida una lista de números al usuario.
2. Calcule el promedio y la mediana.
3. Use try/except para manejar errores de entrada.
4. Incluya docstrings, typing y cumpla PEP8.

💡 Bonus: Usa flake8 y mypy para validar tu trabajo.

Aquí verás ejemplos buenos y malos, para entender por qué importa escribir código limpio.

☁️ Cómo abrir este cuaderno en Google Colab

🔹 Opción 1 — Subir el archivo directamente

1. Descarga el archivo:
   👉 Parte_4_Buenas_Practicas_Python.ipynb
2. Ve a Google Colab.
3. En el menú, selecciona Archivo → Subir cuaderno.
4. Sube el fichero .ipynb que descargaste.

🔹 Opción 2 — Guardar una copia en tu Drive

1. Una vez abierto el cuaderno en Colab, selecciona Archivo → Guardar una copia en Drive.
2. Se abrirá tu propia copia editable en tu cuenta de Google.
3. Puedes renombrarlo o moverlo a tu carpeta de curso.

🧭 Cómo trabajar con el cuaderno

1. Ejecuta las celdas una por una usando Shift + Enter o el botón ▶️ a la izquierda de cada celda.
2. Observa los ejemplos:
   ✅ “Ejemplo BUENO” → código correcto y limpio.
   ❌ “Ejemplo MALO” → código con errores o mal estilo (algunos provocan fallos intencionalmente).
3. Lee los comentarios dentro de cada celda; explican qué hace el código y por qué es buena o mala práctica.
4. En las secciones 🧩 TAREA, completa los espacios marcados con # TODO.
5. Si un ejemplo da error, no te preocupes: está hecho para que veas cómo Python responde ante código incorrecto.
6. Puedes reiniciar todo con Entorno de ejecución → Restablecer entorno si lo necesitas.

🔧 Herramientas opcionales (solo para curiosos)

En algunas celdas encontrarás líneas comentadas como:

!pip install black flake8 mypy

Estas herramientas sirven para:

• black → formatea tu código automáticamente según PEP8.
• flake8 → analiza tu código y detecta violaciones de estilo.
• mypy → verifica los tipos definidos con typing.

Solo ejecútalas si quieres probar herramientas profesionales de análisis de código.

🎯 Objetivo final

Al terminar este cuaderno deberás ser capaz de:

• Escribir código Python con estilo PEP8.
• Manejar errores con try / except.
• Documentar funciones usando docstrings.
• Usar typing para mejorar claridad y detectar errores antes de ejecutar.

IMPORTANTE: Para que tu progreso quede registrado y puedas avanzar en el curso, recuerda hacer clic en el botón «Completar» al terminar esta lección.

• Solo al marcar la lección como completada se desbloquearán las siguientes lecciones.
• Es necesario marcar todas las lecciones de este módulo como completadas para poder pasar al Módulo 02.

Cuando termines de revisar el contenido, baja hasta el final de la página y haz clic en «Completar» antes de continuar.