Print a warning when mixing $EBPYTHONPREFIXES and $PYTHONPATH modules

[Flamefire]

$PYTHONPATH takes precedence which might lead to unexpected or wrong packages being used especially when a dependency includes a newer package than another dependency.
As it is very hard to find this as the cause print a warning when this situation is found.

I ran into this while building scipy of the SciPy-bundle which includes patches that require a newer Cython as the build dependency then what is available in the Python-bundle-PyPI module. As only Python-bundle used $PYTHONPATH the package from the Cython module was ignored even though which cython points to the right binary.

The error wasn't helpful:

Error compiling Cython file:
------------------------------------------------------------
...
    cdef __Pyx_memviewslice memslice
    cdef Py_ssize_t itemsize
    cdef bint dtype_signed
    cdef char kind
    itemsize = -1
    cdef bint ___pyx_const int8_is_signed
                          ^
------------------------------------------------------------

(tree fragment):16:27: Syntax error in C variable declaration

The least we can do is to detect such issues and warn the user.

The check is triggered for direct dependencies when both $PYTHONPATH and $EBPYTHONPREFIXES are set and the Python module is loaded.
I only check for modules that have a lib/python*/site-packages folder and specifically exclude the Python module which sets $PYTHONPATH for the site-customize.py
This should catch most false positives while still catching enough real issues

[boegel]

Should we use problems instead of results here?

[Flamefire]

I wanted to be more generic because the result may not be a problem but still not what is expected or even intended

[boegel]

Looks OK to me at first glance, but I would like @Micket to pitch in here too...

[boegel]

ping @Micket

[Micket]

looks fine to me, i'll upload a test report

[Micket]

Hm, i wanted to test this in conjunction with --prefer-python-search-path, it would help me if this targeted 5.0.x instead for testing.

The base branch was changed.

[Flamefire]

Rebased and retargeted to 5.0x

[boegel]

@Flamefire I changed to target branch in this PR from 5.0.x to develop, you should synchronize your PR branch with current develop branch (which has received a massive update after the release of EasyBuild v5.0.0, see #3670)