test: matplotlib backend side-effects #972
Open
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
|
@sbrugman clean start for tests. let me know if it needs anything else to be approved. |
sbrugman
reviewed
May 9, 2022
| ] | ||
| } | ||
| ], | ||
| "metadata": { |
There was a problem hiding this comment.
Please remove the metadata (not relevant for the test)
Suggestion:
pip install nbconvert
jupyter nbconvert --ClearOutputPreprocessor.enabled=True --ClearMetadataPreprocessor.enabled=True --ClearMetadataPreprocessor.preserve_cell_metadata_mask='[("tags")]' --inplace notebook_plotting.ipynb
Update: added a hook for this in #973
sbrugman
reviewed
May 9, 2022
| ], | ||
| "source": [ | ||
| "from IPython.utils import capture\n", | ||
| "from IPython.display import Image, display\n", |
There was a problem hiding this comment.
Is there a particular reason to import here and in the first cell?
sbrugman
reviewed
May 9, 2022
| "import pytest\n", | ||
| "\n", | ||
| "from pandas_profiling import ProfileReport\n", | ||
| "from pathlib import Path\n", |
There was a problem hiding this comment.
Please remove unused imports
|
Thanks @jodom961. The comments above provide some pointers to improve the PR. |
sbrugman
reviewed
May 9, 2022
| "assert len(out_matplot.outputs[0].data[\"image/png\"]) > 0 #assert an image actually exists\n" | ||
| ] | ||
| }, | ||
| { |
There was a problem hiding this comment.
Output image could be removed, correct?
portellaa
force-pushed
the
develop
branch
3 times, most recently
from
41d376f
to
5f17cfd
Compare
vascoalramos
force-pushed
the
develop
branch
5 times, most recently
from
a4724cf
to
47d3aeb
Compare
vascoalramos
force-pushed
the
develop
branch
from
45b1d80
to
a0dddb9
Compare
vascoalramos
force-pushed
the
develop
branch
from
e786ac6
to
2d55f32
Compare
vascoalramos
force-pushed
the
develop
branch
2 times, most recently
from
6ba2217
to
ef023c3
Compare
aquemy
force-pushed
the
develop
branch
2 times, most recently
from
4500563
to
cfb020d
Compare
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.
As described in the issues #888 and #837 , upon the release of 3.1.0, a side effect of importing pandas_profiling was that it overrode the existing backend of matplotlib on import, and prevented plots from being rendered in Jupyter environments.
Since it seems the backend does not needed to be set per matplots documentation,
By default, Matplotlib should automatically select a default backend which allows both interactive work and plotting from scripts, with output to the screen and/or to a file, so at least initially you will not need to worry about the backend.
Using matplot.libuse() will require changes in your code if users want to use a different backend. Therefore, you should avoid explicitly calling use unless absolutely necessary.
and it is generally a best practice to not have side effects upon importing a package, I have elected to remove that line.
A new test is in place in notebooks/notebook_plotting.ipynb to prevent this in the future.