Add cell error instruction configurable #471
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
|
LGTM. |
|
Good idea @aschlaep. I think however, the trait should go into I'm happy to make those changes for you if you want. |
|
@aschlaep could you push the changes that you just showed me so that I can try out the PR and the issue with default values. |
|
I added the default message in execute.py because the default value of the traitlet in configuration.py wasn't getting passed through for some reason... |
maartenbreddels
requested changes
Nov 12, 2019
voila/execute.py
Outdated
Comment on lines
218
to
220
| instruction = 'Please run Voila with --debug to see the error message.' | ||
| if 'VoilaConfiguration' in self.config and 'cell_error_instruction' in self.config['VoilaConfiguration']: | ||
| instruction = self.config['VoilaConfiguration']['cell_error_instruction'] |
voila/execute.py
Outdated
| if 'VoilaConfiguration' in self.config and 'cell_error_instruction' in self.config['VoilaConfiguration']: | ||
| instruction = self.config['VoilaConfiguration']['cell_error_instruction'] | ||
|
|
||
| error_message = 'There was an error when executing cell [{}]. {}'.format(cell['execution_count'], instruction) |
There was a problem hiding this comment.
Suggested change
| error_message = 'There was an error when executing cell [{}]. {}'.format(cell['execution_count'], instruction) | |
| error_message = 'There was an error when executing cell [{}]. {}'.format(cell['execution_count'], this.cell_error_instruction) |
… debug-message-config
|
Thanks @aschlaep ! |
maartenbreddels
pushed a commit
to maartenbreddels/voila
that referenced
this pull request
Feb 5, 2020
* add cell error instruction configurable in VoilaExecutePreprocessor
maartenbreddels
pushed a commit
to maartenbreddels/voila
that referenced
this pull request
Feb 5, 2020
* add cell error instruction configurable in VoilaExecutePreprocessor
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.
This adds a VoilaConfiguration option to allow customization of the debug instruction when there's a cell error. It may not always make sense to say "Please run Voila with --debug ...", for example when voila is run as a notebook/server extension. This'll allow people to supply their own instructions to the user for how to remediate potential bugs.
If anybody has any suggestions for a better name than
cell_error_instruction, please let me know!