Show invalid config message on TraitErrors during init #921
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
implemented via @catch_config decorator Now, the event that was triggered by invalid app config (see `--log-level 5`) is triggered by bad config at any point during initialization. This *will* catch TraitError bugs in IPython itself, but only during initialization. closes ipythongh-908
prevents recursive invocation of the crash handler
base64 encoding functions were called, but had no effect, because the notebook already has everything as b64-encoded bytestrings, which are valid ascii literals on Python 2. However, the encode/decode logic is actually triggered on Python 3, revealing its errors. This fixes the base64 functions that had no effect to have their intended effect, but does not use them. Rather, it is assumed that bytes objects are already b64-encoded (and thus ascii-safe), which assumption was already made in Python 2.
| @@ -69,6 +71,26 @@ subcommand 'cmd', do: `{app} cmd -h`. | |||
| # Application class | |||
| #----------------------------------------------------------------------------- | |||
|
|
|||
| @decorator | |||
| def catch_config(method, app, *args, **kwargs): | |||
There was a problem hiding this comment.
This looks excellent, my only suggestion would be a name change: catch_config_error instead. It seems to me it will make the use of the decorator throughout the code much more self-documenting.
|
Great work, thanks @minrk. All tests pass here, so once we agree on the final name choice, this one can go in. |
|
That makes sense. |
|
renamed to catch_config_error |
|
Perfect! All looks good, tests pass, thanks for the name change. Merging now. |
fperez
added a commit
that referenced
this pull request
Oct 28, 2011
Show invalid config message on TraitErrors during initialization.
implemented via `@catch_config` decorator
Now, the event that was triggered by invalid app config (see `--log-level 5`) is triggered by bad config at any point during initialization.
This *will* catch TraitError-raising bugs in IPython itself, but only during initialization.
Also, deregister crash handler on use to avoid it being triggered recursively/repeatedly.
This was referenced Oct 29, 2011
Merged
mattvonrocketstein
pushed a commit
to mattvonrocketstein/ipython
that referenced
this pull request
Nov 3, 2014
Show invalid config message on TraitErrors during initialization.
implemented via `@catch_config` decorator
Now, the event that was triggered by invalid app config (see `--log-level 5`) is triggered by bad config at any point during initialization.
This *will* catch TraitError-raising bugs in IPython itself, but only during initialization.
Also, deregister crash handler on use to avoid it being triggered recursively/repeatedly.
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.
implemented via
@catch_configdecoratorNow, the event that was triggered by invalid app config (see
--log-level 5) is triggered by bad config at any point during initialization.This will catch TraitError-raising bugs in IPython itself, but only during initialization.
A less aggressive approach would be to look for all possible TraitError-raising points, and protect only those.
Also includes a tiny commit which unregisters crash_handler in
__call__, because it should never be called twice. The fact that it callsexit()demonstrates that if it ever does get called twice, we are in a great big mess, and we should at least avoid printing pages and pages of extra crash messages.