Use pytest.importorskip for sphinx_gallery test #1525
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
Completes code coverage of the sphinx_gallery.py file which had the `except ImportError: figure_rst = None` lines not covered by Continuous Integration tests.
weiji14
added
maintenance
Need to have pytest.importorskip run before importing PyGMTScrapper.
seisman
added
the
final review call
michaelgrund
approved these changes
Sep 19, 2021
seisman
removed
the
final review call
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
…1525) Completes code coverage of the sphinx_gallery.py file which had the `except ImportError: figure_rst = None` lines not covered by Continuous Integration tests.
7 tasks
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.
Description of proposed changes
Scratching my recent code coverage itch 😄 This PR completes code coverage on the
sphinx_gallery.pyfile which had theexcept ImportError: figure_rst = Nonelines not covered by Continuous Integration tests. Fun fact:git blameshows that these two lines go way back to 2019 (e9929a8/#268).Specifically, it removes the try-except block in both
pygmt/sphinx_gallery.pyandpygmt/tests/test_sphinx_gallery.py, and usespytest.importorskipinstead (if someone does want to run the test but doesn't have sphinx-gallery installed). To be honest, most users probably won't be doingfrom pygmt.sphinx_gallery import PyGMTScraperanyway, so this is just a backend maintenance refactor.Fixes #
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version