Improve mesage on failed Graphviz optional #11896
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
I have recently seen several users struggle to install a complete version of Graphviz upon seeing the `MissingOptionalLibraryError` message. This updates the message to make it clearer that the PyPI distribution `graphviz` *is not* the actual Graphviz software, and it must be installed separately.
jakelishman
added
documentation
|
One or more of the the following people are requested to review this:
|
|
fwiw, the new failure looks like this: In [1]: from qiskit.utils import optionals
...:
...: with optionals.HAS_GRAPHVIZ.disable_locally():
...: optionals.HAS_GRAPHVIZ.require_now("test")
...:
---------------------------------------------------------------------------
MissingOptionalLibraryError Traceback (most recent call last)
Cell In[1], line 4
1 from qiskit.utils import optionals
3 with optionals.HAS_GRAPHVIZ.disable_locally():
----> 4 optionals.HAS_GRAPHVIZ.require_now("test")
File ~/code/qiskit/terra/qiskit/utils/lazy_tester.py:221, in LazyDependencyManager.require_now(self, feature)
219 if self:
220 return
--> 221 raise MissingOptionalLibraryError(
222 libname=self._name, name=feature, pip_install=self._install, msg=self._msg
223 )
MissingOptionalLibraryError: "The 'Graphviz' library is required to use 'test'. To install, follow the instructions at https://graphviz.org/download/. Qiskit needs the Graphviz binaries, which the 'graphviz' package on pip does not install. You must install the actual Graphviz software." |
Pull Request Test Coverage Report for Build 8052272041Details
💛 - Coveralls |
Eric-Arellano
approved these changes
Feb 27, 2024
1ucian0
approved these changes
Mar 24, 2024
1ucian0
added
the
stable backport potential
|
@Mergifyio backport stable/0.46 |
✅ Backports have been created
|
mergify bot
pushed a commit
that referenced
this pull request
Mar 24, 2024
* Improve mesage on failed Graphviz optional I have recently seen several users struggle to install a complete version of Graphviz upon seeing the `MissingOptionalLibraryError` message. This updates the message to make it clearer that the PyPI distribution `graphviz` *is not* the actual Graphviz software, and it must be installed separately. * Tweak message (cherry picked from commit 17949dc)
mergify bot
pushed a commit
that referenced
this pull request
Mar 24, 2024
* Improve mesage on failed Graphviz optional I have recently seen several users struggle to install a complete version of Graphviz upon seeing the `MissingOptionalLibraryError` message. This updates the message to make it clearer that the PyPI distribution `graphviz` *is not* the actual Graphviz software, and it must be installed separately. * Tweak message (cherry picked from commit 17949dc)
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 25, 2024
* Improve mesage on failed Graphviz optional I have recently seen several users struggle to install a complete version of Graphviz upon seeing the `MissingOptionalLibraryError` message. This updates the message to make it clearer that the PyPI distribution `graphviz` *is not* the actual Graphviz software, and it must be installed separately. * Tweak message (cherry picked from commit 17949dc) Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 28, 2024
* Improve mesage on failed Graphviz optional I have recently seen several users struggle to install a complete version of Graphviz upon seeing the `MissingOptionalLibraryError` message. This updates the message to make it clearer that the PyPI distribution `graphviz` *is not* the actual Graphviz software, and it must be installed separately. * Tweak message (cherry picked from commit 17949dc) Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
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.
Summary
I have recently seen several users struggle to install a complete version of Graphviz upon seeing the
MissingOptionalLibraryErrormessage. This updates the message to make it clearer that the PyPI distributiongraphvizis not the actual Graphviz software, and it must be installed separately.Details and comments
Fix #11865, also a couple more messages I've seen on the public Qiskit slack.