feat(config): add source file tracking for config options#5387
Open
m-mcgowan wants to merge 2 commits intoplatformio:developfrom
Open
feat(config): add source file tracking for config options#5387m-mcgowan wants to merge 2 commits intoplatformio:developfrom
m-mcgowan wants to merge 2 commits intoplatformio:developfrom
Conversation
Add get_source(section, option) method to ProjectConfigBase that returns the file path where a given option was last defined. This enables tools to determine which config file (main platformio.ini or extra_configs) contributes each option -- useful for lockfile generation, debugging config resolution, and IDE tooling. Implementation: independently parses each file during read() to build a source map, matching configparser last-file-wins merge semantics.
2d2d28e to
720b8f5
Compare
Author
|
Follow-up commit adds a Example outputProject with Options inherited via |
Add get_source(section, option) method to ProjectConfigBase that returns the file path where a given option was last defined. This enables tools to determine which config file (main platformio.ini or extra_configs) contributes each option -- useful for lockfile generation, debugging config resolution, and IDE tooling. Implementation: independently parses each file during read() to build a source map, matching configparser last-file-wins merge semantics.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
get_source(section, option)method toProjectConfigBasethat returns the file path where a given config option was last definedplatformio.iniorextra_configs) contributes each optionHow it works
During
read(), each file is independently parsed to discover what sections/options it defines. A_source_mapdict tracks(section, option) -> filepath, with later files overriding earlier ones -- matching the existing configparser merge semantics.Test plan
get_source()returns extra_debug.iniNonefor nonexistent section/option pairsparse_extra=False: source tracking works without loading extra configs