ignore-pip-unversioned-pkgs

[rmfrankch]

Summary

ignore-pip-unversioned-pkgs config option has the opposite effect to what
its name implies. Instead of ignoring packages, it adds them to the
unversioned_packages set that is checked.

EasyBuild version

EasyBuild 5.2.1

Relevant code

easybuild/easyblocks/p/python.py, lines 198-199:

if build_option('ignore_pip_unversioned_pkgs'):
    unversioned_packages.update(build_option('ignore_pip_unversioned_pkgs'))

.update() adds to the set. It should be .difference_update() to
actually exclude those packages from the check.

To reproduce

1. Have Ubuntu system packages with 0.0.0 pip stubs (e.g. brz-etckeeper,
   screen-resolution-extra, ubuntu-drivers-common, xkit) present in
   the system Python.
2. Set ignore-pip-unversioned-pkgs = brz-etckeeper,... in easybuild.cfg.
3. Build Python/3.13.5-GCCcore-14.3.0 — it fails in sanity check because
   those packages are not present in the newly built Python, even though they
   were explicitly listed to be ignored.

Expected behaviour

Packages listed in ignore-pip-unversioned-pkgs should be skipped in the
sanity check.

Suggested fix

Change line 199 from .update() to .difference_update().

[jfgrimm]

No, the behaviour is correct. It does indeed add those packages to the unversioned_packages variable, however as the docstring explains this variable is the set of packages to exclude from the check:

178 def run_pip_check(python_cmd=None, unversioned_packages=None):                                                          
179     """                                                                                                                 
180     Check installed Python packages using 'pip check'                                                                   
181                                                                                                                         
182     :param unversioned_packages: set of Python packages to exclude in the version existence check                       
183     :param python_cmd: Python command to use (if None, 'python' is used)                                                
184     """  

see also below where the check takes place:

229     for unversioned_package in sorted(unversioned_packages):                                                            
230         try:                                                                                                            
231             faulty_pkg_names.remove(unversioned_package)                                                                
232             log.debug(f"Excluding unversioned package '{unversioned_package}' from check")                              
233         except ValueError:                                                                                              
234             try:                                                                                                        
235                 version = next(pkg['version'] for pkg in pkgs if pkg['name'] == unversioned_package)                    
236             except StopIteration:                                                                                       
237                 msg = f"Package '{unversioned_package}' in unversioned_packages was not found in "                      
238                 msg += "the installed packages. Check that the name from `python -m pip list` is used "                 
239                 msg += "which may be different than the module name."                                                   
240             else:                                                                                                       
241                 msg = f"Package '{unversioned_package}' in unversioned_packages has a version of {version} "            
242                 msg += "which is valid. Please remove it from unversioned_packages."                                    
243             pip_check_errors.append(msg)              

[jfgrimm]

On one of our Ubuntu systems, we set EASYBUILD_IGNORE_PIP_UNVERSIONED_PKGS="kiwisolver,mpmath,pure-eval,ubuntu-drivers-common,xkit" and that works as expected for us