add simple validate_bookstore function & tests (not traitlets validate) #44
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
willingc
approved these changes
Jan 29, 2019
| @@ -36,3 +36,12 @@ class BookstoreSettings(LoggingConfigurable): | |||
| 16, | |||
| help="Maximum number of threads for the threadpool allocated for S3 read/writes", | |||
| ).tag(config=True) | |||
|
|
|||
|
|
|||
| def validate_bookstore(settings: BookstoreSettings): | |||
There was a problem hiding this comment.
Let's go ahead and add a simple docstring for the autodocs. Examples are in the papermill docs PR that is soon to merge. numpy format.
willingc
approved these changes
Jan 29, 2019
|
Sweet, does this mean we just pluck the bookstore settings object off the app config in nteract on jupyter then use this validation function? |
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.
@rgbkrkr asked to have a way to test for whether bookstore is properly configured over in the nteract_on_jupyter handler.
I felt like the business logic for that should live in the bookstore repo… seemed like the best way to do that would be to expose a validation function.
Since it requires that a collection of values are set appropriately, I figured it was going to be more straightforward to write a quick function rather than define custom validation functions for each one of the traitlets in question.
In the long run, we might want to go in the traitlets direction… but, for now, this seemed like a good way to delay validation and expose it to another library.