Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature request]: multiple config files patching behavior enhancements #371

Open
pearsonca opened this issue Oct 29, 2024 · 0 comments
Open
Assignees
Labels
config Relating to configuration files or their framework. enhancement Request for improvement or addition of new feature(s). medium priority Medium priority. meta/workflow Relating to CI / issue templates / testing frameworks / etc. operations Refers to specific epi modeling objectives or scenario modeling goals.

Comments

@pearsonca
Copy link
Contributor

Label

config

Priority Label

low priority

Is your feature request related to a problem? Please describe.

The multi-config PR #336 provides basic capabilities to meld configuration files, enabling hot-swapping configuration elements.

However, that capability is crude, and basically only supports distinct key words OR depth zero shadowing. It's desirable to provide more nuanced patching, e.g. supporting YAML references, variable syntax, and something akin to JSON-patch syntax.

The solution, however, needs to be human write/read-able as well (so the actual JSON patch standard is probably too fiddly).

Is your feature request related to a new application, scenario round, pathogen? Please describe.

No response

Describe the solution you'd like

  • need a clear syntax for how config patching will work
  • need some example use cases of how people would like it to work
  • this might be special characters in the config files, command line options about how to patch (ala @TimothyWillard Support providing multi config files #336 (comment)), ...? possibly also some structural amendments to how we specify configs (to make patching what we care about easier)
  • need to identify a technical solution that does most of the work (not clear that's confuse; might be pyndatic, might be we have to do a bit of our own work directly atop yaml)

then: can write a test suite for that patching standard and implement an enhancement of the current approach. that should just then propagate to wherever we're using the patching solution.

@pearsonca pearsonca added enhancement Request for improvement or addition of new feature(s). config Relating to configuration files or their framework. medium priority Medium priority. operations Refers to specific epi modeling objectives or scenario modeling goals. meta/workflow Relating to CI / issue templates / testing frameworks / etc. labels Oct 29, 2024
@pearsonca pearsonca self-assigned this Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config Relating to configuration files or their framework. enhancement Request for improvement or addition of new feature(s). medium priority Medium priority. meta/workflow Relating to CI / issue templates / testing frameworks / etc. operations Refers to specific epi modeling objectives or scenario modeling goals.
Projects
None yet
Development

No branches or pull requests

1 participant