Use jsonschema to validate messages #37
Merged
Conversation
This file contains 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
blink1073
reviewed
Nov 20, 2017
| @@ -0,0 +1,336 @@ | |||
| """Message schemas for message spec version 5""" | |||
There was a problem hiding this comment.
This is excellent! I think this and the .json file it emits should be in nbformat.
There was a problem hiding this comment.
I'd say jupyter_client would probably be the place for it - that's where the messaging protocol is defined. But I thought I'd put it here first, where there's a clear requirement for it.
rgbkrk
reviewed
Nov 20, 2017
|
|
||
| schema_fragments["input_reply"] = {"properties": { | ||
| "value": {"type": "string"}, | ||
| }} |
There was a problem hiding this comment.
This is all awesome, I'm so glad you've put all these schemas together.
|
I'm going to merge this now. It's useful to have the schemas, and we can move them into |
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.
Instead of custom validation built on traitlets. JSONSchema is a format designed to express precisely this kind of thing.
I haven't thrown all messages into one giant schema, because I think that will make unhelpful errors. In nbformat we deal with that by catching the errors and doing some extra work to produce more useful errors, but in this case I think it's more straightforward to break the schema up and use the appropriate parts for the message type.