Lazily import matplotlib #314
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
A few functions (wfdb.plot_items, wfdb.plot.plot.create_figure, wfdb.processing.Comparitor.plot) can be used to display graphical plots using matplotlib. When the matplotlib module is imported, it does a lot of non-trivial initialization, which is slow and will sometimes fail in unpredictable ways (depending on the environment and depending on whether other nominally-optional dependencies, such as Tk, are installed.) It's rather absurd for the behavior of importing wfdb to be dependent on existence or non-existence of a window system, so only import matplotlib in the few functions that actually use it.
|
Merging this as I've heard no objections. |
Merged
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.
Importing the 'matplotlib' library does all kinds of crazy stuff (such as crashing, sometimes, depending on what other packages are/aren't installed and whether or not DISPLAY is set), and makes startup significantly slower. If your program is not actually doing anything involving plotting, this unpredictability and slowness is a nuisance.
Thus, only import the library in functions that use it.