better error messaging when deprecated module can't be imported #4324
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
mpharrigan
approved these changes
Jul 15, 2021
| @@ -457,6 +457,7 @@ def __init__( | |||
| new_module_name: str, | |||
| old_module_name: str, | |||
| deadline: str, | |||
| broken_module_exception: Optional[BaseException], | |||
There was a problem hiding this comment.
type is optional but this argument isn't optional(?)
There was a problem hiding this comment.
I just marked it as it could be None...that doesn't mean you don't have to mandatorily state whether it's None or not...is that weird? I can make it None by default.
There was a problem hiding this comment.
I guess it's not that weird
balopat
added
automerge
CirqBot
added
the
front_of_queue_automerge
|
Automerge cancelled: A required status check is not present. Missing statuses: ['Typescript lint check', 'Typescript tests', 'Typescript tests coverage'] |
CirqBot
removed
automerge
mpharrigan
added
the
automerge
CirqBot
added
the
front_of_queue_automerge
CirqBot
removed
automerge
rht
pushed a commit
to rht/Cirq
that referenced
this pull request
May 1, 2023
…tumlib#4324) Adds better error messaging when deprecated module can't be imported. Now, `import cirq` prints zero warnings, even if there are errors importing the modules. Instead, when the deprecated modules are used, an informative error is thrown, including the root cause error: When `cirq_pasqal` can't be imported, `import cirq.pasqal` results in: ``` Traceback (most recent call last): File "/Users/balintp/dev/proj/Cirq/cirq-core/cirq/_compat.py", line 590, in deprecated_submodule new_module = importlib.import_module(new_module_name) File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/importlib/__init__.py", line 127, in import_module return _bootstrap._gcd_import(name[level:], package, level) File "<frozen importlib._bootstrap>", line 1014, in _gcd_import File "<frozen importlib._bootstrap>", line 991, in _find_and_load File "<frozen importlib._bootstrap>", line 973, in _find_and_load_unlocked ModuleNotFoundError: No module named 'cirq_pasqal' The above exception was the direct cause of the following exception: Traceback (most recent call last): File "<string>", line 1, in <module> File "<frozen importlib._bootstrap>", line 991, in _find_and_load File "<frozen importlib._bootstrap>", line 971, in _find_and_load_unlocked File "<frozen importlib._bootstrap>", line 914, in _find_spec File "/Users/balintp/dev/proj/Cirq/cirq-core/cirq/_compat.py", line 504, in find_spec raise self.broken_module_exception cirq._compat.DeprecatedModuleImportError: cirq_pasqal cannot be imported. The typical reasons are that 1.) cirq_pasqal is not installed, or 2.) when developing Cirq, you don't have your PYTHONPATH setup. In this case run `source dev_tools/pypath`. You can check the detailed exception above for more details or run `import cirq_pasqal to reproduce the issue. ``` Note that `from cirq import pasqal` will still run and return a dummy module that will throw the same error when trying to access any of its attributes. Fixes quantumlib#4106. Fixes quantumlib#4291.
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.
Adds better error messaging when deprecated module can't be imported.
Now,
import cirqprints zero warnings, even if there are errors importing the modules.Instead, when the deprecated modules are used, an informative error is thrown, including the root cause error:
When
cirq_pasqalcan't be imported,import cirq.pasqalresults in:Note that
from cirq import pasqalwill still run and return a dummy module that will throw the same error when trying to access any of its attributes.Fixes #4106.
Fixes #4291.