Add non-template TOML formatting #38
Merged
Conversation
This file contains 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
Some formatted strings used `NAME_fmt` and some `fmt_NAME`. Switch to the former style exclusively.
This definition was moved forward since it is also needed to name child tables. However, it was still defined at its original location as well.
In `_iter_format_key()` we called `_iter_format_value()` to format non-bare keys, but it is confusing and wasteful to call a function that can handle a bunch of types when we already know the exact type we want to format.
This prepares the code to be able to not output comments if there is no value line.
Currently the comment block before a key-value pair is never empty, but that will change.
This formats data in a non-template fashion: - only includes the docstrings as comments - optional fields without a value are skipped
This is consistent with how key-value pairs are formatted.
Mandatory tables should always be present, even in non-template output.
mthuurne
force-pushed
the
format-nontemplate
branch
from
500e09c to
3688912
Compare
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.
A configuration template is useful as a starting point for a manually crafted configuration. However, in some cases we want to automatically produce a full configuration that doesn't require manual editing. In those cases, we want just the given data to end up in the output and no examples for optional elements that could have been configured but weren't.
This PR adds a
format_toml()method, which operates similar toformat_toml_template()but leaves out optional elements unless there is data present for them.The output of
format_toml()when called on aBinderthat wraps a dataclass instance is guaranteed to be valid TOML. That guarantee doesn't hold when a dataclass itself is wrapped, because there is no data to put into mandatory fields then.