Programar es contar una historia
Un programa no es una lista de órdenes: es una explicación del problema, escrita de forma que la máquina pueda seguirla. Si alguien lee tu código y entiende el problema sin que se lo cuentes, está bien escrito. Si necesita que se lo expliques, el código está escondiendo la historia.
Esta idea parece de estilo y no lo es: es la diferencia entre un programa que se puede corregir en dos años y uno que hay que reescribir.
En una línea
Sección titulada «En una línea»El código cuenta qué se hace con los datos; el cómo es un detalle que también se cuenta, pero después.
La historia de una viga
Sección titulada «La historia de una viga»Una viga de hormigón simplemente apoyada, con una carga repartida. El problema tiene cuatro actos:
| Acto | Pregunta | En el programa |
|---|---|---|
| 1. Datos | ¿Qué sé? | luz, carga, sección |
| 2. Cálculo | ¿Qué pasa? | momento flector |
| 3. Decisión | ¿Es aceptable? | comparar con el límite |
| 4. Informe | ¿Qué le digo a quien pregunta? | imprimir el resultado |
Esa estructura no es un adorno: es el orden en que se piensa el problema. Un programa que la respeta se puede revisar por partes; uno que la mezcla obliga a leerlo entero cada vez.
Primero, el código que no cuenta nada
Sección titulada «Primero, el código que no cuenta nada»L = 6w = 20M = w * L**2 / 8r = M / 120print(r)Funciona. Y no dice nada: ¿qué es r? ¿de dónde sale 120? ¿el resultado es bueno o malo? Para responder hay que reconstruir mentalmente el problema, que es exactamente el trabajo que el programa debía ahorrarnos.
El mismo cálculo, contando la historia
Sección titulada «El mismo cálculo, contando la historia»luz = 6.0 # metros entre apoyoscarga = 20.0 # kN por metrocapacidad = 120.0 # kN·m admisibles de la sección
momento = carga * luz ** 2 / 8aprovechamiento = momento / capacidad
print(f"Momento: {momento:.1f} kN·m")print(f"Aprovechamiento: {aprovechamiento:.0%}")Lo que va detrás de los dos puntos es el formato: :.1f escribe el número con un decimal y :.0% convierte 0,75 en 75%. La tabla completa está en el capítulo 05; por ahora basta con leer el nombre que va delante.
Es el mismo cálculo, con tres cambios que lo convierten en otra cosa:
- Los nombres dicen qué son, no qué letra les tocó.
luzfrente aL. - Las unidades están en el código, en el comentario o en el nombre. Un momento en kN·m y una carga en kN/m no se confunden.
- El resultado se presenta en la unidad del problema, no como un número suelto.
Y el print final ya es el acto 4: el programa informa, no solo calcula.
Las funciones son párrafos
Sección titulada «Las funciones son párrafos»Cuando la historia crece, se parte en párrafos. Cada función es un párrafo con un título:
def momento_maximo(carga, luz): """Momento flector máximo de una viga simplemente apoyada con carga repartida.""" return carga * luz ** 2 / 8
def aprovechamiento(momento, capacidad): """Qué fracción de la capacidad se usa. Hasta 1 es aceptable.""" return momento / capacidadAhora el programa principal se lee como el índice de la historia:
m = momento_maximo(carga=20.0, luz=6.0)uso = aprovechamiento(m, capacidad=120.0)Nadie necesita saber qué es **2 / 8 para entender qué hace el programa. Y si mañana la viga es un voladizo, se cambia una función y no todo el archivo.
La prueba de fuego
Sección titulada «La prueba de fuego»Un buen código se puede leer en voz alta. Prueba con este fragmento (no se ejecuta solo: supone que ya existe una lista vigas; aquí solo hay que leerlo):
for viga in vigas: if aprovechamiento(viga.momento, viga.capacidad) > 1: print(f"{viga.nombre}: revisar")Se lee: «para cada viga, si el aprovechamiento supera uno, dime que hay que revisarla». Si tu código no se puede leer así, el problema no es el lenguaje: es que los nombres o la estructura están contando otra historia.
La trampa
Sección titulada «La trampa»Ejercicio
Sección titulada «Ejercicio»Este programa calcula el peso de las losas de un edificio de tres plantas: 12 × 10 m en planta, 25 cm de espesor y hormigón de 24 kN/m³. Reescríbelo para que cuente la historia: nombres claros, unidades y un informe legible.
a = 12 * 10p = a * 3 * 0.25q = p * 24print(q)Solución
Una versión que cuenta la historia:
ancho = 12.0 # mlargo = 10.0 # mplantas = 3espesor_losa = 0.25 # mdensidad_hormigon = 24.0 # kN/m³
area_por_planta = ancho * largovolumen_total = area_por_planta * plantas * espesor_losapeso_losas = volumen_total * densidad_hormigon
print(f"Área por planta: {area_por_planta:.0f} m²")print(f"Volumen de hormigón: {volumen_total:.0f} m³")print(f"Peso de las losas: {peso_losas:.0f} kN")El resultado es el mismo (2 160 kN), pero ahora se puede revisar: si el peso sale mal, se comprueba una línea cada vez. En el original, un error en 0.25 o en 24 es invisible: solo se ve un número.
Y el nombre peso_losas avisa de lo que el número no incluye: pilares, vigas, cerramientos y sobrecargas. Con q no había forma de saberlo.
La moraleja del capítulo: poner nombres es la mayor parte de programar bien. El resto es el orden de los pasos.
Referencias
Sección titulada «Referencias»- Ramalho, L. Fluent Python, 2ª ed., capítulos 1 y 2.
- Lott, S. F. Modern Python Cookbook, 3ª ed., capítulo 2.
Capítulos relacionados
Sección titulada «Capítulos relacionados»- 03 · Declarativo: por qué Python permite escribir así y C no tanto.
- 07 · Funciones: el párrafo, con parámetros y valor de retorno.
- 08 · La viga completa: la historia entera, de principio a fin.