Add tweedledum to requirements-dev.txt #9477
Conversation
mtreinish
added
type: qa
|
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:
|
This commit adds a tweedledum to the requirements-dev.txt list. Since the release of qiskit-terra 0.23.0 the CI docs job has started to fail. This is because tweedledum is a requirement for the classicalfunction compiler docs. It turns out we were getting tweedledum installed in docs build jobs via a weird path. The install order for docs build was installing packages that require qiskit-terra before terra itself was being installed. This would cause qiskit-terra from pypi from being isntalled first, and old versions of terra required tweedledum which would install it. Then we'd later upgrade terra to the current version under test. To fix this in the short term this adds add tweedledum to the requirements list so we unblock CI. One thing to note is that since the primary reason we removed tweedledum from the requirements list in Qiskit#8947 was because macOS users were not able to install it reliably the new entry in the requirement-dev.txt list does not cause issues for developers on macOS systems. Longer term we should make two fixes, first we need to update the classicalfunction compiler docs so they build without having tweedledum installed. The second is we should update the CI job to avoid installing terra from pypi before we build it from source. But, given that CI is currently broken just adding it to the requirements-dev.txt list is the fastest fix.
mtreinish
force-pushed
the
fix-docs-build
branch
from
20fa1ea
to
9c64884
Compare
mtreinish
changed the title
Pull Request Test Coverage Report for Build 4028452106
💛 - Coveralls |
|
Sigh, forgot to exclude 3.11 too |
* Add tweedledum to requirements-dev.txt This commit adds a tweedledum to the requirements-dev.txt list. Since the release of qiskit-terra 0.23.0 the CI docs job has started to fail. This is because tweedledum is a requirement for the classicalfunction compiler docs. It turns out we were getting tweedledum installed in docs build jobs via a weird path. The install order for docs build was installing packages that require qiskit-terra before terra itself was being installed. This would cause qiskit-terra from pypi from being isntalled first, and old versions of terra required tweedledum which would install it. Then we'd later upgrade terra to the current version under test. To fix this in the short term this adds add tweedledum to the requirements list so we unblock CI. One thing to note is that since the primary reason we removed tweedledum from the requirements list in #8947 was because macOS users were not able to install it reliably the new entry in the requirement-dev.txt list does not cause issues for developers on macOS systems. Longer term we should make two fixes, first we need to update the classicalfunction compiler docs so they build without having tweedledum installed. The second is we should update the CI job to avoid installing terra from pypi before we build it from source. But, given that CI is currently broken just adding it to the requirements-dev.txt list is the fastest fix. * Exclude tweedledum on Python 3.11 too (cherry picked from commit a3b359b)
* Add tweedledum to requirements-dev.txt This commit adds a tweedledum to the requirements-dev.txt list. Since the release of qiskit-terra 0.23.0 the CI docs job has started to fail. This is because tweedledum is a requirement for the classicalfunction compiler docs. It turns out we were getting tweedledum installed in docs build jobs via a weird path. The install order for docs build was installing packages that require qiskit-terra before terra itself was being installed. This would cause qiskit-terra from pypi from being isntalled first, and old versions of terra required tweedledum which would install it. Then we'd later upgrade terra to the current version under test. To fix this in the short term this adds add tweedledum to the requirements list so we unblock CI. One thing to note is that since the primary reason we removed tweedledum from the requirements list in #8947 was because macOS users were not able to install it reliably the new entry in the requirement-dev.txt list does not cause issues for developers on macOS systems. Longer term we should make two fixes, first we need to update the classicalfunction compiler docs so they build without having tweedledum installed. The second is we should update the CI job to avoid installing terra from pypi before we build it from source. But, given that CI is currently broken just adding it to the requirements-dev.txt list is the fastest fix. * Exclude tweedledum on Python 3.11 too (cherry picked from commit a3b359b) Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Fixed by #9754 (review) --
It looks like the problematic dependency is qiskit-aer: https://github.com/Qiskit/qiskit-aer/blob/5e5f22cc638a288ad2a35be882f27aaed04d1a8f/setup.py#L20 But I'm confused how this was happening? I checked that in every Azure pipeline, we install from source before we install Aer, e.g. see these line numbers: Pip is showing in CI logs that Terra is already satisfied from the editable install, so it doesn't try installing from PyPI:
(PyPI currently is 0.23.2) The
How did you reach this conclusion? |
|
Eric: you're talking about the tests, which we set up and run manually, but the issue is in the docs build, which uses I don't know if tox has a way of installing dependencies after the package installation. It could well mess with its venv caching if so. |
|
I don't think tox gives a simple way to do it (but maybe there is one in tox 4.x.y now), the normal pattern I've used is something like: to build the venv but skip the commands, install the extra package, and then run everything. |
Summary
This commit adds a tweedledum to the requirements-dev.txt list. Since the release of qiskit-terra 0.23.0 the CI docs job has started to fail. This is because tweedledum is a requirement for the classicalfunction compiler docs. It turns out we were getting tweedledum installed in docs build jobs via a weird path. The install order for docs build was installing packages that require qiskit-terra before terra itself was being installed. This would cause qiskit-terra from pypi from being isntalled first, and old versions of terra required tweedledum which would install it. Then we'd later upgrade terra to the current version under test. To fix this in the short term this adds add tweedledum to the requirements list so we unblock CI. One thing to note is that since the primary reason we removed tweedledum from the requirements list in #8947 was because macOS users were not able to install it reliably the new entry in the requirement-dev.txt list does not cause issues for developers on macOS systems.
Longer term we should make two fixes, first we need to update the classicalfunction compiler docs so they build without having tweedledum installed. The second is we should update the CI job to avoid installing terra from pypi before we build it from source. But, given that CI is currently broken just adding it to the requirements-dev.txt list is the fastest fix.
Details and comments