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

Open
#151 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python

Research direction

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.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Python
Stars
1
Forks
1
Avg merge
4h 46m
Merged PRs (30d)
55

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from falbany/ProFiles

All issues in falbany/ProFiles

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.