Closes #1466: Fix error when snapshotting non-repo config, and improve config documentation#1468
Open
beamerblvd wants to merge 1 commit into
Open
Closes #1466: Fix error when snapshotting non-repo config, and improve config documentation#1468beamerblvd wants to merge 1 commit into
beamerblvd wants to merge 1 commit into
Conversation
- Most of this change is documentation improvement for the `Config` class and some of its methods. - Calling `Config.snapshot()` previously raised an attribute error if the `Config` did not come from a repository (i.e. the system or global config or a config loaded from a file). This is fixed by ensuring that `self._repo` is always set to something (`None` by default). - Passing a `PathLike` into `Config.__init__()` resulted in a value error unneccesarily. This is supported now. - Added tests that confirm this behavior.
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.
Configclass and some of its methods.Config.snapshot()previously raised anAttributeErrorif theConfigdid not come from a repository (i.e. the system or global config or a config loaded from a file). This is fixed by ensuring thatself._repois always set to something (Noneby default).PathLikeintoConfig.__init__()resulted in aTypeErrorunnecessarily. This is supported now.test_global_configandtest_system_configtests so that they emit a skip message if they can't run due to a non-existent file (also created Pytest tests cannot load global config that definitely exists even though real use of the library can #1467 about a weird problem with these tests that I can't figure out).