Use tox plugin to consolidate tox environments #1354
Conversation
This change adds a tox plugin in `toxfile.py` which allows for sets of commands to be mapped to names in the test environment configuration. Additionally, a command line option is added to `tox` which allows one of these command sets to be selected by name and run in place of the default `commands` entry. With this alternative commands feature, several of the test environments that were in `tox.ini` were consolidated into three remaining environments with different sets of commands. The remaining environments are: * The main Python test environment used for tests, linting, etc. * The docs environment, needed because of a Sphinx bug that prevents a development install of `qiskit-experiments` from working on macOS. * The test environment that uses the Qiskit `main` branch instead of the released package.
|
This is a draft for now to see what other developers think. It allows combining most of our tox environments into a small set. Alternatively, we could still consider switching to nox (#1122) or hatch (which I saw in its latest release notes now supports working with projects that don't use hatchling for the build backend so it could work with qiskit-experiments' setuptools backend). I feel like the approach here does a decent job keeping the number of environments small and the syntax is not that different from hatch (I am not as familiar with nox). We could change the syntax as well. I don't feel too strongly about it. |
|
This is also marked as a draft because the contributing guide needs to be updated. I didn't want to do that before we decided if we wanted to make this change. |
|
The That is one downside of the change with this plugin -- you can't really run multiple things at once. I don't think that is common for qiskit-experiments. The tests already max out parallelization so there is not much benefit to running multiple things at once and it's not that bad to call |
This change adds a tox plugin in
toxfile.pywhich allows for sets of commands to be mapped to names in the test environment configuration. Additionally, a command line option is added totoxwhich allows one of these command sets to be selected by name and run in place of the defaultcommandsentry. With this alternative commands feature, several of the test environments that were intox.iniwere consolidated into three remaining environments with different sets of commands. The remaining environments are:qiskit-experimentsfrom working on macOS.mainbranch instead of the released package.