Improve error messages for yaml and json loading errors #2601
Conversation
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
chriselion
commented
Sep 20, 2019
| ) | ||
| except UnicodeDecodeError: | ||
| raise UnityEnvironmentException( | ||
| f"There was an error decoding Config file from {trainer_config_path}. " |
There was a problem hiding this comment.
I made these exception messages a bit more generic since they're used for both Trainer and Sampler config loading.
There was a problem hiding this comment.
In that case I'd recommend renaming the argument to just config_path
chriselion
commented
Sep 20, 2019
| @@ -117,3 +111,27 @@ def get_config(self, lesson=None): | |||
| for key in parameters: | |||
| config[key] = parameters[key][lesson] | |||
| return config | |||
|
|
|||
| @staticmethod | |||
| def load_curriculum_file(location): | |||
There was a problem hiding this comment.
I kept these in the same file, but I can move them to trainer_util.py if that's cleaner. It's currently the only place we load json.
chriselion
commented
Sep 20, 2019
| raise CurriculumLoadingError( | ||
| "The file {0} could not be found.".format(location) | ||
| ) | ||
| except UnicodeDecodeError: |
There was a problem hiding this comment.
This should probably be handled in _load_curriculum instead, but I couldn't reproduce it to confirm :/
harperj
approved these changes
Sep 23, 2019
| ) | ||
| except UnicodeDecodeError: | ||
| raise UnityEnvironmentException( | ||
| f"There was an error decoding Config file from {trainer_config_path}. " |
There was a problem hiding this comment.
In that case I'd recommend renaming the argument to just config_path
chriselion
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Since a common source of user problems and github issues is yaml/json configuration problems, I wanted to make the loading errors more explicit and point users to where they can validate their files.
I also split the loading into two parts to make testing and error checking a little clearer:
It's easier to test the second function by using an
io.StringIO(otherwise you have to mock open() and it's ugly).I also split the CurriculumError into CurriculumLoadingError (for errors loading the file) and CurriculumConfigError (for semantic errors using the loaded file).
I noticed both json and yaml loading had some exception handling around UnicodeDecodeError but I'm not sure how to reproduce this in a test (but I assume it was there for a good reason).