-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add deprecation warning on use of qiskit.IBMQ #8080
Conversation
With the pending release of the qiskit-ibm-provider that superscedes the qiskit-ibmq-provider package. The qiskit-ibmq-provider is now deprecated and will be retired/archived in the future. In coordination with that this commit deprecates the lazy loading fixture qiskit.IBMQ and removes documentation references to qiskit-ibmq-provider in the repo.
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
qiskit/__init__.py
Outdated
"which is accesible from 'qiskit_ibm_provider'. Just replace 'qiskit.IBMQ' " | ||
"with 'qiskit_ibm_provider.IBMProvider'", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This part has an additional sentence "Just replace 'qiskit.IBMQ' with 'qiskit_ibm_provider.IBMProvider'" Is this intended?
Co-authored-by: Jim Garrison <[email protected]>
Pull Request Test Coverage Report for Build 3951291056
💛 - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good to me. I did a quick search in the whole repo, and found a few places still need update the new import path. Can you please make those changes?
- https://github.com/Qiskit/qiskit-terra/blob/3241978340f534b76e4cf0e5e25ed16e2af5cf78/tools/update_fake_backends.py#L22
- https://github.com/Qiskit/qiskit-terra/blob/95a97ec53caddc885d02fd353e8d0c745328fd39/qiskit/tools/jupyter/__init__.py#L28
- https://github.com/Qiskit/qiskit-terra/blob/95a97ec53caddc885d02fd353e8d0c745328fd39/qiskit/tools/jupyter/__init__.py#L42
- https://github.com/Qiskit/qiskit-terra/blob/d3243e9e1d0e916e1d2c4af442011605204598b0/qiskit/providers/fake_provider/__init__.py#L73
I am not sure whether we should also update the path in this line in ibmq_mock.py
,
Do you need to add a test for deprecation and a release note as well?
Done in: e4ed253
I just dropped that module in: e4ed253 it was only there for legacy reasons in the docs. It's sole usage was for jupyter execute docs to be able to use
I added a release note in 7ec28f4 tests for this are a bit weird as they require the ibmq provider to be installed which we purposely don't install in tests. All we'd be testing is that a deprecation warning is emitted as we can't really test anything functional about the alias without having credentials and ibmq installed. |
Sigh, I stand corrected the ibmq provider was using it for it's jupyter-execute docs which were copied over from terra when that split out (because of course why would it be simple): https://github.com/Qiskit/qiskit-ibmq-provider/search?q=mock_get_backend let me add the function back in for now. We can just drop it when we drop |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one small comment for the release note.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
* Add deprecation warning on use of qiskit.IBMQ With the pending release of the qiskit-ibm-provider that superscedes the qiskit-ibmq-provider package. The qiskit-ibmq-provider is now deprecated and will be retired/archived in the future. In coordination with that this commit deprecates the lazy loading fixture qiskit.IBMQ and removes documentation references to qiskit-ibmq-provider in the repo. * Fix typos Co-authored-by: Jim Garrison <[email protected]> * Remove superfluous warnings * Add pip to warning message * Fix lint * Update references to qiskit.IBMQ * Add release note * Add back ibmq_mock.py file * Add link to the migration guide in release note Co-authored-by: Jim Garrison <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Add deprecation warning on use of qiskit.IBMQ With the pending release of the qiskit-ibm-provider that superscedes the qiskit-ibmq-provider package. The qiskit-ibmq-provider is now deprecated and will be retired/archived in the future. In coordination with that this commit deprecates the lazy loading fixture qiskit.IBMQ and removes documentation references to qiskit-ibmq-provider in the repo. * Fix typos Co-authored-by: Jim Garrison <[email protected]> * Remove superfluous warnings * Add pip to warning message * Fix lint * Update references to qiskit.IBMQ * Add release note * Add back ibmq_mock.py file * Add link to the migration guide in release note Co-authored-by: Jim Garrison <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Add deprecation warning on use of qiskit.IBMQ With the pending release of the qiskit-ibm-provider that superscedes the qiskit-ibmq-provider package. The qiskit-ibmq-provider is now deprecated and will be retired/archived in the future. In coordination with that this commit deprecates the lazy loading fixture qiskit.IBMQ and removes documentation references to qiskit-ibmq-provider in the repo. * Fix typos Co-authored-by: Jim Garrison <[email protected]> * Remove superfluous warnings * Add pip to warning message * Fix lint * Update references to qiskit.IBMQ * Add release note * Add back ibmq_mock.py file * Add link to the migration guide in release note Co-authored-by: Jim Garrison <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Add deprecation warning on use of qiskit.IBMQ With the pending release of the qiskit-ibm-provider that superscedes the qiskit-ibmq-provider package. The qiskit-ibmq-provider is now deprecated and will be retired/archived in the future. In coordination with that this commit deprecates the lazy loading fixture qiskit.IBMQ and removes documentation references to qiskit-ibmq-provider in the repo. * Fix typos Co-authored-by: Jim Garrison <[email protected]> * Remove superfluous warnings * Add pip to warning message * Fix lint * Update references to qiskit.IBMQ * Add release note * Add back ibmq_mock.py file * Add link to the migration guide in release note Co-authored-by: Jim Garrison <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Summary
With the pending release of the qiskit-ibm-provider that superscedes the
qiskit-ibmq-provider package. The qiskit-ibmq-provider is now deprecated
and will be retired/archived in the future. In coordination with that
this commit deprecates the lazy loading fixture qiskit.IBMQ and removes
documentation references to qiskit-ibmq-provider in the repo.
Details and comments
This is on hold until the qiskit-ibm-provider package has its first release