config: inheritance semantics — explicit empty lists can't clear inherited lists, cycle error messages report a wrong chain, template doc mismatches scan/match

Open
#145 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
55/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
backend

Research direction

Start with inheritance.py, validator.py, and template.py at the locations named in the issue, then read the related tests for config resolution, cycle validation, and template documentation. Check how explicit empty lists, recursive cycle paths, and scan/match selection currently behave. Done means all three reported defects are addressed, with a regression test asserting the message for a three-node cycle.

Written by the indexing model from the issue text.

Description

code-quality

Problem

Three related inheritance defects (all verified):

  1. Empty lists can't clear. A child config with extensions: [] under extends: base resolves to the base's list — _merge_str (inheritance.py:20-28) appends base items to the empty local list, and line 107 additionally merges defaults.extensions unconditionally, so a config can never have fewer extensions than defaults. Either honor an explicitly-set empty list as "clear" (distinguish model_fields_set from is None — the machinery is already there) or document the merge-only semantics per field.

  2. Wrong cycle chains in error messages. For A→B→A, validator.collect_issues reports inheritance cycle: A -> A -> B -> A and resolve_configs reports configs.B.extends: inheritance cycle: A -> A -> A; for A→B→C→A the validator says A -> A -> B -> C -> A while inheritance says A -> A -> B -> A (the config where the cycle closed is missing). Root cause in both files: the stack is seeded (name,) and the recursion appends name again — validator.py:61-85 and inheritance.py:55. Fix: seed the initial call with an empty tuple; add a regression test asserting the message for a 3-node cycle.

  3. Template doc overstates merging. template.py:323-324 claims "lists are merged: local items first, then inherited items not already present" — but scan and match are replaced, not merged (inheritance.py:75-85, pick_scan/pick_match). Fix the doc to state per-field: "extensions/filters/row_colors/excludes merge; scan/match replace".

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.