Overloaded get methods to return fallback Option #125
Closed
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 PR adds overloaded
get
methods to bothSection
andDocument
classes with an additional parameter of typebool
calledreturnOption
. If set toTrue
(defaults toFalse
) then any fallback value returned will be a new object of typeOption
rather than simply the value of the fallback parameter. This option will have the value of theoption
parameter as its key and thefallback
ordefault
parameter as its value.Of note, this new option will not be attached to any section, which may not be the desired result. I made that choice because I don't believe that the actual config file should be updated to include any default/fallback options if the user decides to save the file later. Rather, these should be explicitly added.
Similarly, a new overloaded
get_section
method has been added to theDocument
class which has the same behaviour as described above but forSection
objects. Again, these will be created as orphan sections and not attached to the document.