Commits on Jan 5, 2023

1. Fail on mismatched python spec attributes …

   The following is intended to be a correct tox configuration:
   
     [tox]
     min_version = 4.1
     env_list = py{38,39,310,311},docs
   
     [testenv]
     base_python = python3.8
   
     [testenv:docs]
     commands =
       sphinx-build ...
   
   The goal of this is to use 'python3.8' (i.e. the value of '[testenv]
   base_python') for all environments except those with specific 'pyXX'
   factors in them. This helps eliminate issues where environments that do
   not specify a 'pyXX' factor run with different Python versions in
   different environments.
   
   An earlier bug, tox-dev#477 [1], prevented us from doing this. Due to tox-dev#477, the
   interpreter version indicated by '[testenv] base_python' (or rather
   '[testenv] basepython' - the underscore-separated variant was only
   introduced in tox 4) would override the value indicated by the 'pyXX'
   factor. This was resolved with a PR, tox-dev#841 [2], which started warning
   users if they were unintentionally running against the wrong interpreter
   and introduced the 'ignore_basepython_conflict' value to opt into the
   correct behavior.
   
   Unfortunately, this has been partially broken in the move to tox 4.
   While the above configuration still works, the following no longer does:
   
     [tox]
     min_version = 4.1
     env_list = py{38,39,310,311},docs
   
     [testenv]
     base_python = python3
   
     [testenv:docs]
     commands =
       sphinx-build ...
   
   This configuration was common back during the move from Python 2 to
   Python 3. It ensured that 'python3' was used for all testenvs that did
   not request an explicit Python version via a factor or their own
   'base_python' version. While it's no longer necessary, it is still quite
   common. Currently, running with this configuration will result in
   'python3' being used for every environment, rather than e.g. 'python3.8'
   for a testenv with the 'py38' factor. This is clearly incorrect. This
   issue stems from an errant bit of logic. When comparing interpreter
   versions as part of the '_validate_base_python', we ignore various
   attributes if they are unset on either '[testenv] base_python' or the
   'pyXX' factor. This allows e.g. 'python3' to match 'python3.8', since
   the minor version is unset for the '[testenv] base_python' value,
   'python3'. The fix is simple: while we can ignore unset attributes for
   factor-derived versions (to allow a 'py3' factor to work with e.g.
   'base_python = python3.8'), we should insist on them for
   'base_python'-derived versions.
   
   [1] tox-dev#477
   [2] tox-dev#841
   
   Signed-off-by: Stephen Finucane <stephen@that.guru>
   Closes: tox-dev#2754

   

   stephenfin committed Jan 5, 2023
   Copy the full SHA

   79c86c7 View commit details

   Browse the repository at this point in the history

2. Address nits in changelog …

   Signed-off-by: Stephen Finucane <stephen@that.guru>

   

   stephenfin committed Jan 5, 2023
   Copy the full SHA

   cf5ec84 View commit details

   Browse the repository at this point in the history