[HTMLExporter] Initialize resources before widget filtering #2118
Conversation
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
`WidgetsDataTypeFilter` is responsible for outputting appropriate widgets code where needed. If `resources` is passed to it, it looks inside for `path` and `name` parameters to figure out where to find metadata. The default `name` is `"Notebook"`, set in [`Exporter._init_resources`](https://github.com/jupyter/nbconvert/blob/fec19fa4d538495c3c02b85708878287463412ae/nbconvert/exporters/exporter.py#L314). However, in `HTMLExporter`, `resources` is passed to `WidgetsDataTypeFilter` [here](https://github.com/jupyter/nbconvert/blob/fec19fa4d538495c3c02b85708878287463412ae/nbconvert/exporters/html.py#L260), *before* `Exporter.init_resources` is called (indirectly [here](https://github.com/jupyter/nbconvert/blob/fec19fa4d538495c3c02b85708878287463412ae/nbconvert/exporters/html.py#L266)). This works ok as long as the default behavior for setting `name` is not needed - so all commandline conversions work. But when used programmatically (like [here](https://github.com/yuvipanda/notebooksharing.space/blob/f37fda886b8e565a82b1bf3f4851ad89e2b00e47/nbss/app.py#L250), for notebooksharing.space), this causes widgets to not be rendered, as the `text/plain` mime type is chosen each time. This PR explicicly calls `_init_resources` before instantiating `WidgetsDataTypeFilter`, so the defaulting behavior of `_init_resources` is exercised.
for more information, see https://pre-commit.ci
yuvipanda
added a commit
to yuvipanda/notebooksharing.space
that referenced
this pull request
Mar 1, 2024
Temporary workaround until jupyter/nbconvert#2118 gets merged. This was a fun one to track down.
blink1073
approved these changes
Mar 1, 2024
Contributor
blink1073
left a comment
blink1073
left a comment
There was a problem hiding this comment.
Thank you! I'll cut a release with this on Monday.
Contributor
Author
|
Thanks for the quick review and merge, @blink1073 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
WidgetsDataTypeFilteris responsible for outputting appropriate widgets code where needed. Ifresourcesis passed to it, it looks inside forpathandnameparameters to figure out where to find metadata. The defaultnameis"Notebook", set inExporter._init_resources. However, inHTMLExporter,resourcesis passed toWidgetsDataTypeFilterhere, beforeExporter.init_resourcesis called (indirectly here).This works ok as long as the default behavior for setting
nameis not needed - so all commandline conversions work. But when used programmatically (like here, for notebooksharing.space), this causes widgets to not be rendered, as thetext/plainmime type is chosen each time.This PR explicicly calls
_init_resourcesbefore instantiatingWidgetsDataTypeFilter, so the defaulting behavior of_init_resourcesis exercised.