Make python-constraint optional #7733
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
mtreinish
added
the
Changelog: API Change
mtreinish
requested review from
a team,
manoelmarques and
woodsp-ibm
as code owners
Pull Request Test Coverage Report for Build 2392360390
💛 - Coveralls |
jakelishman
reviewed
Mar 3, 2022
There was a problem hiding this comment.
The benchmark suite in Qiskit/qiskit directly imports CSPLayout from Terra, so that's one case where we going to need to handle this issue of defining a new extra and immediately moving previously required functionality into it. For the benchmark suite in particular, we don't need to synchronise CI because it doesn't matter if the benchmark run fails, but it's more indicative of the potential issue.
jakelishman
reviewed
Mar 4, 2022
Since Qiskit#7213 we no longer have been using the CSPLayout pass by default in the preset passmanagers or transpile(). This is because it has been superseded by the VF2Layout pass which is now used everywhere. While we will keep the CSPLayout pass around for the forseeable future there is no need to install python-constraint by default anymore since it's only user is the CSPLayout pass, which isn't going to be commonly used anymore now that it's not used in the default compilation path anymore. This commit removes the python-constraint library from the requirements list and makes it an optional dependency. Fixes Qiskit#7726
This commit splits the custom solver class definition out into a separate private module that is not imported until runtime. This enables us to avoid a module level import for python-constraint meaning we only try to import if something is actually using CSPLayout.
mtreinish
force-pushed
the
constraint-optional
branch
from
1fd7f65
to
32140bf
Compare
woodsp-ibm
reviewed
May 25, 2022
Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
jakelishman
reviewed
May 26, 2022
jakelishman
approved these changes
May 26, 2022
ElePT
pushed a commit
to ElePT/qiskit-algorithms
that referenced
this pull request
Jul 27, 2023
* Make python-constraint optional Since Qiskit/qiskit#7213 we no longer have been using the CSPLayout pass by default in the preset passmanagers or transpile(). This is because it has been superseded by the VF2Layout pass which is now used everywhere. While we will keep the CSPLayout pass around for the forseeable future there is no need to install python-constraint by default anymore since it's only user is the CSPLayout pass, which isn't going to be commonly used anymore now that it's not used in the default compilation path anymore. This commit removes the python-constraint library from the requirements list and makes it an optional dependency. Fixes Qiskit/qiskit#7726 * Add docstring for HAS_CONSTRAINT * Add private module to avoid module level optional import This commit splits the custom solver class definition out into a separate private module that is not imported until runtime. This enables us to avoid a module level import for python-constraint meaning we only try to import if something is actually using CSPLayout. * Fix rebase issue * Fix lint * Fix typo in release note Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Alphabetize optionals list Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.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
Since #7213 we no longer have been using the CSPLayout pass by default
in the preset passmanagers or transpile(). This is because it has been
superseded by the VF2Layout pass which is now used everywhere. While we
will keep the CSPLayout pass around for the forseeable future there is
no need to install python-constraint by default anymore since it's only
user is the CSPLayout pass, which isn't going to be commonly used
anymore now that it's not used in the default compilation path anymore.
This commit removes the python-constraint library from the requirements
list and makes it an optional dependency.
Details and comments
Fixes #7726