SemVer, compatibilidad y contratos públicos

← SE-109 — Biblioteca, framework, runtime, plataforma y SDK · ↑ Parte 09 · 📚 Índice completo · 🌐 Portal · SE-111 — Resolución de dependencias y lockfiles →

Punto profesional y fundamento pedagógico

Punto profesional. La clase existe para usar SemVer solo después de declarar API pública y reglas observables de compatibilidad.

Por qué aparece aquí. Se sitúa después de Biblioteca, framework, runtime, plataforma y SDK y antes de Resolución de dependencias y lockfiles: convierte el conocimiento anterior en una decisión observable que la clase siguiente podrá reutilizar. La continuidad se comprueba en el artefacto, no por compartir vocabulario.

Error conceptual que debe corregir. Inferir compatibilidad por número de versión sin contrato.

Secuencia de aprendizaje. Antes de leer la solución, el estudiante predice el resultado del caso normal y del error conceptual anterior. Luego explica un caso resuelto paso a paso, construye un contraejemplo que cambie la decisión y, sin consultar el texto, reconstruye el mecanismo y lo aplica a una entrada nueva. La secuencia usa predicción, explicación propia, contraste y recuperación. ICAP distingue participación de construcción de conocimiento; How People Learn II exige conectar conocimiento previo, contexto y transferencia; la práctica de recuperación respalda producir de nuevo la explicación tras una demora; y Education for Life and Work exige devolución que explique la causa del error.

Evidencia de aprendizaje. Compatibility.md con API, cambios, clasificación y consumidor de regresión. Debe contener predicción previa, observación, explicación causal, contraejemplo, criterio de aceptación y una nota de qué dato haría cambiar la conclusión.

Límite de la conclusión. SemVer comunica intención; no prueba que la versión sea compatible.

Trazabilidad fuente → afirmación

Antes de empezar

Esta clase continúa el producto reutilizable con SDK y CLI de la Parte 09. Recupera la evidencia de la clase anterior, añade una decisión propia de SemVer, compatibilidad y contratos públicos y deja un artefacto que la clase siguiente deberá consumir. La pregunta activa es: ¿Qué constituye la API pública y cuándo un cambio exige migración?

Prerrequisitos

• Haber completado la clase anterior o reconstruir su contrato y evidencia.
• Python 3.11 o posterior, terminal, editor y Git; un segundo runtime es opcional y debe declararse.
• Trabajar con fixtures sintéticos: ninguna observación necesita datos de una persona o sistema real.

Problema auténtico

El producto reutilizable con SDK y CLI renombra un campo interno que usuarios importaban porque aparecía en ejemplos. El equipo publica patch; consumidores rompen aunque la firma principal no cambió.

Objetivos observables

Al terminar podrás explicar los cinco mecanismos de esta clase, predecir su comportamiento antes de ejecutar, construir un caso normal y uno límite, diagnosticar el fallo controlado, comparar una alternativa y entregar evidencia que otra persona pueda reproducir.

Mapa conceptual

flowchart LR
    N1[API pública] --> N2[Compatibilidad hacia atrás] --> N3[SemVer] --> N4[Prerelease / metadata] --> N5[Deprecación / migración]
    N5 -->|fallo o cambio| N1

El mapa se lee como una cadena de razonamiento, no como fases obligatorias del runtime. La flecha de retorno indica que un fallo o cambio de requisito obliga a revisar el modelo inicial; no autoriza a parchear solo la última salida.

Temas y por qué importan

Conceptos y decisiones

1. API pública

La API incluye nombres, tipos, errores, efectos, orden, formato y comportamiento documentado que consumidores pueden depender. No se limita a funciones exportadas. CLI, archivos, variables y mensajes parseados también forman contratos si se presentan como estables.

2. Compatibilidad hacia atrás

Una versión nueva es backward compatible si consumidores válidos anteriores siguen funcionando bajo el contrato. Agregar parámetro opcional puede romper reflexión, mocks o serialización; la evaluación necesita pruebas reales, no solo intuición del autor.

3. SemVer

SemVer exige declarar API pública: major para ruptura, minor para funcionalidad compatible y patch para corrección compatible, con reglas particulares antes de 1.0. El número comunica intención; no verifica que el cambio cumpla ni reemplaza política de soporte.

4. Prerelease y metadata

