config: enforce the .profiles 'version' key — reject unsupported versions, add a migration hook

Abierto
#151 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
52/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

Start with schema.py:211 and trace how collect_config_issues surfaces validation errors in the editor Problems panel. The issue proposes rejecting unsupported versions and a migration registry, but leaves the migration behavior and scope to decide. Done means unsupported versions produce a clear reported error and the intended migration path is defined and handled.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement

Idea

version is parsed (schema.py:211, version: int = 1) and the starter template ships version: 1, but nothing enforces it: verified — AppConfigYaml.model_validate({'version': 999}) succeeds and parses as v1. No reader anywhere in src/ consults the field.

Suggested implementation

  1. Gate it now: a model_validator rejecting unsupported versions with a clear message — unsupported config version 999 (this build supports 1) — surfaced through collect_config_issues so the editor Problems panel shows it.
  2. Longer term: a small migration registry applied before validation, MIGRATIONS: dict[int, Callable[[dict], dict]], walking version → version+1 until current. This is what makes future config-format changes (and the #145 semantics decisions) shippable without breaking old files.

Fits the domain: ProFiles configs live on shared drives and outlive app versions.

Lenguaje dominante
Python
Estrellas
1
Forks
1
Merge medio
4 h 46 min
PR fusionados (30 d)
55

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de falbany/ProFiles

Todos los issues de falbany/ProFiles

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.