Merged
Conversation
blink1073
approved these changes
May 7, 2021
Contributor
blink1073
left a comment
There was a problem hiding this comment.
Thanks! Heads up, docstring linter picked up one thing
- deprecate Kernel._parent_header - move new multi-parent header dict to new Kernel._parent_headers instead of changing what Kernel._parent_header means
Member
Author
|
Ah, just noticed something weird - |
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.
and deprecate instead of break
Kernel._parent_header.While testing the 6.0 alpha, I noticed an issue with the OutputWidget, which references the parent header here. #585 changes
_parent_headerto be a nested dict of headers, now that two channels may have different parents, causing the output widget to fail with a KeyError on 'msg_id'.This is ~understandable because widgets are using a private API, but at the same time there isn't a public API for getting the current parent header, which the output widget needs.
I went with:
Kernel._parent_headerto mean shell, but with a deprecation_parent_headersKernel.get_parent_header(channel="shell")API with clearer stability expectationsThis way the Output widget doesn't break, and has a clearer path to using a non-private non-deprecated API, which wasn't available before.
related to #635