Identificadores prerelease tienen precedencia menor y permiten ensayo; metadata de build no cambia precedencia. Reempaquetar el mismo número con bytes distintos viola inmutabilidad del release y destruye procedencia.

5. Deprecación y migración

Deprecar anuncia reemplazo, ventana y señal antes de remover. Warning debe ser accionable y no inundar. Una guía muestra antes/después, compatibilidad temporal y rollback; mantener alias indefinido también tiene costo que se decide explícitamente.

Definiciones de trabajo

• api pública: la api incluye nombres, tipos, errores, efectos, orden, formato y comportamiento documentado que consumidores pueden depender.
• compatibilidad hacia atrás: una versión nueva es backward compatible si consumidores válidos anteriores siguen funcionando bajo el contrato.
• semver: semver exige declarar api pública: major para ruptura, minor para funcionalidad compatible y patch para corrección compatible, con reglas particulares antes de 1.
• prerelease y metadata: identificadores prerelease tienen precedencia menor y permiten ensayo; metadata de build no cambia precedencia.
• deprecación y migración: deprecar anuncia reemplazo, ventana y señal antes de remover.

Las definiciones son operativas para el producto reutilizable con SDK y CLI. No convierten términos con historia más amplia en sinónimos y deben contrastarse con la documentación primaria enlazada al final.

Ejemplo mínimo

# 1.4.2 -> 1.4.3: corrige implementación sin romper API
# 1.4.2 -> 1.5.0: añade opción compatible
# 1.4.2 -> 2.0.0: cambia contrato incompatible
# 2.0.0-rc.1: candidato previo a 2.0.0

Antes de ejecutar, predice estado, resultado y error. Después registra versión, comando y salida. Si el fragmento es pseudocódigo o pertenece a otro lenguaje, etiquétalo como tal y no afirmes que fue ejecutado.

Ejemplo profesional

En el producto reutilizable con SDK y CLI, un release contiene contrato público, artefactos inmutables, dependencias, procedencia, ejemplos, errores y ruta de migración. La implementación de esta clase debe conservar ese contrato aunque cambie la forma interna. El caso profesional no pregunta únicamente si produce una salida: pregunta quién puede producirla, qué estado observa, cómo falla y qué rastro permite disputar una decisión incorrecta.

Compara el caso normal con autorización falsa, evidencia incompleta, empate y repetición. Un mecanismo es apropiado cuando esas diferencias quedan visibles y localizadas; es peligroso cuando dependen de orden accidental, estado oculto o una convención que el consumidor no puede conocer.

Práctica guiada

1. Copia el contrato de entrada y salida antes de escribir implementación.
2. Predice el caso normal y un límite; identifica la invariante que no puede romperse.
3. Implementa la versión mínima sin I/O dentro del núcleo.
4. Ejecuta el caso y conserva comando, versión y salida bajo evidence/.
5. Introduce el fallo controlado, reduce la reproducción y formula dos hipótesis rivales.
6. Corrige la causa, añade regresión y ejecuta el conjunto completo.
7. Compara con otro paradigma o lenguaje indicando qué semántica se preserva.

Ejercicios

1. Lectura: dibuja una traza de cinco pasos y marca dónde cambia estado o control.
2. Construcción: añade una capacidad pública y prueba el comportamiento desde un proyecto consumidor.
3. Frontera: cubre vacío, empate, no autorizado e inválido con resultados distintos.
4. Contraste: reescribe una pieza con otro modelo y explica una mejora y una pérdida.

Reto verificable

Entrega implementación, fixtures, pruebas y un informe corto. Se aprueba si otra persona ejecuta desde checkout limpio, obtiene los mismos resultados y puede relacionar cada rama o transformación con una regla del dominio. No se aprueba por cantidad de archivos ni por usar la sintaxis característica del paradigma.

Caso conductor

El producto reutilizable con SDK y CLI empaqueta el motor de la biblioteca de estructuras y algoritmos como engineering_sdk, expone choose_next, una CLI y un punto de extensión. Ejecuta instalación limpia, entrada válida, configuración ausente, plugin incompatible y actualización entre dos versiones. Cambia después una sola regla o condición y revisa qué archivos, pruebas y trazas debieron modificarse. Esa superficie de cambio alimenta el proyecto final de la parte.

Preguntas frecuentes

