Read JSON instances from a stream - #631
Merged
Merged
Conversation
Each 'InstanceBuilder' gets a 'read(std::istream&)' overload reading an instance in the JSON format from a stream; 'read(instance_path)' opens the file and calls it. This allows reading an instance from a string without writing a file, e.g. in the WebAssembly module. In Python, 'InstanceBuilder.read' also accepts a text stream (e.g. 'io.StringIO') or a path-like object, like 'Solution.write'.
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
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.
Motivation
The instance readers only took a file path. To read an instance from a string, e.g. in the WebAssembly module where the instance comes from JavaScript, you had to write it to a file first.
Change
InstanceBuilder(all six types) gets aread(std::istream&)overload that reads an instance in the JSON format from a stream.read(instance_path)opens the file and calls it, so the format and behaviour are unchanged.InstanceBuilder.readaccepts a path, a path-like object (e.g.pathlib.Path) or a text stream with aread()method (e.g.io.StringIO). Same convention asSolution.write.InstanceBuilder::read, which is ambiguous now that it's overloaded. They go through two helpers inpython/src/common.hppinstead.read(instance_path)comment said "Read item types from a file".Testing
test_read_streaminpython/tests/test_instance.py, for each problem type:io.StringIOand apathlib.Pathgives the same instance;TypeError.