Use tomli instead of the toml package by default#185
Merged
riley-harper merged 2 commits intov4-devfrom Mar 6, 2025
Merged
Conversation
To support backwards compatibility, there is a "use_legacy_toml_parser" argument. Setting this tells load_conf_file() to use the toml library.
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
1 participant
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.
This is work for #45 and should close that when this is merged to main.
configs.load_conf_file()now uses thetomlipackage instead oftomlby default.tomlhas some bugs and isn't compliant with TOML v1.0's spec. So swapping totomli, and from there eventuallytomllibin the standard library, seems to be the way to go. We'll need to be on Python 3.11+ before we can importtomllib.For backwards compatibility,
load_conf_file()has theuse_legacy_toml_parserargument. This should help give users (and us at ISRDI!) a longer on-ramp to using the new TOML parser. It's easy to accidentally depend on some bugs in the previous parser in config files.