¿Una técnica o herramienta determina toda la arquitectura?

No. Puede organizar un núcleo o una frontera sin dominar el sistema completo. Combinar técnicas es válido si las fronteras preservan identidad, orden, errores y evidencia.

¿Más automatización o menos líneas significan una solución mejor?

No. La brevedad puede quitar duplicación o esconder decisiones. Se evalúan semántica, diagnóstico, costo de cambio y adecuación a la carga.

¿Debo instalar todas las herramientas mencionadas?

No. Instala solo lo necesario para la práctica elegida. Registra versión y comandos; si solo analizas una notación o salida, decláralo como análisis no ejecutado.

Fallo controlado y diagnóstico

Cambia el código de salida de error 2 a 1 en patch. Una prueba de CLI consumidora falla. Restaura o publica ruptura con migración según política.

Registra síntoma, entrada mínima, hipótesis, observación que descarta cada hipótesis, causa, corrección y prueba de regresión. No cambies simultáneamente implementación, fixture y expectativa.

Errores comunes y cómo corregirlos

Entorno y archivos clave

work/SE-110/
├── README.md
├── engineering_sdk/
│   ├── domain.py
│   └── se_110.py
├── fixtures/cases.json
├── tests/test_se_110.py
└── evidence/diagnosis.md

El README declara plataforma, runtimes, comandos, limpieza y límites. Evita dependencias externas cuando la biblioteca estándar permita observar el mecanismo; si agregas una, fija procedencia y versión.

Seguridad, ética y accesibilidad

• la autorización forma parte del dominio y no se infiere por ausencia de rechazo;
• no uses eval, reglas descargadas ni serialización insegura;
• limita colas, recursión, tamaño de entrada y tiempo de evaluación;
• redacta trazas y conserva una explicación textual además de color o animación;
• una recomendación automatizada debe poder revisarse, impugnarse y corregirse;
• respeta licencias de ejemplos y atribuye adaptaciones.

Transferencia

Traslada un fixture al segundo modelo, herramienta, plataforma o lenguaje. Compara representación de ausencia, error, mutabilidad, orden y cancelación. La transferencia está lograda cuando el contrato se conserva y las diferencias están explicadas, no cuando la interfaz se parece.

Evaluación y evidencia

Fuentes

• Semantic Versioning 2.0.0 — Api pública, versiones, prereleases y compatibilidad declarada; autoridad: Semantic Versioning project.
• Python Packaging User Guide: Specifications — Metadata, nombres, versiones, dependencias y artefactos de distribución; autoridad: Python Packaging Authority.
• pylock.toml Specification — Lock files para instalaciones reproducibles y selección por entorno; autoridad: Python Packaging Authority.
• Python Standard Library — Argparse, importlib.metadata, subprocess y apis de automatización; autoridad: Python Software Foundation.
• SPDX Specification 3.0 — Identificadores, sbom y procedencia legible por máquinas; autoridad: Linux Foundation.
• REUSE Specification — Declaración inequívoca y verificable de copyright y licencias por archivo; autoridad: Free Software Foundation Europe.

Cada fuente respalda el mecanismo indicado; ninguna demuestra que la implementación del producto reutilizable con SDK y CLI sea correcta. Esa afirmación depende de fixtures, pruebas, trazas y revisión reproducible.

Límites y siguiente paso

SemVer describe una versión del producto, no cómo varias restricciones seleccionan dependencias. La siguiente clase abre el resolvedor y el lockfile.

Glosario

• api pública: la api incluye nombres, tipos, errores, efectos, orden, formato y comportamiento documentado que consumidores pueden depender.
• compatibilidad hacia atrás: una versión nueva es backward compatible si consumidores válidos anteriores siguen funcionando bajo el contrato.
• semver: semver exige declarar api pública: major para ruptura, minor para funcionalidad compatible y patch para corrección compatible, con reglas particulares antes de 1.
• prerelease y metadata: identificadores prerelease tienen precedencia menor y permiten ensayo; metadata de build no cambia precedencia.
• deprecación y migración: deprecar anuncia reemplazo, ventana y señal antes de remover.

← SE-109 — Biblioteca, framework, runtime, plataforma y SDK · ↑ Parte 09 · 📚 Índice completo · 🌐 Portal · SE-111 — Resolución de dependencias y lockfiles →